QueuesSegmentOptions Class
- java.
lang. Object - com.
azure. storage. queue. models. QueuesSegmentOptions
- com.
public final class QueuesSegmentOptions
A set of options for selecting queues from Storage Queue service.
- Providing getPrefix() will filter QueueItem that begin with the prefix.
- Providing getMaxResultsPerPage() will limit the number of QueueItem returned in a single page.
- Setting isIncludeMetadata() to true will include the metadata of each QueueItem, if false getMetadata() metadata} for each queue will be
null
.
Constructor Summary
Constructor | Description | |
---|---|---|
QueuesSegmentOptions() |
Method Summary
Modifier and Type | Method and Description |
---|---|
Integer | getMaxResultsPerPage() |
String | getPrefix() |
boolean | isIncludeMetadata() |
Queues |
setIncludeMetadata(boolean includeMetadata)
Sets the status of including queue metadata when listing queues |
Queues |
setMaxResultsPerPage(Integer maxResultsPerPage)
Sets the maximum number of queues to include in a single response |
Queues |
setPrefix(String prefix)
Sets the prefix that a queue must match to be included in the listing |
Methods inherited from java.lang.Object
Constructor Details
QueuesSegmentOptions
public QueuesSegmentOptions()
Method Details
getMaxResultsPerPage
public Integer getMaxResultsPerPage()
Returns:
getPrefix
public String getPrefix()
Returns:
isIncludeMetadata
public boolean isIncludeMetadata()
Returns:
setIncludeMetadata
public QueuesSegmentOptions setIncludeMetadata(boolean includeMetadata)
Sets the status of including queue metadata when listing queues
Parameters:
Returns:
setMaxResultsPerPage
public QueuesSegmentOptions setMaxResultsPerPage(Integer maxResultsPerPage)
Sets the maximum number of queues to include in a single response
Parameters:
Returns:
setPrefix
public QueuesSegmentOptions setPrefix(String prefix)
Sets the prefix that a queue must match to be included in the listing
Parameters:
Returns:
Applies to
Azure SDK for Java
Feedback
https://aka.ms/ContentUserFeedback.
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see:Submit and view feedback for