org.apache.brooklyn.rest.api

Interface EntityApi

All Known Implementing Classes:

EntityResource

@Path(value="/applications/{application}/entities")
 @Produces(value="application/json")
 @Consumes(value="application/json")
public interface EntityApi

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	addChildren(java.lang.String application, java.lang.String entity, java.lang.Boolean start, java.lang.String timeout, java.lang.String yaml)
javax.ws.rs.core.Response	expunge(java.lang.String applicationId, java.lang.String entityId, boolean release)
EntitySummary	get(java.lang.String application, java.lang.String entity)
java.util.List<EntitySummary>	getChildren(java.lang.String application, java.lang.String entity)
java.util.List<EntitySummary>	getDescendants(java.lang.String application, java.lang.String entity, java.lang.String typeRegex)
java.util.Map<java.lang.String,java.lang.Object>	getDescendantsSensor(java.lang.String application, java.lang.String entity, java.lang.String sensor, java.lang.String typeRegex)
javax.ws.rs.core.Response	getIcon(java.lang.String application, java.lang.String entity)
java.util.List<LocationSummary>	getLocations(java.lang.String application, java.lang.String entity)
java.lang.String	getSpec(java.lang.String application, java.lang.String entity)
TaskSummary	getTask(java.lang.String application, java.lang.String entityToken, java.lang.String taskId)
java.util.List<EntitySummary>	list(java.lang.String application)
java.util.List<java.lang.Object>	listTags(java.lang.String applicationId, java.lang.String entityId)
java.util.List<TaskSummary>	listTasks(java.lang.String applicationId, java.lang.String entityId) Deprecated. since 0.12.0 use listTasks(String, String, int, Boolean)
java.util.List<TaskSummary>	listTasks(java.lang.String applicationId, java.lang.String entityId, int limit, java.lang.Boolean recurse)
javax.ws.rs.core.Response	rename(java.lang.String applicationId, java.lang.String entityId, java.lang.String name)

Method Detail

list

@GET
java.util.List<EntitySummary> list(@PathParam(value="application")
                                        java.lang.String application)

get

@GET
 @Path(value="/{entity}")
EntitySummary get(@PathParam(value="application")
                                                 java.lang.String application,
                                                 @PathParam(value="entity")
                                                 java.lang.String entity)

getChildren

@GET
 @Path(value="/{entity}/children")
java.util.List<EntitySummary> getChildren(@PathParam(value="application")
                                                                                  java.lang.String application,
                                                                                  @PathParam(value="entity")
                                                                                  java.lang.String entity)

addChildren

@POST
 @Consumes(value={"application/x-yaml","text/yaml","text/x-yaml","application/yaml","application/json"})
 @Path(value="/{entity}/children")
javax.ws.rs.core.Response addChildren(@PathParam(value="application")
                                                                                                                                                                                        java.lang.String application,
                                                                                                                                                                                        @PathParam(value="entity")
                                                                                                                                                                                        java.lang.String entity,
                                                                                                                                                                                        @QueryParam(value="start")
                                                                                                                                                                                        java.lang.Boolean start,
                                                                                                                                                                                        @QueryParam(value="timeout")
                                                                                                                                                                                        java.lang.String timeout,
                                                                                                                                                                                        java.lang.String yaml)

listTasks

@GET
 @Path(value="/{entity}/activities")
java.util.List<TaskSummary> listTasks(@PathParam(value="application")
                                                                                java.lang.String applicationId,
                                                                                @PathParam(value="entity")
                                                                                java.lang.String entityId,
                                                                                @QueryParam(value="limit") @DefaultValue(value="200")
                                                                                int limit,
                                                                                @QueryParam(value="recurse") @DefaultValue(value="false")
                                                                                java.lang.Boolean recurse)

listTasks

@GET
 @Path(value="/{entity}/activities/deprecated")
 @Deprecated
java.util.List<TaskSummary> listTasks(@PathParam(value="application")
                                                                                                        java.lang.String applicationId,
                                                                                                        @PathParam(value="entity")
                                                                                                        java.lang.String entityId)

Deprecated. since 0.12.0 use listTasks(String, String, int, Boolean)

getTask

@GET
 @Path(value="/{entity}/activities/{task}")
 @Produces(value="text/json")
TaskSummary getTask(@PathParam(value="application")
                                                                                                   java.lang.String application,
                                                                                                   @PathParam(value="entity")
                                                                                                   java.lang.String entityToken,
                                                                                                   @PathParam(value="task")
                                                                                                   java.lang.String taskId)

getIcon

@GET
 @Path(value="/{entity}/icon")
javax.ws.rs.core.Response getIcon(@PathParam(value="application")
                                                                      java.lang.String application,
                                                                      @PathParam(value="entity")
                                                                      java.lang.String entity)

listTags

@GET
 @Path(value="/{entity}/tags")
java.util.List<java.lang.Object> listTags(@PathParam(value="application")
                                                                              java.lang.String applicationId,
                                                                              @PathParam(value="entity")
                                                                              java.lang.String entityId)

rename

@POST
 @Path(value="/{entity}/name")
javax.ws.rs.core.Response rename(@PathParam(value="application")
                                                                      java.lang.String applicationId,
                                                                      @PathParam(value="entity")
                                                                      java.lang.String entityId,
                                                                      @QueryParam(value="name")
                                                                      java.lang.String name)

expunge

@POST
 @Path(value="/{entity}/expunge")
javax.ws.rs.core.Response expunge(@PathParam(value="application")
                                                                          java.lang.String applicationId,
                                                                          @PathParam(value="entity")
                                                                          java.lang.String entityId,
                                                                          @QueryParam(value="release")
                                                                          boolean release)

getDescendants

@GET
 @Path(value="/{entity}/descendants")
java.util.List<EntitySummary> getDescendants(@PathParam(value="application")
                                                                                        java.lang.String application,
                                                                                        @PathParam(value="entity")
                                                                                        java.lang.String entity,
                                                                                        @DefaultValue(value=".*") @QueryParam(value="typeRegex")
                                                                                        java.lang.String typeRegex)

getDescendantsSensor

@GET
 @Path(value="/{entity}/descendants/sensor/{sensor}")
java.util.Map<java.lang.String,java.lang.Object> getDescendantsSensor(@PathParam(value="application")
                                                                                                                                 java.lang.String application,
                                                                                                                                 @PathParam(value="entity")
                                                                                                                                 java.lang.String entity,
                                                                                                                                 @PathParam(value="sensor")
                                                                                                                                 java.lang.String sensor,
                                                                                                                                 @DefaultValue(value=".*") @QueryParam(value="typeRegex")
                                                                                                                                 java.lang.String typeRegex)

getLocations

@GET
 @Path(value="/{entity}/locations")
java.util.List<LocationSummary> getLocations(@PathParam(value="application")
                                                                                      java.lang.String application,
                                                                                      @PathParam(value="entity")
                                                                                      java.lang.String entity)

getSpec

@GET
 @Path(value="/{entity}/spec")
 @Produces(value={"text/x-yaml","application/x-yaml","text/yaml","text/plain","application/yaml","text/plain"})
java.lang.String getSpec(@PathParam(value="application")
                                                                                                                                                                             java.lang.String application,
                                                                                                                                                                             @PathParam(value="entity")
                                                                                                                                                                             java.lang.String entity)