Overview  Package   Class  Deprecated  Index  Help 
Brooklyn
FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

brooklyn.rest.resources
[Java] Class LocationResource

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

@Path("/v1/locations")
@Apidoc("Locations")
@Produces(MediaType.APPLICATION_JSON)
public class LocationResource
extends AbstractBrooklynRestResource
Method Summary
Response create(LocationSpec locationSpec)

void delete(java.lang.String locationId)

java.util.Map get()

LocationSummary get(java.lang.String locationId)

java.util.List list()

protected LocationSummary resolveLocationDefinition(LocationDefinition l)

 
Methods inherited from class AbstractBrooklynRestResource
brooklyn, injectManagementContext, mgmt
 

Method Detail

create

@POST
@ApiOperation(value = "Create a new location", responseClass = "String")
public Response create(@ApiParam(name = "locationSpec", value = "Location specification object", required = true) @Valid LocationSpec locationSpec)

delete

@DELETE
@Path("/{locationId}")
@ApiOperation(value = "Delete a location object by id")
public void delete(@ApiParam(value = "Location id to delete", required = true) @PathParam("locationId") java.lang.String locationId)

get

@GET
@Path("/usage/LocatedLocations")
@ApiOperation(value = "Return a summary of all usage", notes="interim API, expected to change")
public java.util.Map get()

get

@GET
@Path("/{locationId}")
@ApiOperation(value = "Fetch details about a location",
      responseClass = "brooklyn.rest.domain.LocationSummary",
      multiValueResponse = true)
public LocationSummary get(@ApiParam(value = "Location id to fetch", required = true) @PathParam("locationId") java.lang.String locationId)

list

@GET
@ApiOperation(value = "Fetch the list of locations",
      responseClass = "brooklyn.rest.domain.LocationSummary",
      multiValueResponse = true)
public java.util.List list()

resolveLocationDefinition

protected LocationSummary resolveLocationDefinition(LocationDefinition l)

 

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