brooklyn.rest.resources
[Java] Class EffectorResource

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

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

invoke

@POST
@Path("/{effector}")
@ApiOperation(value = "Trigger an effector",
    notes="Returns the return value (status 200) if it completes, or an activity task ID (status 202) if it times out")
@ApiErrors(value = {
      @ApiError(code = 404, reason = "Could not find application, entity or effector")
  })
public Response invoke(@ApiParam(name = "application", value = "Application ID or name", required = true) @PathParam("application") java.lang.String application, @ApiParam(name = "entity", value = "Entity ID or name", required = true) @PathParam("entity") java.lang.String entityToken, @ApiParam(name = "effector", value = "Name of the effector to trigger", required = true) @PathParam("effector") java.lang.String effectorName, @ApiParam(name = "timeout", value = "Delay before server should respond with activity task ID rather than result (in millis if no unit specified): " +
      		"'never' (blocking) is default; " +
      		"'0' means 'always' return task activity ID; " +
      		"and e.g. '1000' or '1s' will return a result if available within one second otherwise status 202 and the activity task ID", 
      		required = false, defaultValue = "never") @QueryParam("timeout") java.lang.String timeout, @ApiParam(name = "parameters", value = "Effector parameters (as key value pairs)", required = false) @Valid java.util.Map parameters)

list

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

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