Brooklyn

brooklyn.rest.resources
[Java] Class EntityConfigResource

java.lang.Object
  brooklyn.rest.resources.AbstractBrooklynRestResource
      brooklyn.rest.resources.EntityConfigResource

@Path("/v1/applications/{application}/entities/{entity}/config")
@Apidoc("Entity config")
@Produces("application/json")
public class EntityConfigResource
extends AbstractBrooklynRestResource

Method Summary
java.util.Map batchConfigRead(java.lang.String application, java.lang.String entityToken)

java.lang.String get(java.lang.String application, java.lang.String entityToken, java.lang.String configKeyName)

java.util.List list(java.lang.String application, java.lang.String entityToken)

 
Methods inherited from class AbstractBrooklynRestResource
brooklyn, injectManagementContext, mgmt
 

Method Detail

batchConfigRead

@GET
@Path("/current-state")
@ApiOperation(value = "Fetch config key values in batch", notes="Returns a map of config name to value")
public java.util.Map batchConfigRead(@ApiParam(value = "Application ID or name", required = true) @PathParam("application") java.lang.String application, @ApiParam(value = "Entity ID or name", required = true) @PathParam("entity") java.lang.String entityToken)


get

@GET
@Path("/{config}")
@ApiOperation(value = "Fetch config value", responseClass = "Object")
@ApiErrors(value = {
      @ApiError(code = 404, reason = "Could not find application, entity or config key")
  })
public java.lang.String get(@ApiParam(value = "Application ID or name", required = true) @PathParam("application") java.lang.String application, @ApiParam(value = "Entity ID or name", required = true) @PathParam("entity") java.lang.String entityToken, @ApiParam(value = "Config key ID", required = true) @PathParam("config") java.lang.String configKeyName)


list

@GET
@ApiOperation(value = "Fetch the config keys for a specific application entity",
      responseClass = "brooklyn.rest.domain.ConfigSummary",
      multiValueResponse = true)
@ApiErrors(value = {
      @ApiError(code = 404, reason = "Could not find application or entity")
  })
public java.util.List list(@ApiParam(value = "Application ID or name", required = true) @PathParam("application") java.lang.String application, @ApiParam(value = "Entity ID or name", required = true) @PathParam("entity") java.lang.String entityToken)


 

Brooklyn Multi-Cloud Application Management Platform
brooklyncentral.github.com. Apache License. © 2012.