com.microsoft.azure.storage.blob

Class ListBlobsOptions

java.lang.Object

com.microsoft.azure.storage.blob.ListBlobsOptions

public final class ListBlobsOptions
extends java.lang.Object

Defines options available when calling ListBlobs.

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

Method Summary

Modifier and Type	Method and Description
java.lang.String	getDelimiter()
BlobListingDetails	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 ListBlobsOptions DEFAULT

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

Constructor Detail

ListBlobsOptions

public ListBlobsOptions(BlobListingDetails details,
                        java.lang.String prefix,
                        java.lang.String delimiter,
                        java.lang.Integer maxResults)

A ListBlobsOptions object.

Parameters:

details - A BlobListingDetails 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.

delimiter - A String. When the request includes this parameter, the operation returns a BlobPrefix element in the response body that acts as a placeholder for all blobs whose names begin with the same substring up to the appearance of the delimiter character. The delimiter may be a single character or a string.

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:

A BlobListingDetails 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.

getDelimiter

public java.lang.String getDelimiter()

Returns:

A String. When the request includes this parameter, the operation returns a BlobPrefix element in the response body that acts as a placeholder for all blobs whose names begin with the same substring up to the appearance of the delimiter character. The delimiter may be a single character or a string.

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.