com.microsoft.azure.storage.blob

Class ListBlobsOptions

java.lang.Object

com.microsoft.azure.storage.blob.ListBlobsOptions

public final class ListBlobsOptions
extends Object

Defines options available to configure the behavior of a call to listBlobsFlatSegment on a ContainerURL object. See the constructor for details on each of the options.

Field Summary

Fields

Modifier and Type	Field and Description
static ListBlobsOptions	DEFAULT An object representing the default options: no details, prefix, or delimiter.

Constructor Summary

Constructors

Constructor and Description
ListBlobsOptions(BlobListingDetails details, String prefix, Integer maxResults) An object filled with the specified values.

Method Summary

Modifier and Type	Method and Description
BlobListingDetails	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 ListBlobsOptions DEFAULT

An object representing the default options: no details, prefix, or delimiter. Uses the server default for maxResults.

Constructor Detail

ListBlobsOptions

public ListBlobsOptions(BlobListingDetails details,
                        String prefix,
                        Integer maxResults)

An object filled with the specified values.

Parameters:

details - BlobListingDetails

prefix - Filters the results to return only blobs whose names begin with the specified prefix. May be null to return all blobs.

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 BlobListingDetails getDetails()

Returns:

BlobListingDetails

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.