public final class QueuesSegmentOptions extends Object
prefix
will filter queues
that begin
with the prefix.
maxResultsPerPage
will limit the number of
queues
returned in a single page.
includeMetadata
to true will include the metadata
of each queue
, if false QueueItem.getMetadata()
metadata} for each queue will be
null
.
QueueServiceClient
,
QueueServiceAsyncClient
Constructor and Description |
---|
QueuesSegmentOptions() |
Modifier and Type | Method and Description |
---|---|
Integer |
getMaxResultsPerPage() |
String |
getPrefix() |
boolean |
isIncludeMetadata() |
QueuesSegmentOptions |
setIncludeMetadata(boolean includeMetadata)
Sets the status of including queue metadata when listing queues
|
QueuesSegmentOptions |
setMaxResultsPerPage(Integer maxResultsPerPage)
Sets the maximum number of queues to include in a single response
|
QueuesSegmentOptions |
setPrefix(String prefix)
Sets the prefix that a queue must match to be included in the listing
|
public boolean isIncludeMetadata()
public QueuesSegmentOptions setIncludeMetadata(boolean includeMetadata)
includeMetadata
- Flag indicating if metadata should be included in the listingpublic String getPrefix()
public QueuesSegmentOptions setPrefix(String prefix)
prefix
- The prefix that queues must start with to pass the filterpublic Integer getMaxResultsPerPage()
public QueuesSegmentOptions setMaxResultsPerPage(Integer maxResultsPerPage)
maxResultsPerPage
- Maximum number of results to include in a single responseCopyright © 2021 Microsoft Corporation. All rights reserved.