Method Detail

• list

  @Named(value="container:list")
  @GET
  com.google.common.collect.FluentIterable<Container> list()

  Lists up to 10,000 containers.

  NOTE

  This method returns a list of Container objects without metadata. To retrieve the Container metadata, use the get(String) method.

  Returns:

  a list of containers ordered by name.

• list

  @Named(value="container:list")
  @GET
  com.google.common.collect.FluentIterable<Container> list(ListContainerOptions options)

  Lists containers with the supplied ListContainerOptions.

  NOTE

  This method returns a list of Container objects without metadata. To retrieve the Container metadata, use the get(String) method.

  Parameters:

  options - the options to control the output list.

  Returns:

  a list of containers ordered by name.

• create

  @Named(value="container:create")
  @PUT
  @Path(value="/{containerName}")
  boolean create(@PathParam(value="containerName")
                              String containerName)

  Creates a container, if not already present.

  Parameters:

  containerName - corresponds to Container.getName().

  Returns:

  true if the container was created, false if the container already existed.

• create

  @Named(value="container:create")
  @PUT
  @Path(value="/{containerName}")
  boolean create(@PathParam(value="containerName")
                              String containerName,
                              CreateContainerOptions options)

  Creates a container, if not already present.

  Parameters:

  containerName - corresponds to Container.getName().

  options - the options to use when creating the container.

  Returns:

  true if the container was created, false if the container already existed.

• get

  @Named(value="container:get")
  @HEAD
  @Path(value="/{containerName}")
  @Nullable
  Container get(@PathParam(value="containerName")
                                       String containerName)

  Gets the Container.

  Parameters:

  containerName - corresponds to Container.getName().

  Returns:

  the Container, or null if not found.

• update

  @Named(value="container:update")
  @POST
  @Path(value="/{containerName}")
  void update(@PathParam(value="containerName")
                            String containerName,
                            UpdateContainerOptions options)

  Updates the Container.

  Parameters:

  containerName - the container name corresponding to Container.getName().

  options - the container options to update.

• updateMetadata

  @Named(value="container:updateMetadata")
  @POST
  @Path(value="/{containerName}")
  void updateMetadata(@PathParam(value="containerName")
                                    String containerName,
                                    Map<String,String> metadata)

  Creates or updates the Container metadata.

  Parameters:

  containerName - the container name corresponding to Container.getName().

  metadata - the container metadata to create or update.

• deleteMetadata

  @Named(value="container:deleteMetadata")
  @POST
  @Path(value="/{containerName}")
  boolean deleteMetadata(@PathParam(value="containerName")
                                       String containerName,
                                       Map<String,String> metadata)

  Deletes Container metadata.

  Parameters:

  containerName - corresponds to Container.getName().

  metadata - the container metadata to delete.

  Returns:

  true if the container metadata was successfully deleted, false if not.

• deleteIfEmpty

  @Named(value="container:deleteIfEmpty")
  @DELETE
  @Path(value="/{containerName}")
  boolean deleteIfEmpty(@PathParam(value="containerName")
                                        String containerName)
                        throws IllegalStateException

  Deletes a Container, if empty.

  Parameters:

  containerName - corresponds to Container.getName().

  Returns:

  true if the container was deleted or not present.

  Throws:

  IllegalStateException - if the container was not empty.