com.microsoft.azure.storage.blob

Class ListContainersOptions

java.lang.Object

com.microsoft.azure.storage.blob.ListContainersOptions

public final class ListContainersOptions
extends Object

Defines options available to configure the behavior of a call to listContainersSegment on a ServiceURL 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.

Field Summary

Fields

Modifier and Type	Field and Description
static ListContainersOptions	DEFAULT An object representing the default options: no details or prefix and using the service's default for maxResults.

Constructor Summary

Constructors

Constructor and Description
ListContainersOptions(ContainerListingDetails details, String prefix, Integer maxResults) A ListContainersOptions object.

Method Summary

Modifier and Type	Method and Description
ContainerListingDetails	getDetails()
Integer	getMaxResults()
String	getPrefix()

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT

public static final ListContainersOptions DEFAULT

An object representing the default options: no details or prefix and using the service's default for maxResults.

Constructor Detail

ListContainersOptions

public ListContainersOptions(ContainerListingDetails details,
                             String prefix,
                             Integer maxResults)

A ListContainersOptions object.

Parameters:

details - ContainerListingDetails

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

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

Method Detail

getDetails

public ContainerListingDetails getDetails()

Returns:

ContainerListingDetails

getPrefix

public String getPrefix()

Returns:

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

getMaxResults

public Integer getMaxResults()

Returns:

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