QueuesSegmentOptions Class

Package:

com.azure.storage.queue.models

Maven Artifact:

com.azure:azure-storage-queue:12.24.0

• java.lang.Object
• • com.azure.storage.queue.models.QueuesSegmentOptions

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()	Creates an instance of the QueuesSegmentOptions.

Method Summary

Modifier and Type	Method and Description
Integer	getMaxResultsPerPage() Gets the maximum number of queues to include in a single response
String	getPrefix() Gets the prefix that a queue must match to be included in the listing
boolean	isIncludeMetadata() Gets the status of including queue metadata when listing queues
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

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

QueuesSegmentOptions

public QueuesSegmentOptions()

Creates an instance of the QueuesSegmentOptions.

Method Details

getMaxResultsPerPage

public Integer getMaxResultsPerPage()

Gets the maximum number of queues to include in a single response

Returns:

the maximum number of queues to include in a single response

getPrefix

public String getPrefix()

Gets the prefix that a queue must match to be included in the listing

Returns:

the prefix the queue name must match to be included in the listing

isIncludeMetadata

public boolean isIncludeMetadata()

Gets the status of including queue metadata when listing queues

Returns:

the status of including metadata when listing queues

setIncludeMetadata

public QueuesSegmentOptions setIncludeMetadata(boolean includeMetadata)

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

setMaxResultsPerPage

public QueuesSegmentOptions setMaxResultsPerPage(Integer maxResultsPerPage)

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

setPrefix

public QueuesSegmentOptions setPrefix(String prefix)

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