Method Detail

• create

  @Named(value="lb:create")
  @POST
  @Consumes(value="application/json")
  @Path(value="/loadbalancers")
  LoadBalancer create(CreateLoadBalancer createLB)

  Create a new load balancer with the configuration defined by the request.

  Returns:

  The object will contain a unique identifier and status of the request. Using the identifier, the caller can check on the progress of the operation by performing a get(int).

• update

  @Named(value="lb:update")
  @PUT
  @Consumes(value="application/json")
  @Path(value="/loadbalancers/{id}")
  void update(@PathParam(value="id")
                                    int id,
                                    UpdateLoadBalancer updateLB)

  Update the properties of a load balancer.

• list

  @Named(value="lb:list")
  @GET
  @Consumes(value="application/json")
  @Path(value="/loadbalancers")
  PagedIterable<LoadBalancer> list()

  List the load balancers.

• list

  @Named(value="lb:list")
  @GET
  @Consumes(value="application/json")
  @Path(value="/loadbalancers")
  IterableWithMarker<LoadBalancer> list(PaginationOptions options)

  List the load balancers with full control of pagination.

• get

  @Named(value="lb:get")
  @GET
  @Consumes(value="application/json")
  @Path(value="/loadbalancers/{id}")
  LoadBalancer get(@PathParam(value="id")
                                         int id)

  Get a load balancer.

• delete

  @Named(value="lb:delete")
  @DELETE
  @Path(value="/loadbalancers/{id}")
  @Consumes(value="*/*")
  void delete(@PathParam(value="id")
                                       int id)

  Delete a load balancer.

• createMetadata

  @Named(value="lb:createmetadata")
  @POST
  @Consumes(value="application/json")
  @Path(value="/loadbalancers/{id}/metadata")
  Metadata createMetadata(@PathParam(value="id")
                                                 int id,
                                                 Map<String,String> metadata)

  When a metadata item is added, it is assigned a unique identifier that can be used for mutating operations such as changing the value attribute or removing it. Key and value must be 256 characters or less. All UTF-8 characters are valid.

• getMetadata

  @Named(value="lb:getmetadata")
  @GET
  @Consumes(value="application/json")
  @Path(value="/loadbalancers/{id}/metadata")
  Metadata getMetadata(@PathParam(value="id")
                                             int id)

  List a load balancer's metadata.

• updateMetadatum

  @Named(value="lb:updatemetadatum")
  @PUT
  @Produces(value="application/json")
  @Consumes(value="*/*")
  @Path(value="/loadbalancers/{id}/metadata/{metadatumId}")
  boolean updateMetadatum(@PathParam(value="id")
                                                         int id,
                                                         @PathParam(value="metadatumId")
                                                         int metadatumId,
                                                         String value)

  Update metadatum. Key and value must be 256 characters or less. All UTF-8 characters are valid.

  Returns:

  true on a successful update, false if the metadatum was not found

• deleteMetadatum

  @Named(value="lb:deletemetadatum")
  @DELETE
  @Consumes(value="*/*")
  @Path(value="/loadbalancers/{id}/metadata/{metadatumId}")
  boolean deleteMetadatum(@PathParam(value="id")
                                                   int id,
                                                   @PathParam(value="metadatumId")
                                                   int metadatumId)

  Delete metadatum.

  Returns:

  true on a successful removal, false if the metadatum was not found

  See Also:

  deleteMetadata(int, Iterable)

• deleteMetadata

  @Named(value="lb:deletemetadata")
  @DELETE
  @Consumes(value="*/*")
  @Path(value="/loadbalancers/{id}/metadata")
  boolean deleteMetadata(@PathParam(value="id")
                                                  int id,
                                                  @QueryParam(value="id")
                                                  Iterable<Integer> metadataIds)

  Batch delete metadata given the specified ids. The current default limit is ten ids per request. Any and all configuration data is immediately purged and is not recoverable. If one or more of the items in the list cannot be removed due to its current status, an exception is thrown along with the ids of the ones the system identified as potential failures for this request.

  Returns:

  true on a successful removal, false if the metadata was not found