com.microsoft.azure.storage.blob

Class ListContainersOptions

java.lang.Object

com.microsoft.azure.storage.blob.ListContainersOptions

public final class ListContainersOptions
extends java.lang.Object

Defines options available when calling listContainers.

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, java.lang.String prefix, java.lang.Integer maxResults) A ListContainersOptions object.

Method Summary

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

Methods inherited from class java.lang.Object

equals, 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,
                             java.lang.String prefix,
                             java.lang.Integer maxResults)

A ListContainersOptions object.

Parameters:

details - A ContainerListingDetails object indicating what additional information the service should return with each blob.

prefix - A String that 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:

A ContainerListingDetails object indicating what additional information the service should return with each blob.

getPrefix

public java.lang.String getPrefix()

Returns:

A String that filters the results to return only blobs whose names begin with the specified prefix.

getMaxResults

public java.lang.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.