Method Detail

• create

  @Named(value="queue:create")
  @PUT
  @Path(value="/{name}")
  void create(@PathParam(value="name")
                           String name)

  Create a queue.

  Parameters:

  name - Name of the queue. The name must not exceed 64 bytes in length, and it is limited to US-ASCII letters, digits, underscores, and hyphens.

• delete

  @Named(value="queue:delete")
  @DELETE
  @Path(value="/{name}")
  boolean delete(@PathParam(value="name")
                                 String name)

  Delete a queue.

  Parameters:

  name - Name of the queue. The name must not exceed 64 bytes in length, and it is limited to US-ASCII letters, digits, underscores, and hyphens.

• exists

  @Named(value="queue:get")
  @GET
  @Path(value="/{name}")
  boolean exists(@PathParam(value="name")
                              String name)

  Check for a queue's existence.

  Parameters:

  name - Name of the queue. The name must not exceed 64 bytes in length, and it is limited to US-ASCII letters, digits, underscores, and hyphens.

• list

  @Named(value="queue:list")
  @GET
  PagedIterable<Queue> list(@QueryParam(value="detailed")
                                    boolean detailed)

  Lists the queues.

  Parameters:

  detailed - Determines whether queue metadata is included in the list.

• list

  @Named(value="queue:list")
  @GET
  Queues list(ListQueuesOptions options)

  Use this method to manually page through the list of queues.

• setMetadata

  @Named(value="queue:setMetadata")
  @PUT
  @Path(value="/{name}/metadata")
  @Produces(value="application/json")
  void setMetadata(@PathParam(value="name")
                                         String name,
                                         Map<String,String> metadata)

  Sets metadata for the specified queue.

  The request body has a limit of 256 KB, excluding whitespace.

  This operation replaces any existing metadata document in its entirety. Ensure that you do not accidentally overwrite existing metadata that you want to retain.

  Parameters:

  name - Name of the queue. The name must not exceed 64 bytes in length, and it is limited to US-ASCII letters, digits, underscores, and hyphens.

  metadata - Metadata in key/value pairs.

• getMetadata

  @Named(value="queue:getMetadata")
  @GET
  @Path(value="/{name}/metadata")
  Map<String,String> getMetadata(@PathParam(value="name")
                                              String name)

  Gets metadata for the specified queue.

  Parameters:

  name - Name of the queue. The name must not exceed 64 bytes in length, and it is limited to US-ASCII letters, digits, underscores, and hyphens.

• getStats

  @Named(value="queue:getStats")
  @GET
  @Path(value="/{name}/stats")
  QueueStats getStats(@PathParam(value="name")
                                   String name)

  Gets stats for the specified queue.

  Parameters:

  name - Name of the queue. The name must not exceed 64 bytes in length, and it is limited to US-ASCII letters, digits, underscores, and hyphens.