Package com.azure.storage.blob.models
Class BlobDownloadHeaders
- java.lang.Object
-
- com.azure.storage.blob.models.BlobDownloadHeaders
-
public final class BlobDownloadHeaders extends Object
Defines headers for Download operation.
-
-
Constructor Summary
Constructors Constructor Description BlobDownloadHeaders()
Constructs a new instance ofBlobDownloadHeaders
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description String
getAcceptRanges()
Get the acceptRanges property: Indicates that the service supports requests for partial blob content.Integer
getBlobCommittedBlockCount()
Get the blobCommittedBlockCount property: The number of committed blocks present in the blob.byte[]
getBlobContentMD5()
Get the blobContentMD5 property: If the blob has a MD5 hash, and if request contains range header (Range or x-ms-range), this response header is returned with the value of the whole blob's MD5 value.Long
getBlobSequenceNumber()
Get the blobSequenceNumber property: The current sequence number for a page blob.BlobType
getBlobType()
Get the blobType property: The blob's type.String
getCacheControl()
Get the cacheControl property: This header is returned if it was previously specified for the blob.String
getClientRequestId()
Get the clientRequestId property: If a client request id header is sent in the request, this header will be present in the response with the same value.byte[]
getContentCrc64()
Get the contentCrc64 property: If the request is to read a specified range and the x-ms-range-get-content-crc64 is set to true, then the request returns a crc64 for the range, as long as the range size is less than or equal to 4 MB.String
getContentDisposition()
Get the contentDisposition property: This header returns the value that was specified for the 'x-ms-blob-content-disposition' header.String
getContentEncoding()
Get the contentEncoding property: This header returns the value that was specified for the Content-Encoding request header.String
getContentLanguage()
Get the contentLanguage property: This header returns the value that was specified for the Content-Language request header.Long
getContentLength()
Get the contentLength property: The number of bytes present in the response body.byte[]
getContentMd5()
Get the contentMd5 property: If the blob has an MD5 hash and this operation is to read the full blob, this response header is returned so that the client can check for message content integrity.String
getContentRange()
Get the contentRange property: Indicates the range of bytes returned in the event that the client requested a subset of the blob by setting the 'Range' request header.String
getContentType()
Get the contentType property: The media type of the body of the response.OffsetDateTime
getCopyCompletionTime()
Get the copyCompletionTime property: Conclusion time of the last attempted Copy Blob operation where this blob was the destination blob.String
getCopyId()
Get the copyId property: String identifier for this copy operation.String
getCopyProgress()
Get the copyProgress property: Contains the number of bytes copied and the total bytes in the source in the last attempted Copy Blob operation where this blob was the destination blob.String
getCopySource()
Get the copySource property: URL up to 2 KB in length that specifies the source blob or file used in the last attempted Copy Blob operation where this blob was the destination blob.CopyStatusType
getCopyStatus()
Get the copyStatus property: State of the copy operation identified by x-ms-copy-id.String
getCopyStatusDescription()
Get the copyStatusDescription property: Only appears when x-ms-copy-status is failed or pending.OffsetDateTime
getDateProperty()
Get the dateProperty property: UTC date/time value generated by the service that indicates the time at which the response was initiated.String
getEncryptionKeySha256()
Get the encryptionKeySha256 property: The SHA-256 hash of the encryption key used to encrypt the blob.String
getEncryptionScope()
Get the encryptionScope property: Returns the name of the encryption scope used to encrypt the blob contents and application metadata.String
getErrorCode()
Get the errorCode property: The errorCode property.String
getETag()
Get the eTag property: The ETag contains a value that you can use to perform operations conditionally.BlobImmutabilityPolicy
getImmutabilityPolicy()
Get the immutabilityPolicy property: The x-ms-immutability-policy-mode and x-ms-immutability-policy-until-date property.OffsetDateTime
getLastAccessedTime()
Get the lastAccessedTime property: The lastAccessedTime property.OffsetDateTime
getLastModified()
Get the lastModified property: Returns the date and time the container was last modified.LeaseDurationType
getLeaseDuration()
Get the leaseDuration property: When a blob is leased, specifies whether the lease is of infinite or fixed duration.LeaseStateType
getLeaseState()
Get the leaseState property: Lease state of the blob.LeaseStatusType
getLeaseStatus()
Get the leaseStatus property: The current lease status of the blob.Map<String,String>
getMetadata()
Get the metadata property: The metadata property.String
getObjectReplicationDestinationPolicyId()
Get the objectReplicationDestinationPolicyId property: Optional.List<ObjectReplicationPolicy>
getObjectReplicationSourcePolicies()
Get the objectReplicationSourcePolicies property: The objectReplicationSourcePolicies property.String
getRequestId()
Get the requestId property: This header uniquely identifies the request that was made and can be used for troubleshooting the request.Long
getTagCount()
Get the tagCount property: The number of tags associated with the blob.String
getVersion()
Get the version property: Indicates the version of the Blob service used to execute the request.String
getVersionId()
Get the versionId property: A DateTime value returned by the service that uniquely identifies the blob.Boolean
hasLegalHold()
Get the hasLegalHold property: The x-ms-legal-hold property.Boolean
isCurrentVersion()
Get the currentVersion property: The x-ms-is-current-version property.Boolean
isSealed()
Get the sealed property: The sealed property.Boolean
isServerEncrypted()
Get the isServerEncrypted property: The value of this header is set to true if the blob data and application metadata are completely encrypted using the specified algorithm.BlobDownloadHeaders
setAcceptRanges(String acceptRanges)
Set the acceptRanges property: Indicates that the service supports requests for partial blob content.BlobDownloadHeaders
setBlobCommittedBlockCount(Integer blobCommittedBlockCount)
Set the blobCommittedBlockCount property: The number of committed blocks present in the blob.BlobDownloadHeaders
setBlobContentMD5(byte[] blobContentMD5)
Set the blobContentMD5 property: If the blob has a MD5 hash, and if request contains range header (Range or x-ms-range), this response header is returned with the value of the whole blob's MD5 value.BlobDownloadHeaders
setBlobSequenceNumber(Long blobSequenceNumber)
Set the blobSequenceNumber property: The current sequence number for a page blob.BlobDownloadHeaders
setBlobType(BlobType blobType)
Set the blobType property: The blob's type.BlobDownloadHeaders
setCacheControl(String cacheControl)
Set the cacheControl property: This header is returned if it was previously specified for the blob.BlobDownloadHeaders
setClientRequestId(String clientRequestId)
Set the clientRequestId property: If a client request id header is sent in the request, this header will be present in the response with the same value.BlobDownloadHeaders
setContentCrc64(byte[] contentCrc64)
Set the contentCrc64 property: If the request is to read a specified range and the x-ms-range-get-content-crc64 is set to true, then the request returns a crc64 for the range, as long as the range size is less than or equal to 4 MB.BlobDownloadHeaders
setContentDisposition(String contentDisposition)
Set the contentDisposition property: This header returns the value that was specified for the 'x-ms-blob-content-disposition' header.BlobDownloadHeaders
setContentEncoding(String contentEncoding)
Set the contentEncoding property: This header returns the value that was specified for the Content-Encoding request header.BlobDownloadHeaders
setContentLanguage(String contentLanguage)
Set the contentLanguage property: This header returns the value that was specified for the Content-Language request header.BlobDownloadHeaders
setContentLength(Long contentLength)
Set the contentLength property: The number of bytes present in the response body.BlobDownloadHeaders
setContentMd5(byte[] contentMd5)
Set the contentMd5 property: If the blob has an MD5 hash and this operation is to read the full blob, this response header is returned so that the client can check for message content integrity.BlobDownloadHeaders
setContentRange(String contentRange)
Set the contentRange property: Indicates the range of bytes returned in the event that the client requested a subset of the blob by setting the 'Range' request header.BlobDownloadHeaders
setContentType(String contentType)
Set the contentType property: The media type of the body of the response.BlobDownloadHeaders
setCopyCompletionTime(OffsetDateTime copyCompletionTime)
Set the copyCompletionTime property: Conclusion time of the last attempted Copy Blob operation where this blob was the destination blob.BlobDownloadHeaders
setCopyId(String copyId)
Set the copyId property: String identifier for this copy operation.BlobDownloadHeaders
setCopyProgress(String copyProgress)
Set the copyProgress property: Contains the number of bytes copied and the total bytes in the source in the last attempted Copy Blob operation where this blob was the destination blob.BlobDownloadHeaders
setCopySource(String copySource)
Set the copySource property: URL up to 2 KB in length that specifies the source blob or file used in the last attempted Copy Blob operation where this blob was the destination blob.BlobDownloadHeaders
setCopyStatus(CopyStatusType copyStatus)
Set the copyStatus property: State of the copy operation identified by x-ms-copy-id.BlobDownloadHeaders
setCopyStatusDescription(String copyStatusDescription)
Set the copyStatusDescription property: Only appears when x-ms-copy-status is failed or pending.BlobDownloadHeaders
setCurrentVersion(Boolean currentVersion)
Set the currentVersion property: The x-ms-is-current-version property.BlobDownloadHeaders
setDateProperty(OffsetDateTime dateProperty)
Set the dateProperty property: UTC date/time value generated by the service that indicates the time at which the response was initiated.BlobDownloadHeaders
setEncryptionKeySha256(String encryptionKeySha256)
Set the encryptionKeySha256 property: The SHA-256 hash of the encryption key used to encrypt the blob.BlobDownloadHeaders
setEncryptionScope(String encryptionScope)
Set the encryptionScope property: Returns the name of the encryption scope used to encrypt the blob contents and application metadata.BlobDownloadHeaders
setErrorCode(String errorCode)
Set the errorCode property: The errorCode property.BlobDownloadHeaders
setETag(String eTag)
Set the eTag property: The ETag contains a value that you can use to perform operations conditionally.BlobDownloadHeaders
setHasLegalHold(Boolean hasLegalHold)
Set the hasLegalHold property: The x-ms-legal-hold property.BlobDownloadHeaders
setImmutabilityPolicy(BlobImmutabilityPolicy immutabilityPolicy)
Set the immutabilityPolicy property: x-ms-immutability-policy-mode and x-ms-immutability-policy-until-date property.BlobDownloadHeaders
setIsServerEncrypted(Boolean isServerEncrypted)
Set the isServerEncrypted property: The value of this header is set to true if the blob data and application metadata are completely encrypted using the specified algorithm.BlobDownloadHeaders
setLastAccessedTime(OffsetDateTime lastAccessedTime)
Set the lastAccessedTime property: The lastAccessedTime property.BlobDownloadHeaders
setLastModified(OffsetDateTime lastModified)
Set the lastModified property: Returns the date and time the container was last modified.BlobDownloadHeaders
setLeaseDuration(LeaseDurationType leaseDuration)
Set the leaseDuration property: When a blob is leased, specifies whether the lease is of infinite or fixed duration.BlobDownloadHeaders
setLeaseState(LeaseStateType leaseState)
Set the leaseState property: Lease state of the blob.BlobDownloadHeaders
setLeaseStatus(LeaseStatusType leaseStatus)
Set the leaseStatus property: The current lease status of the blob.BlobDownloadHeaders
setMetadata(Map<String,String> metadata)
Set the metadata property: The metadata property.BlobDownloadHeaders
setObjectReplicationDestinationPolicyId(String objectReplicationDestinationPolicyId)
Set the objectReplicationDestinationPolicyId property: Optional.BlobDownloadHeaders
setObjectReplicationSourcePolicies(List<ObjectReplicationPolicy> objectReplicationSourcePolicies)
Set the objectReplicationSourcePolicies property: The objectReplicationSourcePolicies property.BlobDownloadHeaders
setRequestId(String requestId)
Set the requestId property: This header uniquely identifies the request that was made and can be used for troubleshooting the request.BlobDownloadHeaders
setSealed(Boolean sealed)
Set the sealed property: The sealed property.BlobDownloadHeaders
setTagCount(Long tagCount)
Set the tagCount property: The number of tags associated with the blob.BlobDownloadHeaders
setVersion(String version)
Set the version property: Indicates the version of the Blob service used to execute the request.BlobDownloadHeaders
setVersionId(String versionId)
Set the versionId property: A DateTime value returned by the service that uniquely identifies the blob.
-
-
-
Constructor Detail
-
BlobDownloadHeaders
public BlobDownloadHeaders()
Constructs a new instance ofBlobDownloadHeaders
.
-
-
Method Detail
-
getLastModified
public OffsetDateTime getLastModified()
Get the lastModified property: Returns the date and time the container was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob.- Returns:
- the lastModified value.
-
setLastModified
public BlobDownloadHeaders setLastModified(OffsetDateTime lastModified)
Set the lastModified property: Returns the date and time the container was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob.- Parameters:
lastModified
- the lastModified value to set.- Returns:
- the BlobDownloadHeaders object itself.
-
getMetadata
public Map<String,String> getMetadata()
Get the metadata property: The metadata property.- Returns:
- the metadata value.
-
setMetadata
public BlobDownloadHeaders setMetadata(Map<String,String> metadata)
Set the metadata property: The metadata property.- Parameters:
metadata
- the metadata value to set.- Returns:
- the BlobDownloadHeaders object itself.
-
getObjectReplicationDestinationPolicyId
public String getObjectReplicationDestinationPolicyId()
Get the objectReplicationDestinationPolicyId property: Optional. Only valid when Object Replication is enabled for the storage container and on the destination blob of the replication.- Returns:
- the objectReplicationDestinationPolicyId value.
-
setObjectReplicationDestinationPolicyId
public BlobDownloadHeaders setObjectReplicationDestinationPolicyId(String objectReplicationDestinationPolicyId)
Set the objectReplicationDestinationPolicyId property: Optional. Only valid when Object Replication is enabled for the storage container and on the destination blob of the replication.- Parameters:
objectReplicationDestinationPolicyId
- the objectReplicationDestinationPolicyId value to set.- Returns:
- the BlobDownloadHeaders object itself.
-
getObjectReplicationSourcePolicies
public List<ObjectReplicationPolicy> getObjectReplicationSourcePolicies()
Get the objectReplicationSourcePolicies property: The objectReplicationSourcePolicies property.- Returns:
- the objectReplicationSourcePolicies value.
-
setObjectReplicationSourcePolicies
public BlobDownloadHeaders setObjectReplicationSourcePolicies(List<ObjectReplicationPolicy> objectReplicationSourcePolicies)
Set the objectReplicationSourcePolicies property: The objectReplicationSourcePolicies property.- Parameters:
objectReplicationSourcePolicies
- the objectReplicationSourcePolicies value to set.- Returns:
- the BlobDownloadHeaders object itself.
-
getContentLength
public Long getContentLength()
Get the contentLength property: The number of bytes present in the response body.- Returns:
- the contentLength value.
-
setContentLength
public BlobDownloadHeaders setContentLength(Long contentLength)
Set the contentLength property: The number of bytes present in the response body.- Parameters:
contentLength
- the contentLength value to set.- Returns:
- the BlobDownloadHeaders object itself.
-
getContentType
public String getContentType()
Get the contentType property: The media type of the body of the response. For Download Blob this is 'application/octet-stream'.- Returns:
- the contentType value.
-
setContentType
public BlobDownloadHeaders setContentType(String contentType)
Set the contentType property: The media type of the body of the response. For Download Blob this is 'application/octet-stream'.- Parameters:
contentType
- the contentType value to set.- Returns:
- the BlobDownloadHeaders object itself.
-
getContentRange
public String getContentRange()
Get the contentRange property: Indicates the range of bytes returned in the event that the client requested a subset of the blob by setting the 'Range' request header.- Returns:
- the contentRange value.
-
setContentRange
public BlobDownloadHeaders setContentRange(String contentRange)
Set the contentRange property: Indicates the range of bytes returned in the event that the client requested a subset of the blob by setting the 'Range' request header.- Parameters:
contentRange
- the contentRange value to set.- Returns:
- the BlobDownloadHeaders object itself.
-
getETag
public String getETag()
Get the eTag property: The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes.- Returns:
- the eTag value.
-
setETag
public BlobDownloadHeaders setETag(String eTag)
Set the eTag property: The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes.- Parameters:
eTag
- the eTag value to set.- Returns:
- the BlobDownloadHeaders object itself.
-
getContentMd5
public byte[] getContentMd5()
Get the contentMd5 property: If the blob has an MD5 hash and this operation is to read the full blob, this response header is returned so that the client can check for message content integrity.- Returns:
- the contentMd5 value.
-
setContentMd5
public BlobDownloadHeaders setContentMd5(byte[] contentMd5)
Set the contentMd5 property: If the blob has an MD5 hash and this operation is to read the full blob, this response header is returned so that the client can check for message content integrity.- Parameters:
contentMd5
- the contentMd5 value to set.- Returns:
- the BlobDownloadHeaders object itself.
-
getContentEncoding
public String getContentEncoding()
Get the contentEncoding property: This header returns the value that was specified for the Content-Encoding request header.- Returns:
- the contentEncoding value.
-
setContentEncoding
public BlobDownloadHeaders setContentEncoding(String contentEncoding)
Set the contentEncoding property: This header returns the value that was specified for the Content-Encoding request header.- Parameters:
contentEncoding
- the contentEncoding value to set.- Returns:
- the BlobDownloadHeaders object itself.
-
getCacheControl
public String getCacheControl()
Get the cacheControl property: This header is returned if it was previously specified for the blob.- Returns:
- the cacheControl value.
-
setCacheControl
public BlobDownloadHeaders setCacheControl(String cacheControl)
Set the cacheControl property: This header is returned if it was previously specified for the blob.- Parameters:
cacheControl
- the cacheControl value to set.- Returns:
- the BlobDownloadHeaders object itself.
-
getContentDisposition
public String getContentDisposition()
Get the contentDisposition property: This header returns the value that was specified for the 'x-ms-blob-content-disposition' header. The Content-Disposition response header field conveys additional information about how to process the response payload, and also can be used to attach additional metadata. For example, if set to attachment, it indicates that the user-agent should not display the response, but instead show a Save As dialog with a filename other than the blob name specified.- Returns:
- the contentDisposition value.
-
setContentDisposition
public BlobDownloadHeaders setContentDisposition(String contentDisposition)
Set the contentDisposition property: This header returns the value that was specified for the 'x-ms-blob-content-disposition' header. The Content-Disposition response header field conveys additional information about how to process the response payload, and also can be used to attach additional metadata. For example, if set to attachment, it indicates that the user-agent should not display the response, but instead show a Save As dialog with a filename other than the blob name specified.- Parameters:
contentDisposition
- the contentDisposition value to set.- Returns:
- the BlobDownloadHeaders object itself.
-
getContentLanguage
public String getContentLanguage()
Get the contentLanguage property: This header returns the value that was specified for the Content-Language request header.- Returns:
- the contentLanguage value.
-
setContentLanguage
public BlobDownloadHeaders setContentLanguage(String contentLanguage)
Set the contentLanguage property: This header returns the value that was specified for the Content-Language request header.- Parameters:
contentLanguage
- the contentLanguage value to set.- Returns:
- the BlobDownloadHeaders object itself.
-
getBlobSequenceNumber
public Long getBlobSequenceNumber()
Get the blobSequenceNumber property: The current sequence number for a page blob. This header is not returned for block blobs or append blobs.- Returns:
- the blobSequenceNumber value.
-
setBlobSequenceNumber
public BlobDownloadHeaders setBlobSequenceNumber(Long blobSequenceNumber)
Set the blobSequenceNumber property: The current sequence number for a page blob. This header is not returned for block blobs or append blobs.- Parameters:
blobSequenceNumber
- the blobSequenceNumber value to set.- Returns:
- the BlobDownloadHeaders object itself.
-
getBlobType
public BlobType getBlobType()
Get the blobType property: The blob's type. Possible values include: 'BlockBlob', 'PageBlob', 'AppendBlob'.- Returns:
- the blobType value.
-
setBlobType
public BlobDownloadHeaders setBlobType(BlobType blobType)
Set the blobType property: The blob's type. Possible values include: 'BlockBlob', 'PageBlob', 'AppendBlob'.- Parameters:
blobType
- the blobType value to set.- Returns:
- the BlobDownloadHeaders object itself.
-
getCopyCompletionTime
public OffsetDateTime getCopyCompletionTime()
Get the copyCompletionTime property: Conclusion time of the last attempted Copy Blob operation where this blob was the destination blob. This value can specify the time of a completed, aborted, or failed copy attempt. This header does not appear if a copy is pending, if this blob has never been the destination in a Copy Blob operation, or if this blob has been modified after a concluded Copy Blob operation using Set Blob Properties, Put Blob, or Put Block List.- Returns:
- the copyCompletionTime value.
-
setCopyCompletionTime
public BlobDownloadHeaders setCopyCompletionTime(OffsetDateTime copyCompletionTime)
Set the copyCompletionTime property: Conclusion time of the last attempted Copy Blob operation where this blob was the destination blob. This value can specify the time of a completed, aborted, or failed copy attempt. This header does not appear if a copy is pending, if this blob has never been the destination in a Copy Blob operation, or if this blob has been modified after a concluded Copy Blob operation using Set Blob Properties, Put Blob, or Put Block List.- Parameters:
copyCompletionTime
- the copyCompletionTime value to set.- Returns:
- the BlobDownloadHeaders object itself.
-
getCopyStatusDescription
public String getCopyStatusDescription()
Get the copyStatusDescription property: Only appears when x-ms-copy-status is failed or pending. Describes the cause of the last fatal or non-fatal copy operation failure. This header does not appear if this blob has never been the destination in a Copy Blob operation, or if this blob has been modified after a concluded Copy Blob operation using Set Blob Properties, Put Blob, or Put Block List.- Returns:
- the copyStatusDescription value.
-
setCopyStatusDescription
public BlobDownloadHeaders setCopyStatusDescription(String copyStatusDescription)
Set the copyStatusDescription property: Only appears when x-ms-copy-status is failed or pending. Describes the cause of the last fatal or non-fatal copy operation failure. This header does not appear if this blob has never been the destination in a Copy Blob operation, or if this blob has been modified after a concluded Copy Blob operation using Set Blob Properties, Put Blob, or Put Block List.- Parameters:
copyStatusDescription
- the copyStatusDescription value to set.- Returns:
- the BlobDownloadHeaders object itself.
-
getCopyId
public String getCopyId()
Get the copyId property: String identifier for this copy operation. Use with Get Blob Properties to check the status of this copy operation, or pass to Abort Copy Blob to abort a pending copy.- Returns:
- the copyId value.
-
setCopyId
public BlobDownloadHeaders setCopyId(String copyId)
Set the copyId property: String identifier for this copy operation. Use with Get Blob Properties to check the status of this copy operation, or pass to Abort Copy Blob to abort a pending copy.- Parameters:
copyId
- the copyId value to set.- Returns:
- the BlobDownloadHeaders object itself.
-
getCopyProgress
public String getCopyProgress()
Get the copyProgress property: Contains the number of bytes copied and the total bytes in the source in the last attempted Copy Blob operation where this blob was the destination blob. Can show between 0 and Content-Length bytes copied. This header does not appear if this blob has never been the destination in a Copy Blob operation, or if this blob has been modified after a concluded Copy Blob operation using Set Blob Properties, Put Blob, or Put Block List.- Returns:
- the copyProgress value.
-
setCopyProgress
public BlobDownloadHeaders setCopyProgress(String copyProgress)
Set the copyProgress property: Contains the number of bytes copied and the total bytes in the source in the last attempted Copy Blob operation where this blob was the destination blob. Can show between 0 and Content-Length bytes copied. This header does not appear if this blob has never been the destination in a Copy Blob operation, or if this blob has been modified after a concluded Copy Blob operation using Set Blob Properties, Put Blob, or Put Block List.- Parameters:
copyProgress
- the copyProgress value to set.- Returns:
- the BlobDownloadHeaders object itself.
-
getCopySource
public String getCopySource()
Get the copySource property: URL up to 2 KB in length that specifies the source blob or file used in the last attempted Copy Blob operation where this blob was the destination blob. This header does not appear if this blob has never been the destination in a Copy Blob operation, or if this blob has been modified after a concluded Copy Blob operation using Set Blob Properties, Put Blob, or Put Block List.- Returns:
- the copySource value.
-
setCopySource
public BlobDownloadHeaders setCopySource(String copySource)
Set the copySource property: URL up to 2 KB in length that specifies the source blob or file used in the last attempted Copy Blob operation where this blob was the destination blob. This header does not appear if this blob has never been the destination in a Copy Blob operation, or if this blob has been modified after a concluded Copy Blob operation using Set Blob Properties, Put Blob, or Put Block List.- Parameters:
copySource
- the copySource value to set.- Returns:
- the BlobDownloadHeaders object itself.
-
getCopyStatus
public CopyStatusType getCopyStatus()
Get the copyStatus property: State of the copy operation identified by x-ms-copy-id. Possible values include: 'pending', 'success', 'aborted', 'failed'.- Returns:
- the copyStatus value.
-
setCopyStatus
public BlobDownloadHeaders setCopyStatus(CopyStatusType copyStatus)
Set the copyStatus property: State of the copy operation identified by x-ms-copy-id. Possible values include: 'pending', 'success', 'aborted', 'failed'.- Parameters:
copyStatus
- the copyStatus value to set.- Returns:
- the BlobDownloadHeaders object itself.
-
getLeaseDuration
public LeaseDurationType getLeaseDuration()
Get the leaseDuration property: When a blob is leased, specifies whether the lease is of infinite or fixed duration. Possible values include: 'infinite', 'fixed'.- Returns:
- the leaseDuration value.
-
setLeaseDuration
public BlobDownloadHeaders setLeaseDuration(LeaseDurationType leaseDuration)
Set the leaseDuration property: When a blob is leased, specifies whether the lease is of infinite or fixed duration. Possible values include: 'infinite', 'fixed'.- Parameters:
leaseDuration
- the leaseDuration value to set.- Returns:
- the BlobDownloadHeaders object itself.
-
getLeaseState
public LeaseStateType getLeaseState()
Get the leaseState property: Lease state of the blob. Possible values include: 'available', 'leased', 'expired', 'breaking', 'broken'.- Returns:
- the leaseState value.
-
setLeaseState
public BlobDownloadHeaders setLeaseState(LeaseStateType leaseState)
Set the leaseState property: Lease state of the blob. Possible values include: 'available', 'leased', 'expired', 'breaking', 'broken'.- Parameters:
leaseState
- the leaseState value to set.- Returns:
- the BlobDownloadHeaders object itself.
-
getLeaseStatus
public LeaseStatusType getLeaseStatus()
Get the leaseStatus property: The current lease status of the blob. Possible values include: 'locked', 'unlocked'.- Returns:
- the leaseStatus value.
-
setLeaseStatus
public BlobDownloadHeaders setLeaseStatus(LeaseStatusType leaseStatus)
Set the leaseStatus property: The current lease status of the blob. Possible values include: 'locked', 'unlocked'.- Parameters:
leaseStatus
- the leaseStatus value to set.- Returns:
- the BlobDownloadHeaders object itself.
-
getClientRequestId
public String getClientRequestId()
Get the clientRequestId property: If a client request id header is sent in the request, this header will be present in the response with the same value.- Returns:
- the clientRequestId value.
-
setClientRequestId
public BlobDownloadHeaders setClientRequestId(String clientRequestId)
Set the clientRequestId property: If a client request id header is sent in the request, this header will be present in the response with the same value.- Parameters:
clientRequestId
- the clientRequestId value to set.- Returns:
- the BlobDownloadHeaders object itself.
-
getRequestId
public String getRequestId()
Get the requestId property: This header uniquely identifies the request that was made and can be used for troubleshooting the request.- Returns:
- the requestId value.
-
setRequestId
public BlobDownloadHeaders setRequestId(String requestId)
Set the requestId property: This header uniquely identifies the request that was made and can be used for troubleshooting the request.- Parameters:
requestId
- the requestId value to set.- Returns:
- the BlobDownloadHeaders object itself.
-
getVersion
public String getVersion()
Get the version property: Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above.- Returns:
- the version value.
-
setVersion
public BlobDownloadHeaders setVersion(String version)
Set the version property: Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above.- Parameters:
version
- the version value to set.- Returns:
- the BlobDownloadHeaders object itself.
-
getVersionId
public String getVersionId()
Get the versionId property: A DateTime value returned by the service that uniquely identifies the blob. The value of this header indicates the blob version, and may be used in subsequent requests to access this version of the blob.- Returns:
- the versionId value.
-
setVersionId
public BlobDownloadHeaders setVersionId(String versionId)
Set the versionId property: A DateTime value returned by the service that uniquely identifies the blob. The value of this header indicates the blob version, and may be used in subsequent requests to access this version of the blob.- Parameters:
versionId
- the versionId value to set.- Returns:
- the BlobDownloadHeaders object itself.
-
getAcceptRanges
public String getAcceptRanges()
Get the acceptRanges property: Indicates that the service supports requests for partial blob content.- Returns:
- the acceptRanges value.
-
setAcceptRanges
public BlobDownloadHeaders setAcceptRanges(String acceptRanges)
Set the acceptRanges property: Indicates that the service supports requests for partial blob content.- Parameters:
acceptRanges
- the acceptRanges value to set.- Returns:
- the BlobDownloadHeaders object itself.
-
getDateProperty
public OffsetDateTime getDateProperty()
Get the dateProperty property: UTC date/time value generated by the service that indicates the time at which the response was initiated.- Returns:
- the dateProperty value.
-
setDateProperty
public BlobDownloadHeaders setDateProperty(OffsetDateTime dateProperty)
Set the dateProperty property: UTC date/time value generated by the service that indicates the time at which the response was initiated.- Parameters:
dateProperty
- the dateProperty value to set.- Returns:
- the BlobDownloadHeaders object itself.
-
getBlobCommittedBlockCount
public Integer getBlobCommittedBlockCount()
Get the blobCommittedBlockCount property: The number of committed blocks present in the blob. This header is returned only for append blobs.- Returns:
- the blobCommittedBlockCount value.
-
setBlobCommittedBlockCount
public BlobDownloadHeaders setBlobCommittedBlockCount(Integer blobCommittedBlockCount)
Set the blobCommittedBlockCount property: The number of committed blocks present in the blob. This header is returned only for append blobs.- Parameters:
blobCommittedBlockCount
- the blobCommittedBlockCount value to set.- Returns:
- the BlobDownloadHeaders object itself.
-
isServerEncrypted
public Boolean isServerEncrypted()
Get the isServerEncrypted property: The value of this header is set to true if the blob data and application metadata are completely encrypted using the specified algorithm. Otherwise, the value is set to false (when the blob is unencrypted, or if only parts of the blob/application metadata are encrypted).- Returns:
- the isServerEncrypted value.
-
setIsServerEncrypted
public BlobDownloadHeaders setIsServerEncrypted(Boolean isServerEncrypted)
Set the isServerEncrypted property: The value of this header is set to true if the blob data and application metadata are completely encrypted using the specified algorithm. Otherwise, the value is set to false (when the blob is unencrypted, or if only parts of the blob/application metadata are encrypted).- Parameters:
isServerEncrypted
- the isServerEncrypted value to set.- Returns:
- the BlobDownloadHeaders object itself.
-
getEncryptionKeySha256
public String getEncryptionKeySha256()
Get the encryptionKeySha256 property: The SHA-256 hash of the encryption key used to encrypt the blob. This header is only returned when the blob was encrypted with a customer-provided key.- Returns:
- the encryptionKeySha256 value.
-
setEncryptionKeySha256
public BlobDownloadHeaders setEncryptionKeySha256(String encryptionKeySha256)
Set the encryptionKeySha256 property: The SHA-256 hash of the encryption key used to encrypt the blob. This header is only returned when the blob was encrypted with a customer-provided key.- Parameters:
encryptionKeySha256
- the encryptionKeySha256 value to set.- Returns:
- the BlobDownloadHeaders object itself.
-
getEncryptionScope
public String getEncryptionScope()
Get the encryptionScope property: Returns the name of the encryption scope used to encrypt the blob contents and application metadata. Note that the absence of this header implies use of the default account encryption scope.- Returns:
- the encryptionScope value.
-
setEncryptionScope
public BlobDownloadHeaders setEncryptionScope(String encryptionScope)
Set the encryptionScope property: Returns the name of the encryption scope used to encrypt the blob contents and application metadata. Note that the absence of this header implies use of the default account encryption scope.- Parameters:
encryptionScope
- the encryptionScope value to set.- Returns:
- the BlobDownloadHeaders object itself.
-
getBlobContentMD5
public byte[] getBlobContentMD5()
Get the blobContentMD5 property: If the blob has a MD5 hash, and if request contains range header (Range or x-ms-range), this response header is returned with the value of the whole blob's MD5 value. This value may or may not be equal to the value returned in Content-MD5 header, with the latter calculated from the requested range.- Returns:
- the blobContentMD5 value.
-
setBlobContentMD5
public BlobDownloadHeaders setBlobContentMD5(byte[] blobContentMD5)
Set the blobContentMD5 property: If the blob has a MD5 hash, and if request contains range header (Range or x-ms-range), this response header is returned with the value of the whole blob's MD5 value. This value may or may not be equal to the value returned in Content-MD5 header, with the latter calculated from the requested range.- Parameters:
blobContentMD5
- the blobContentMD5 value to set.- Returns:
- the BlobDownloadHeaders object itself.
-
getTagCount
public Long getTagCount()
Get the tagCount property: The number of tags associated with the blob.- Returns:
- the tagCount value.
-
setTagCount
public BlobDownloadHeaders setTagCount(Long tagCount)
Set the tagCount property: The number of tags associated with the blob.- Parameters:
tagCount
- the tagCount value to set.- Returns:
- the BlobDownloadHeaders object itself.
-
getContentCrc64
public byte[] getContentCrc64()
Get the contentCrc64 property: If the request is to read a specified range and the x-ms-range-get-content-crc64 is set to true, then the request returns a crc64 for the range, as long as the range size is less than or equal to 4 MB. If both x-ms-range-get-content-crc64 & x-ms-range-get-content-md5 is specified in the same request, it will fail with 400(Bad Request).- Returns:
- the contentCrc64 value.
-
setContentCrc64
public BlobDownloadHeaders setContentCrc64(byte[] contentCrc64)
Set the contentCrc64 property: If the request is to read a specified range and the x-ms-range-get-content-crc64 is set to true, then the request returns a crc64 for the range, as long as the range size is less than or equal to 4 MB. If both x-ms-range-get-content-crc64 & x-ms-range-get-content-md5 is specified in the same request, it will fail with 400(Bad Request).- Parameters:
contentCrc64
- the contentCrc64 value to set.- Returns:
- the BlobDownloadHeaders object itself.
-
getErrorCode
public String getErrorCode()
Get the errorCode property: The errorCode property.- Returns:
- the errorCode value.
-
setErrorCode
public BlobDownloadHeaders setErrorCode(String errorCode)
Set the errorCode property: The errorCode property.- Parameters:
errorCode
- the errorCode value to set.- Returns:
- the BlobDownloadHeaders object itself.
-
isSealed
public Boolean isSealed()
Get the sealed property: The sealed property.- Returns:
- Whether the blob is sealed (marked as read only). This is only applicable for Append blobs.
-
setSealed
public BlobDownloadHeaders setSealed(Boolean sealed)
Set the sealed property: The sealed property.- Parameters:
sealed
- Whether the blob is sealed (marked as read only). This is only applicable for Append blobs.- Returns:
- the BlobDownloadHeaders object itself.
-
getLastAccessedTime
public OffsetDateTime getLastAccessedTime()
Get the lastAccessedTime property: The lastAccessedTime property.- Returns:
- the lastAccessedTime value.
-
setLastAccessedTime
public BlobDownloadHeaders setLastAccessedTime(OffsetDateTime lastAccessedTime)
Set the lastAccessedTime property: The lastAccessedTime property.- Parameters:
lastAccessedTime
- the lastAccessedTime value to set.- Returns:
- the BlobDownloadHeaders object itself.
-
isCurrentVersion
public Boolean isCurrentVersion()
Get the currentVersion property: The x-ms-is-current-version property.- Returns:
- the currentVersion value.
-
setCurrentVersion
public BlobDownloadHeaders setCurrentVersion(Boolean currentVersion)
Set the currentVersion property: The x-ms-is-current-version property.- Parameters:
currentVersion
- the currentVersion value to set.- Returns:
- the BlobDownloadHeaders object itself.
-
getImmutabilityPolicy
public BlobImmutabilityPolicy getImmutabilityPolicy()
Get the immutabilityPolicy property: The x-ms-immutability-policy-mode and x-ms-immutability-policy-until-date property.- Returns:
- the immutabilityPolicy value.
-
setImmutabilityPolicy
public BlobDownloadHeaders setImmutabilityPolicy(BlobImmutabilityPolicy immutabilityPolicy)
Set the immutabilityPolicy property: x-ms-immutability-policy-mode and x-ms-immutability-policy-until-date property.- Parameters:
immutabilityPolicy
- the immutabilityPolicy value to set.- Returns:
- the BlobDownloadHeaders object itself.
-
hasLegalHold
public Boolean hasLegalHold()
Get the hasLegalHold property: The x-ms-legal-hold property.- Returns:
- the hasLegalHold value.
-
setHasLegalHold
public BlobDownloadHeaders setHasLegalHold(Boolean hasLegalHold)
Set the hasLegalHold property: The x-ms-legal-hold property.- Parameters:
hasLegalHold
- the xMsLegalHold value to set.- Returns:
- the BlobDownloadHeaders object itself.
-
-