CloudBlobContainer.listBlobs Method

Definition

Overloads

listBlobs()

Returns an enumerable collection of blob items for the container.

listBlobs(final String prefix)

Returns an enumerable collection of blob items for the container whose names begin with the specified prefix.

listBlobs(final String prefix, final boolean useFlatBlobListing)

Returns an enumerable collection of blob items for the container whose names begin with the specified prefix using the specified flat or hierarchical option.

listBlobs(final String prefix, final boolean useFlatBlobListing, final EnumSet<BlobListingDetails> listingDetails, BlobRequestOptions options, OperationContext opContext)

Returns an enumerable collection of blob items for the container whose names begin with the specified prefix, using the specified flat or hierarchical option, listing details options, request options, and operation context.

listBlobs()

Returns an enumerable collection of blob items for the container.

public Iterable<ListBlobItem> listBlobs()
Returns
Iterable<ListBlobItem>

An enumerable collection of ListBlobItem objects retrieved lazily that represents the items in this container.

listBlobs(final String prefix)

Returns an enumerable collection of blob items for the container whose names begin with the specified prefix.

public Iterable<ListBlobItem> listBlobs(final String prefix)
Parameters
prefix
final String

A String that represents the blob name prefix. This value must be preceded either by the name of the container or by the absolute path to the container.

Returns
Iterable<ListBlobItem>

An enumerable collection of ListBlobItem objects retrieved lazily that represents the items whose names begin with the specified prefix in this container.

listBlobs(final String prefix, final boolean useFlatBlobListing)

Returns an enumerable collection of blob items for the container whose names begin with the specified prefix using the specified flat or hierarchical option.

public Iterable<ListBlobItem> listBlobs(final String prefix, final boolean useFlatBlobListing)
Parameters
prefix
final String

A String that represents the blob name prefix. This value must be preceded either by the name of the container or by the absolute path to the container.

useFlatBlobListing
final boolean

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

Returns
Iterable<ListBlobItem>

An enumerable collection of ListBlobItem objects retrieved lazily that represents the items whose names begin with the specified prefix in this container.

listBlobs(final String prefix, final boolean useFlatBlobListing, final EnumSet<BlobListingDetails> listingDetails, BlobRequestOptions options, OperationContext opContext)

Returns an enumerable collection of blob items for the container whose names begin with the specified prefix, using the specified flat or hierarchical option, listing details options, request options, and operation context.

public Iterable<ListBlobItem> listBlobs(final String prefix, final boolean useFlatBlobListing, final EnumSet<BlobListingDetails> listingDetails, BlobRequestOptions options, OperationContext opContext)
Parameters
prefix
final String

A String that represents the blob name prefix. This value must be preceded either by the name of the container or by the absolute path to the container.

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, metadata, and/or uncommitted blocks are returned. Committed blocks are always returned.

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
Iterable<ListBlobItem>

An enumerable collection of ListBlobItem objects retrieved lazily that represents the items whose names begin with the specified prefix in this container.