org.apache.brooklyn.rest.api

Interface ActivityApi

All Known Implementing Classes:

ActivityResource

@Path(value="/activities")
 @Produces(value="application/json")
 @Consumes(value="application/json")
public interface ActivityApi

Method Summary

Modifier and Type	Method and Description
java.util.List<TaskSummary>	children(java.lang.String taskId, java.lang.Boolean includeBackground)
TaskSummary	get(java.lang.String taskId)
java.util.Map<java.lang.String,TaskSummary>	getAllChildrenAsMap(java.lang.String taskId) Deprecated. since 0.12.0 use getAllChildrenAsMap(String, int, int) with depth -1
java.util.Map<java.lang.String,TaskSummary>	getAllChildrenAsMap(java.lang.String taskId, int limit, int maxDepth)
java.lang.String	stream(java.lang.String taskId, java.lang.String streamId)

Method Detail

get

@GET
 @Path(value="/{task}")
TaskSummary get(@PathParam(value="task")
                                             java.lang.String taskId)

children

@GET
 @Path(value="/{task}/children")
java.util.List<TaskSummary> children(@PathParam(value="task")
                                                                           java.lang.String taskId,
                                                                           @QueryParam(value="includeBackground") @DefaultValue(value="false")
                                                                           java.lang.Boolean includeBackground)

getAllChildrenAsMap

@GET
 @Path(value="/{task}/children/recurse")
java.util.Map<java.lang.String,TaskSummary> getAllChildrenAsMap(@PathParam(value="task")
                                                                                                              java.lang.String taskId,
                                                                                                              @QueryParam(value="limit") @DefaultValue(value="200")
                                                                                                              int limit,
                                                                                                              @QueryParam(value="maxDepth") @DefaultValue(value="-1")
                                                                                                              int maxDepth)

getAllChildrenAsMap

@GET
 @Path(value="/{task}/children/recurse/deprecated")
 @Deprecated
java.util.Map<java.lang.String,TaskSummary> getAllChildrenAsMap(@PathParam(value="task")
                                                                                                                                      java.lang.String taskId)

Deprecated. since 0.12.0 use getAllChildrenAsMap(String, int, int) with depth -1

stream

@GET
 @Path(value="/{task}/stream/{streamId}")
 @Produces(value="text/plain")
java.lang.String stream(@PathParam(value="task")
                                                                                                      java.lang.String taskId,
                                                                                                      @PathParam(value="streamId")
                                                                                                      java.lang.String streamId)