CloudBlobContainer.listBlobsSegmented Method

Definition

Overloads

listBlobsSegmented()

Returns a result segment of an enumerable collection of blob items in the container.

listBlobsSegmented(final String prefix)

Returns a result segment containing a collection of blob items whose names begin with the specified prefix.

listBlobsSegmented(final String prefix, final boolean useFlatBlobListing, final EnumSet<BlobListingDetails> listingDetails, final Integer maxResults, final ResultContinuation continuationToken, BlobRequestOptions options, OperationContext opContext)

Returns a result segment containing a collection of blob items whose names begin with the specified prefix, using the specified flat or hierarchical option, listing details options, request options, and operation context.

listBlobsSegmented()

Returns a result segment of an enumerable collection of blob items in the container.

public ResultSegment<ListBlobItem> listBlobsSegmented()
Returns

A ResultSegment object that contains a segment of the enumerable collection of ListBlobItem objects that represent the blob items in the container.

Exceptions

If a storage service error occurred.

listBlobsSegmented(final String prefix)

Returns a result segment containing a collection of blob items whose names begin with the specified prefix.

public ResultSegment<ListBlobItem> listBlobsSegmented(final String prefix)
Parameters
prefix
final String

A String that represents the prefix of the blob name.

Returns

A ResultSegment object that contains a segment of the enumerable collection of ListBlobItem objects that represent the blob items whose names begin with the specified prefix in the container.

Exceptions

If a storage service error occurred.

listBlobsSegmented(final String prefix, final boolean useFlatBlobListing, final EnumSet<BlobListingDetails> listingDetails, final Integer maxResults, final ResultContinuation continuationToken, BlobRequestOptions options, OperationContext opContext)

Returns a result segment containing a collection of blob items whose names begin with the specified prefix, using the specified flat or hierarchical option, listing details options, request options, and operation context.

public ResultSegment<ListBlobItem> listBlobsSegmented(final String prefix, final boolean useFlatBlobListing, final EnumSet<BlobListingDetails> listingDetails, final Integer maxResults, final ResultContinuation continuationToken, BlobRequestOptions options, OperationContext opContext)
Parameters
prefix
final String

A String that represents the prefix of the blob name.

useFlatBlobListing
final boolean

true to indicate that the returned list will be flat; false to indicate that the returned list will be hierarchical.

listingDetails
final EnumSet<BlobListingDetails>

A java.util.EnumSet object that contains BlobListingDetails values that indicate whether snapshots, soft-deleted blobs, metadata, and/or uncommitted blocks are returned. Committed blocks are always returned.

maxResults
final Integer

The maximum number of results to retrieve. If null or greater than 5000, the server will return up to 5,000 items. Must be at least 1.

continuationToken
final ResultContinuation

A ResultContinuation object that represents a continuation token returned by a previous listing operation.

options
BlobRequestOptions

A BlobRequestOptions object that specifies any additional options for the request. Specifying null will use the default request options from the associated service client (CloudBlobClient).

opContext
OperationContext

An OperationContext object that represents the context for the current operation. This object is used to track requests to the storage service, and to provide additional runtime information about the operation.

Returns

A ResultSegment object that contains a segment of the enumerable collection of ListBlobItem objects that represent the block items whose names begin with the specified prefix in the container.

Exceptions

If a storage service error occurred.

Applies to