Package com.azure.storage.blob.models
Class BlobListDetails
- java.lang.Object
-
- com.azure.storage.blob.models.BlobListDetails
-
public final class BlobListDetails extends Object
This type allows users to specify additional information the service should return with each blob when listing blobs in a container (via aBlobContainerClient
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.
-
-
Constructor Summary
Constructors Constructor Description BlobListDetails()
Constructs an unpopulatedBlobListDetails
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
getRetrieveCopy()
Whether blob metadata related to any current or previous Copy Blob operation should be included in the response.boolean
getRetrieveDeletedBlobs()
Whether blobs which have been soft deleted should be returned.boolean
getRetrieveDeletedBlobsWithVersions()
Whether blobs which have been deleted with versioning.boolean
getRetrieveImmutabilityPolicy()
Whether immutability policy for the blob should be returned.boolean
getRetrieveLegalHold()
Whether legal hold for the blob should be returned.boolean
getRetrieveMetadata()
Whether blob metadata should be returned.boolean
getRetrieveSnapshots()
Whether snapshots should be returned.boolean
getRetrieveTags()
Whether blob tags should be returned.boolean
getRetrieveUncommittedBlobs()
Whether blobs for which blocks have been uploaded, but which have not been committed using Put Block List, should be included in the response.boolean
getRetrieveVersions()
Whether versions should be returned.BlobListDetails
setRetrieveCopy(boolean retrieveCopy)
Whether blob metadata related to any current or previous Copy Blob operation should be included in the response.BlobListDetails
setRetrieveDeletedBlobs(boolean retrieveDeletedBlobs)
Whether blobs which have been soft deleted should be returned.BlobListDetails
setRetrieveDeletedBlobsWithVersions(boolean retrieveDeletedWithVersions)
Whether blobs which have been deleted with versioning should be returned.BlobListDetails
setRetrieveImmutabilityPolicy(boolean retrieveImmutabilityPolicy)
Whether immutability policy for the blob should be returned.BlobListDetails
setRetrieveLegalHold(boolean retrieveLegalHold)
Whether legal hold for the blob should be returned.BlobListDetails
setRetrieveMetadata(boolean retrieveMetadata)
Whether blob metadata should be returned.BlobListDetails
setRetrieveSnapshots(boolean retrieveSnapshots)
Whether snapshots should be returned.BlobListDetails
setRetrieveTags(boolean retrieveTags)
Whether blob tags should be returned.BlobListDetails
setRetrieveUncommittedBlobs(boolean retrieveUncommittedBlobs)
Whether blobs for which blocks have been uploaded, but which have not been committed using Put Block List, should be included in the response.BlobListDetails
setRetrieveVersions(boolean retrieveVersions)
Whether versions should be returned.ArrayList<ListBlobsIncludeItem>
toList()
-
-
-
Constructor Detail
-
BlobListDetails
public BlobListDetails()
Constructs an unpopulatedBlobListDetails
.
-
-
Method Detail
-
getRetrieveCopy
public boolean getRetrieveCopy()
Whether blob metadata related to any current or previous Copy Blob operation should be included in the response.- Returns:
- a flag indicating if copy information will be returned in the listing
-
setRetrieveCopy
public BlobListDetails setRetrieveCopy(boolean retrieveCopy)
Whether blob metadata related to any current or previous Copy Blob operation should be included in the response.- Parameters:
retrieveCopy
- Flag indicating whether copy information should be returned- Returns:
- the updated BlobListDetails object
-
getRetrieveMetadata
public boolean getRetrieveMetadata()
Whether blob metadata should be returned.- Returns:
- a flag indicating if metadata will be returned in the listing
-
setRetrieveMetadata
public BlobListDetails setRetrieveMetadata(boolean retrieveMetadata)
Whether blob metadata should be returned.- Parameters:
retrieveMetadata
- Flag indicating whether metadata should be returned- Returns:
- the updated BlobListDetails object
-
getRetrieveTags
public boolean getRetrieveTags()
Whether blob tags should be returned.- Returns:
- a flag indicating if tags will be returned in the listing
-
setRetrieveTags
public BlobListDetails setRetrieveTags(boolean retrieveTags)
Whether blob tags should be returned.- Parameters:
retrieveTags
- Flag indicating whether tags should be returned- Returns:
- the updated BlobListDetails object
-
getRetrieveSnapshots
public boolean getRetrieveSnapshots()
Whether snapshots should be returned. Snapshots are listed from oldest to newest.- Returns:
- a flag indicating if snapshots will be returned in the listing
-
setRetrieveSnapshots
public BlobListDetails setRetrieveSnapshots(boolean retrieveSnapshots)
Whether snapshots should be returned. Snapshots are listed from oldest to newest.- Parameters:
retrieveSnapshots
- Flag indicating whether snapshots should be returned- Returns:
- the updated BlobListDetails object
-
getRetrieveVersions
public boolean getRetrieveVersions()
Whether versions should be returned. Versions are listed from oldest to newest.- Returns:
- a flag indicating if versions will be returned in the listing
-
setRetrieveVersions
public BlobListDetails setRetrieveVersions(boolean retrieveVersions)
Whether versions should be returned. Versions are listed from oldest to newest.- Parameters:
retrieveVersions
- Flag indicating whether versions should be returned- Returns:
- the updated BlobListDetails object
-
getRetrieveUncommittedBlobs
public boolean getRetrieveUncommittedBlobs()
Whether blobs for which blocks have been uploaded, but which have not been committed using Put Block List, should be included in the response.- Returns:
- a flag indicating if uncommitted blobs will be returned in the listing
-
setRetrieveUncommittedBlobs
public BlobListDetails setRetrieveUncommittedBlobs(boolean retrieveUncommittedBlobs)
Whether blobs for which blocks have been uploaded, but which have not been committed using Put Block List, should be included in the response.- Parameters:
retrieveUncommittedBlobs
- Flag indicating whether uncommitted blobs should be returned- Returns:
- the updated BlobListDetails object
-
getRetrieveDeletedBlobs
public boolean getRetrieveDeletedBlobs()
Whether blobs which have been soft deleted should be returned.- Returns:
- a flag indicating if deleted blobs will be returned in the listing
-
setRetrieveDeletedBlobs
public BlobListDetails setRetrieveDeletedBlobs(boolean retrieveDeletedBlobs)
Whether blobs which have been soft deleted should be returned.- Parameters:
retrieveDeletedBlobs
- Flag indicating whether deleted blobs should be returned- Returns:
- the updated BlobListDetails object
-
getRetrieveDeletedBlobsWithVersions
public boolean getRetrieveDeletedBlobsWithVersions()
Whether blobs which have been deleted with versioning.- Returns:
- a flag indicating if deleted blobs with versioning will be returned in the listing
-
setRetrieveDeletedBlobsWithVersions
public BlobListDetails setRetrieveDeletedBlobsWithVersions(boolean retrieveDeletedWithVersions)
Whether blobs which have been deleted with versioning should be returned.- Parameters:
retrieveDeletedWithVersions
- Flag indicating whether deleted blobs with versioning should be returned- Returns:
- the updated BlobListDetails object
-
getRetrieveImmutabilityPolicy
public boolean getRetrieveImmutabilityPolicy()
Whether immutability policy for the blob should be returned.- Returns:
- a flag indicating if immutability policy for the blob will be returned in the listing
-
setRetrieveImmutabilityPolicy
public BlobListDetails setRetrieveImmutabilityPolicy(boolean retrieveImmutabilityPolicy)
Whether immutability policy for the blob should be returned.- Parameters:
retrieveImmutabilityPolicy
- Flag indicating whether immutability policy for the blob should be returned- Returns:
- the updated BlobListDetails object
-
getRetrieveLegalHold
public boolean getRetrieveLegalHold()
Whether legal hold for the blob should be returned.- Returns:
- a flag indicating if legal hold for the blob will be returned in the listing
-
setRetrieveLegalHold
public BlobListDetails setRetrieveLegalHold(boolean retrieveLegalHold)
Whether legal hold for the blob should be returned.- Parameters:
retrieveLegalHold
- Flag indicating whetherlegal hold for the blob should be returned- Returns:
- the updated BlobListDetails object
-
toList
public ArrayList<ListBlobsIncludeItem> toList()
- Returns:
- a list of the flag set to true
-
-