brooklyn.rest.api
[Java] Interface PolicyApi

@Path("/v1/applications/{application}/entities/{entity}/policies")
@Apidoc("Entity policies")
@Produces(MediaType.APPLICATION_JSON)
@Consumes(MediaType.APPLICATION_JSON)
public interface PolicyApi

addPolicy

"and setConfig(Map) method should be available if non-empty config is supplied")
@ApiErrors(value = {
      @ApiError(code = 404, reason = "Could not find application, entity or policy")
})
  public String addPolicy(
      @ApiParam(name = "application", value = "Application ID or name", required = true)
public java.lang.String addPolicy( @ApiParam(name = "entity", java.lang.String application,  @ApiParam(name = "pol java.lang.String entityToken, String policyTypeName,  java.lang.String policyTypeName, @GET java.util.Map config)

batchConfigRead

@ApiOperation(value = "Fetch policy states in batch", notes="Returns a map of policy ID to whether it is active")
public Map batchConfigRead(
@ApiParam(value = "Application ID or name", required = true)
public java.util.Map batchConfigRead(@ApiParam(value = "Entity ID or name", required = true) @PathParam("entity") Strin java.lang.String application, @POS T java.lang.String entityToken)

destroy

@ApiErrors(value = {
@ApiError(code = 404, reason = "Could not find application, entity or policy")
})
public Response destroy(
          @ApiParam(name = "application", value = "Application ID or name", required = true)
          @PathParam("application") String application,
public Response destroy(@ApiParam(name = "entity", value = "Entity ID or name", required = true) @PathParam("entity") Strin java.lang.String application, @ApiParam(name = "policy", value = "Policy ID or name", required = true) @PathParam("policy") java.lang.String entityToken, }  java.lang.String policyToken)

getStatus

@ApiErrors(value = {
@ApiError(code = 404, reason = "Could not find application, entity or policy")
})
public Status getStatus(
      @ApiParam(name = "application", value = "Application ID or name", required = true)
      @PathParam("application") String application,
public Status getStatus(@ApiParam(name = "entity", value = "Entity ID or name", required = true) @PathParam("entity") Strin java.lang.String application, @ApiParam(name = "policy", value = "Policy ID or name", required = true) @PathParam("policy") java.lang.String entityToken, @POS T java.lang.String policyId)

list

@GET
@ApiOperation(value = "Fetch the policies attached to a specific application entity",
      responseClass = "brooklyn.rest.domain.PolicySummary",
      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)

start

@ApiErrors(value = {
@ApiError(code = 404, reason = "Could not find application, entity or policy")
})
public Response start(
          @ApiParam(name = "application", value = "Application ID or name", required = true)
          @PathParam("application") String application,
public Response start(@ApiParam(name = "entity", value = "Entity ID or name", required = true) @PathParam("entity") Strin java.lang.String application, @ApiParam(name = "policy", value = "Policy ID or name", required = true) @PathParam("policy") java.lang.String entityToken, @POST  java.lang.String policyId)

stop

@ApiErrors(value = {
@ApiError(code = 404, reason = "Could not find application, entity or policy")
})
public Response stop(
          @ApiParam(name = "application", value = "Application ID or name", required = true)
          @PathParam("application") String application,
public Response stop(@ApiParam(name = "entity", value = "Entity ID or name", required = true) @PathParam("entity") Strin java.lang.String application, @ApiParam(name = "policy", value = "Policy ID or name", required = true) @PathParam("policy") java.lang.String entityToken, @POST  java.lang.String policyId)

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