Package com.azure.storage.blob.models

Class ListBlobContainersOptions

java.lang.Object

com.azure.storage.blob.models.ListBlobContainersOptions

public final class ListBlobContainersOptions
extends Object

Defines options available to configure the behavior of a call to listContainersSegment on a BlobServiceClient object. See the constructor for details on each of the options. Null may be passed in place of an object of this type if no options are desirable.

Constructor Summary

Constructors

Constructor	Description
ListBlobContainersOptions()	Constructs an unpopulated ListBlobContainersOptions.

Method Summary

Modifier and Type	Method	Description
BlobContainerListDetails	getDetails()
Integer	getMaxResultsPerPage()	Specifies the maximum number of blobs to return, including all BlobPrefix elements.
String	getPrefix()	Filters the results to return only blobs whose names begin with the specified prefix.
ListBlobContainersOptions	setDetails(BlobContainerListDetails details)
ListBlobContainersOptions	setMaxResultsPerPage(Integer maxResultsPerPage)	Specifies the maximum number of blobs to return, including all BlobPrefix elements.
ListBlobContainersOptions	setPrefix(String prefix)	Filters the results to return only blobs whose names begin with the specified prefix.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ListBlobContainersOptions

public ListBlobContainersOptions()

Constructs an unpopulated ListBlobContainersOptions.

Method Detail

getDetails

public BlobContainerListDetails getDetails()

Returns:

the details for listing specific containers

setDetails

public ListBlobContainersOptions setDetails(BlobContainerListDetails details)

Parameters:

details - The details for listing specific containers

Returns:

the updated ListBlobContainersOptions object

getPrefix

public String getPrefix()

Filters the results to return only blobs whose names begin with the specified prefix.

Returns:

the prefix a container must start with to be returned

setPrefix

public ListBlobContainersOptions setPrefix(String prefix)

Filters the results to return only blobs whose names begin with the specified prefix.

Parameters:

prefix - The prefix that a container must match to be returned

Returns:

the updated ListBlobContainersOptions object

getMaxResultsPerPage

public Integer getMaxResultsPerPage()

Specifies the maximum number of blobs to return, including all BlobPrefix elements. If the request does not specify maxResultsPerPage or specifies a value greater than 5,000, the server will return up to 5,000 items.

Returns:

the number of containers to be returned in a single response

setMaxResultsPerPage

public ListBlobContainersOptions setMaxResultsPerPage(Integer maxResultsPerPage)

Specifies the maximum number of blobs to return, including all BlobPrefix elements. If the request does not specify maxResultsPerPage or specifies a value greater than 5,000, the server will return up to 5,000 items.

Parameters:

maxResultsPerPage - The number of containers to return in a single response

Returns:

the updated ListBlobContainersOptions object

Throws:

IllegalArgumentException - If maxResultsPerPage is less than or equal to 0.