brooklyn.rest.api
[Java] Interface SensorApi

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

batchSensorRead

@GET
@Path("/current-state")
@ApiOperation(value = "Fetch sensor values in batch", notes="Returns a map of sensor name to value")
public java.util.Map batchSensorRead(@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("/{sensor}")
@ApiOperation(value = "Fetch sensor value", responseClass = "String")
@ApiErrors(value = {
      @ApiError(code = 404, reason = "Could not find application, entity or sensor")
  })
@Produces("text/plain")
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 = "Sensor name", required = true) @PathParam("sensor") java.lang.String sensorName)

list

@GET
@ApiOperation(value = "Fetch the sensor list for a specific application entity",
      responseClass = "brooklyn.rest.domain.SensorSummary",
      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.