Package com.azure.storage.queue.models
Class QueuesSegmentOptions
java.lang.Object
com.azure.storage.queue.models.QueuesSegmentOptions
A set of options for selecting queues from Storage Queue service.
-
Providing
prefix
will filterqueues
that begin with the prefix. -
Providing
maxResultsPerPage
will limit the number ofqueues
returned in a single page. -
Setting
includeMetadata
to true will include the metadata of eachqueue
, if falseQueueItem.getMetadata()
metadata} for each queue will benull
.
- See Also:
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionboolean
setIncludeMetadata
(boolean includeMetadata) Sets the status of including queue metadata when listing queuessetMaxResultsPerPage
(Integer maxResultsPerPage) Sets the maximum number of queues to include in a single responseSets the prefix that a queue must match to be included in the listing
-
Constructor Details
-
QueuesSegmentOptions
public QueuesSegmentOptions()
-
-
Method Details
-
isIncludeMetadata
public boolean isIncludeMetadata()- Returns:
- the status of including metadata when listing queues
-
setIncludeMetadata
Sets the status of including queue metadata when listing queues- Parameters:
includeMetadata
- Flag indicating if metadata should be included in the listing- Returns:
- An updated QueuesSegmentOptions object
-
getPrefix
- Returns:
- the prefix the queue name must match to be included in the listing
-
setPrefix
Sets the prefix that a queue must match to be included in the listing- Parameters:
prefix
- The prefix that queues must start with to pass the filter- Returns:
- An updated QueuesSegmentOptions object
-
getMaxResultsPerPage
- Returns:
- the maximum number of queues to include in a single response
-
setMaxResultsPerPage
Sets the maximum number of queues to include in a single response- Parameters:
maxResultsPerPage
- Maximum number of results to include in a single response- Returns:
- An updated QueuesSegmentOptions object
-