Overview  Package   Class  Deprecated  Index  Help 
Brooklyn
FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

brooklyn.rest.resources
[Java] Class PolicyConfigResource

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

@Path("/v1/applications/{application}/entities/{entity}/policies/{policy}/config")
@Apidoc("Policy config")
@Produces("application/json")
public class PolicyConfigResource
extends AbstractBrooklynRestResource
Method Summary
java.util.Map batchConfigRead(java.lang.String application, java.lang.String entityToken, java.lang.String policyToken)

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

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

Response set(java.lang.String application, java.lang.String entityToken, java.lang.String policyToken, java.lang.String configKeyName, java.lang.String value)

 
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, @ApiParam(value = "Policy ID or name", required = true) @PathParam("policy") java.lang.String policyToken)

get

@GET
@Path("/{config}")
@ApiOperation(value = "Fetch config value", responseClass = "Object")
@ApiErrors(value = {
      @ApiError(code = 404, reason = "Could not find application, entity, policy 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 = "Policy ID or name", required = true) @PathParam("policy") java.lang.String policyToken, @ApiParam(value = "Config key ID", required = true) @PathParam("config") java.lang.String configKeyName)

list

@GET
@ApiOperation(value = "Fetch the config keys for a specific policy",
      responseClass = "brooklyn.rest.domain.ConfigSummary",
      multiValueResponse = true)
@ApiErrors(value = {
      @ApiError(code = 404, reason = "Could not find application or entity or policy")
  })
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, @ApiParam(value = "Policy ID or name", required = true) @PathParam("policy") java.lang.String policyToken)

set

@SuppressWarnings({ "unchecked", "rawtypes" })
@POST
@Path("/{config}/set")
@ApiOperation(value = "Sets the given config on this policy")
@ApiErrors(value = {
      @ApiError(code = 404, reason = "Could not find application, entity, policy or config key")
  })
public Response set(@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 = "Policy ID or name", required = true) @PathParam("policy") java.lang.String policyToken, @ApiParam(value = "Config key ID", required = true) @PathParam("config") java.lang.String configKeyName, @ApiParam(name = "value", value = "New value for the configuration", required = true) @QueryParam("value") java.lang.String value)

 

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