com.microsoft.azure.storage.blob

Class BlobListingDetails

java.lang.Object

com.microsoft.azure.storage.blob.BlobListingDetails

public final class BlobListingDetails
extends Object

This type allows users to specify additional information the service should return with each blob when listing blobs in a container (via a ContainerURL object). This type is immutable to ensure thread-safety of requests, so changing the details for a different listing operation requires construction of a new object. Null may be passed if none of the options are desirable.

Field Summary

Fields

Modifier and Type	Field and Description
static BlobListingDetails	NONE An object representing no listing details.

Constructor Summary

Constructors

Constructor and Description
BlobListingDetails()

Method Summary

Modifier and Type	Method and Description
boolean	copy() Whether blob metadata related to any current or previous Copy Blob operation should be included in the response.
boolean	deletedBlobs() Whether blobs which have been soft deleted should be returned.
boolean	metadata() Whether blob metadata should be returned.
boolean	snapshots() Whether snapshots should be returned.
boolean	uncommittedBlobs() Whether blobs for which blocks have been uploaded, but which have not been committed using Put Block List, should be included in the response.
BlobListingDetails	withCopy(boolean copy) Whether blob metadata related to any current or previous Copy Blob operation should be included in the response.
BlobListingDetails	withDeletedBlobs(boolean deletedBlobs) Whether blobs which have been soft deleted should be returned.
BlobListingDetails	withMetadata(boolean metadata) Whether blob metadata should be returned.
BlobListingDetails	withSnapshots(boolean snapshots) Whether snapshots should be returned.
BlobListingDetails	withUncommittedBlobs(boolean uncommittedBlobs) Whether blobs for which blocks have been uploaded, but which have not been committed using Put Block List, should be included in the response.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

NONE

public static final BlobListingDetails NONE

An object representing no listing details.

Constructor Detail

BlobListingDetails

public BlobListingDetails()

Method Detail

copy

public boolean copy()

Whether blob metadata related to any current or previous Copy Blob operation should be included in the response.

withCopy

public BlobListingDetails withCopy(boolean copy)

Whether blob metadata related to any current or previous Copy Blob operation should be included in the response.

metadata

public boolean metadata()

Whether blob metadata should be returned.

withMetadata

public BlobListingDetails withMetadata(boolean metadata)

Whether blob metadata should be returned.

snapshots

public boolean snapshots()

Whether snapshots should be returned. Snapshots are listed from oldest to newest.

withSnapshots

public BlobListingDetails withSnapshots(boolean snapshots)

Whether snapshots should be returned. Snapshots are listed from oldest to newest.

uncommittedBlobs

public boolean uncommittedBlobs()

Whether blobs for which blocks have been uploaded, but which have not been committed using Put Block List, should be included in the response.

withUncommittedBlobs

public BlobListingDetails withUncommittedBlobs(boolean uncommittedBlobs)

Whether blobs for which blocks have been uploaded, but which have not been committed using Put Block List, should be included in the response.

deletedBlobs

public boolean deletedBlobs()

Whether blobs which have been soft deleted should be returned.

withDeletedBlobs

public BlobListingDetails withDeletedBlobs(boolean deletedBlobs)

Whether blobs which have been soft deleted should be returned.