Package com.azure.storage.queue.models

Class QueuesSegmentOptions

java.lang.Object

com.azure.storage.queue.models.QueuesSegmentOptions

public final class QueuesSegmentOptions
extends Object

A set of options for selecting queues from Storage Queue service.

• Providing prefix will filter queues that begin with the prefix.
• Providing maxResultsPerPage will limit the number of queues returned in a single page.
• Setting includeMetadata to true will include the metadata of each queue, if false QueueItem.getMetadata() metadata} for each queue will be null.

See Also:

• QueueServiceClient
• QueueServiceAsyncClient

Constructor Summary

Constructors

Constructor	Description
QueuesSegmentOptions()	Creates an instance of the QueuesSegmentOptions.

Method Summary

Modifier and Type	Method	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 class 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

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

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

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

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

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