public interface QueueApi
Modifier and Type | Method and Description |
---|---|
boolean |
create(String name)
Create a queue.
|
boolean |
delete(String name)
Delete a queue.
|
boolean |
exists(String name)
Check for a queue's existence.
|
Map<String,String> |
getMetadata(String name)
Gets metadata for the specified queue.
|
QueueStats |
getStats(String name)
Gets stats for the specified queue.
|
PagedIterable<Queue> |
list(boolean detailed)
Lists the queues.
|
Queues |
list(ListQueuesOptions options)
Use this method to manually page through the list of queues.
|
boolean |
setMetadata(String name,
Map<String,String> metadata)
Sets metadata for the specified queue.
|
@Named(value="queue:create") boolean create(String name)
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.@Named(value="queue:delete") boolean delete(String name)
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.@Named(value="queue:get") boolean exists(String name)
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.@Named(value="queue:list") PagedIterable<Queue> list(boolean detailed)
detailed
- Determines whether queue metadata is included in the list.@Named(value="queue:list") Queues list(ListQueuesOptions options)
@Named(value="queue:setMetadata") boolean setMetadata(String name, Map<String,String> metadata)
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.@Named(value="queue:getMetadata") Map<String,String> getMetadata(String name)
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.@Named(value="queue:getStats") QueueStats getStats(String name)
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.Copyright © 2009-2016 The Apache Software Foundation. All Rights Reserved.