FileReadHeaders Class

  • Reference
Package:
com.azure.storage.file.datalake.models
Maven Artifact:
com.azure:azure-storage-file-datalake:12.21.0
  • java.lang.Object
    • com.azure.storage.file.datalake.models.FileReadHeaders

public final class FileReadHeaders

Defines headers for Read operation.

Constructor Summary

Constructor Description
FileReadHeaders()

Method Summary

Modifier and Type Method and Description
String getAcceptRanges()

Get the acceptRanges property: Indicates that the service supports requests for partial file content.
List<PathAccessControlEntry> getAccessControlList()

Optional.
String getCacheControl()

Get the cacheControl property: This header is returned if it was previously specified for the file.
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 file has an MD5 hash and this operation is to read the full file, 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 file 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 file was the destination file.
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 file was the destination file.
String getCopySource()

Get the copySource property: URL up to 2 KB in length that specifies the source file or file used in the last attempted Copy Blob operation where this file was the destination file.
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 getCreationTime()

Get the creationTime property: The x-ms-creation-time property.
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 getETag()

Get the eTag property: The ETag contains a value that you can use to perform operations conditionally.
String getEncryptionContext()

Get the encryptionContext property: Encryption context for this path.
String getEncryptionKeySha256()

Get the encryptionKeySha256 property: The SHA-256 hash of the encryption key used to encrypt the file.
String getErrorCode()

Get the errorCode property: The errorCode property.
byte[] getFileContentMd5()

Get the fileContentMD5 property: If the file 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 file's MD5 value.
OffsetDateTime getLastModified()

Get the lastModified property: Returns the date and time the container was last modified.
LeaseDurationType getLeaseDuration()

Get the leaseDuration property: When a file is leased, specifies whether the lease is of infinite or fixed duration.
LeaseStateType getLeaseState()

Get the leaseState property: Lease state of the file.
LeaseStatusType getLeaseStatus()

Get the leaseStatus property: The current lease status of the file.
Map<String,String> getMetadata()

Get the metadata property: The metadata property.
String getRequestId()

Get the requestId property: This header uniquely identifies the request that was made and can be used for troubleshooting the request.
String getVersion()

Get the version property: Indicates the version of the Blob service used to execute the request.
Boolean isServerEncrypted()

Get the isServerEncrypted property: The value of this header is set to true if the file data and application metadata are completely encrypted using the specified algorithm.
FileReadHeaders setAcceptRanges(String acceptRanges)

Set the acceptRanges property: Indicates that the service supports requests for partial file content.
FileReadHeaders setAccessControlList(List<PathAccessControlEntry> accessControlList)

Optional.
FileReadHeaders setCacheControl(String cacheControl)

Set the cacheControl property: This header is returned if it was previously specified for the file.
FileReadHeaders 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.
FileReadHeaders 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.
FileReadHeaders setContentDisposition(String contentDisposition)

Set the contentDisposition property: This header returns the value that was specified for the 'x-ms-blob-content-disposition' header.
FileReadHeaders setContentEncoding(String contentEncoding)

Set the contentEncoding property: This header returns the value that was specified for the Content-Encoding request header.
FileReadHeaders setContentLanguage(String contentLanguage)

Set the contentLanguage property: This header returns the value that was specified for the Content-Language request header.
FileReadHeaders setContentLength(Long contentLength)

Set the contentLength property: The number of bytes present in the response body.
FileReadHeaders setContentMd5(byte[] contentMd5)

Set the contentMd5 property: If the file has an MD5 hash and this operation is to read the full file, this response header is returned so that the client can check for message content integrity.
FileReadHeaders setContentRange(String contentRange)

Set the contentRange property: Indicates the range of bytes returned in the event that the client requested a subset of the file by setting the 'Range' request header.
FileReadHeaders setContentType(String contentType)

Set the contentType property: The media type of the body of the response.
FileReadHeaders setCopyCompletionTime(OffsetDateTime copyCompletionTime)

Set the copyCompletionTime property: Conclusion time of the last attempted Copy Blob operation where this file was the destination file.
FileReadHeaders setCopyId(String copyId)

Set the copyId property: String identifier for this copy operation.
FileReadHeaders 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 file was the destination file.
FileReadHeaders setCopySource(String copySource)

Set the copySource property: URL up to 2 KB in length that specifies the source file or file used in the last attempted Copy Blob operation where this file was the destination file.
FileReadHeaders setCopyStatus(CopyStatusType copyStatus)

Set the copyStatus property: State of the copy operation identified by x-ms-copy-id.
FileReadHeaders setCopyStatusDescription(String copyStatusDescription)

Set the copyStatusDescription property: Only appears when x-ms-copy-status is failed or pending.
FileReadHeaders setCreationTime(OffsetDateTime creationTime)

Set the creationTime property: The x-ms-creation-time property.
FileReadHeaders 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.
FileReadHeaders setETag(String eTag)

Set the eTag property: The ETag contains a value that you can use to perform operations conditionally.
FileReadHeaders setEncryptionContext(String encryptionContext)

Encryption context that can be set on the file.
FileReadHeaders setEncryptionKeySha256(String encryptionKeySha256)

Set the encryptionKeySha256 property: The SHA-256 hash of the encryption key used to encrypt the file.
FileReadHeaders setErrorCode(String errorCode)

Set the errorCode property: The errorCode property.
FileReadHeaders setFileContentMd5(byte[] fileContentMd5)

Set the fileContentMD5 property: If the file 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 file's MD5 value.
FileReadHeaders setLastModified(OffsetDateTime lastModified)

Set the lastModified property: Returns the date and time the container was last modified.
FileReadHeaders setLeaseDuration(LeaseDurationType leaseDuration)

Set the leaseDuration property: When a file is leased, specifies whether the lease is of infinite or fixed duration.
FileReadHeaders setLeaseState(LeaseStateType leaseState)

Set the leaseState property: Lease state of the file.
FileReadHeaders setLeaseStatus(LeaseStatusType leaseStatus)

Set the leaseStatus property: The current lease status of the file.
FileReadHeaders setMetadata(Map<String,String> metadata)

Set the metadata property: The metadata property.
FileReadHeaders setRequestId(String requestId)

Set the requestId property: This header uniquely identifies the request that was made and can be used for troubleshooting the request.
FileReadHeaders setServerEncrypted(Boolean serverEncrypted)

Set the isServerEncrypted property: The value of this header is set to true if the file data and application metadata are completely encrypted using the specified algorithm.
FileReadHeaders setVersion(String version)

Set the version property: Indicates the version of the Blob service used to execute the request.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

FileReadHeaders

public FileReadHeaders()

Method Details

getAcceptRanges

public String getAcceptRanges()

Get the acceptRanges property: Indicates that the service supports requests for partial file content.

Returns:

the acceptRanges value.

getAccessControlList

public List getAccessControlList()

Optional. The POSIX access control list for the file or directory.

Returns:

the access control list.

getCacheControl

public String getCacheControl()

Get the cacheControl property: This header is returned if it was previously specified for the file.

Returns:

the cacheControl value.

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.

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.

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 file name specified.

Returns:

the contentDisposition value.

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.

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.

getContentLength

public Long getContentLength()

Get the contentLength property: The number of bytes present in the response body.

Returns:

the contentLength value.

getContentMd5

public byte[] getContentMd5()

Get the contentMd5 property: If the file has an MD5 hash and this operation is to read the full file, this response header is returned so that the client can check for message content integrity.

Returns:

the contentMd5 value.

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 file by setting the 'Range' request header.

Returns:

the contentRange value.

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.

getCopyCompletionTime

public OffsetDateTime getCopyCompletionTime()

Get the copyCompletionTime property: Conclusion time of the last attempted Copy Blob operation where this file was the destination file. 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 file has never been the destination in a Copy Blob operation, or if this file has been modified after a concluded Copy Blob operation using Set Blob Properties, Put Blob, or Put Block List.

Returns:

the copyCompletionTime value.

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.

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 file was the destination file. Can show between 0 and Content-Length bytes copied. This header does not appear if this file has never been the destination in a Copy Blob operation, or if this file has been modified after a concluded Copy Blob operation using Set Blob Properties, Put Blob, or Put Block List.

Returns:

the copyProgress value.

getCopySource

public String getCopySource()

Get the copySource property: URL up to 2 KB in length that specifies the source file or file used in the last attempted Copy Blob operation where this file was the destination file. This header does not appear if this file has never been the destination in a Copy Blob operation, or if this file has been modified after a concluded Copy Blob operation using Set Blob Properties, Put Blob, or Put Block List.

Returns:

the copySource value.

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.

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 file has never been the destination in a Copy Blob operation, or if this file has been modified after a concluded Copy Blob operation using Set Blob Properties, Put Blob, or Put Block List.

Returns:

the copyStatusDescription value.

getCreationTime

public OffsetDateTime getCreationTime()

Get the creationTime property: The x-ms-creation-time property.

Returns:

the creationTime value.

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.

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.

getEncryptionContext

public String getEncryptionContext()

Get the encryptionContext property: Encryption context for this path.

Returns:

the encryptionContext value.

getEncryptionKeySha256

public String getEncryptionKeySha256()

Get the encryptionKeySha256 property: The SHA-256 hash of the encryption key used to encrypt the file. This header is only returned when the file was encrypted with a customer-provided key.

Returns:

the encryptionKeySha256 value.

getErrorCode

public String getErrorCode()

Get the errorCode property: The errorCode property.

Returns:

the errorCode value.

getFileContentMd5

public byte[] getFileContentMd5()

Get the fileContentMD5 property: If the file 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 file'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 fileContentMD5 value.

getLastModified

public OffsetDateTime getLastModified()

Get the lastModified property: Returns the date and time the container was last modified. Any operation that modifies the file, including an update of the file's metadata or properties, changes the last-modified time of the file.

Returns:

the lastModified value.

getLeaseDuration

public LeaseDurationType getLeaseDuration()

Get the leaseDuration property: When a file is leased, specifies whether the lease is of infinite or fixed duration. Possible values include: 'infinite', 'fixed'.

Returns:

the leaseDuration value.

getLeaseState

public LeaseStateType getLeaseState()

Get the leaseState property: Lease state of the file. Possible values include: 'available', 'leased', 'expired', 'breaking', 'broken'.

Returns:

the leaseState value.

getLeaseStatus

public LeaseStatusType getLeaseStatus()

Get the leaseStatus property: The current lease status of the file. Possible values include: 'locked', 'unlocked'.

Returns:

the leaseStatus value.

getMetadata

public Map getMetadata()

Get the metadata property: The metadata property.

Returns:

the metadata value.

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.

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.

isServerEncrypted

public Boolean isServerEncrypted()

Get the isServerEncrypted property: The value of this header is set to true if the file data and application metadata are completely encrypted using the specified algorithm. Otherwise, the value is set to false (when the file is unencrypted, or if only parts of the file/application metadata are encrypted).

Returns:

the isServerEncrypted value.

setAcceptRanges

public FileReadHeaders setAcceptRanges(String acceptRanges)

Set the acceptRanges property: Indicates that the service supports requests for partial file content.

Parameters:

acceptRanges - the acceptRanges value to set.

Returns:

the FileReadHeaders object itself.

setAccessControlList

public FileReadHeaders setAccessControlList(List accessControlList)

Optional. The POSIX access control list for the file or directory.

Parameters:

accessControlList - the access control list to be set on the file or directory.

Returns:

the FileReadHeaders object itself.

setCacheControl

public FileReadHeaders setCacheControl(String cacheControl)

Set the cacheControl property: This header is returned if it was previously specified for the file.

Parameters:

cacheControl - the cacheControl value to set.

Returns:

the FileReadHeaders object itself.

setClientRequestId

public FileReadHeaders 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 FileReadHeaders object itself.

setContentCrc64

public FileReadHeaders 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 FileReadHeaders object itself.

setContentDisposition

public FileReadHeaders 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 file name specified.

Parameters:

contentDisposition - the contentDisposition value to set.

Returns:

the FileReadHeaders object itself.

setContentEncoding

public FileReadHeaders 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 FileReadHeaders object itself.

setContentLanguage

public FileReadHeaders 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 FileReadHeaders object itself.

setContentLength

public FileReadHeaders 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 FileReadHeaders object itself.

setContentMd5

public FileReadHeaders setContentMd5(byte[] contentMd5)

Set the contentMd5 property: If the file has an MD5 hash and this operation is to read the full file, this response header is returned so that the client can check for message content integrity.

Parameters:

contentMd5 - the contentMd5 value to set.

Returns:

the FileReadHeaders object itself.

setContentRange

public FileReadHeaders setContentRange(String contentRange)

Set the contentRange property: Indicates the range of bytes returned in the event that the client requested a subset of the file by setting the 'Range' request header.

Parameters:

contentRange - the contentRange value to set.

Returns:

the FileReadHeaders object itself.

setContentType

public FileReadHeaders 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 FileReadHeaders object itself.

setCopyCompletionTime

public FileReadHeaders setCopyCompletionTime(OffsetDateTime copyCompletionTime)

Set the copyCompletionTime property: Conclusion time of the last attempted Copy Blob operation where this file was the destination file. 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 file has never been the destination in a Copy Blob operation, or if this file 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 FileReadHeaders object itself.

setCopyId

public FileReadHeaders 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 FileReadHeaders object itself.

setCopyProgress

public FileReadHeaders 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 file was the destination file. Can show between 0 and Content-Length bytes copied. This header does not appear if this file has never been the destination in a Copy Blob operation, or if this file 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 FileReadHeaders object itself.

setCopySource

public FileReadHeaders setCopySource(String copySource)

Set the copySource property: URL up to 2 KB in length that specifies the source file or file used in the last attempted Copy Blob operation where this file was the destination file. This header does not appear if this file has never been the destination in a Copy Blob operation, or if this file 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 FileReadHeaders object itself.

setCopyStatus

public FileReadHeaders 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 FileReadHeaders object itself.

setCopyStatusDescription

public FileReadHeaders 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 file has never been the destination in a Copy Blob operation, or if this file 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 FileReadHeaders object itself.

setCreationTime

public FileReadHeaders setCreationTime(OffsetDateTime creationTime)

Set the creationTime property: The x-ms-creation-time property.

Parameters:

creationTime - the creation time value to set.

Returns:

the FileReadHeaders object itself.

setDateProperty

public FileReadHeaders 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 FileReadHeaders object itself.

setETag

public FileReadHeaders 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 FileReadHeaders object itself.

setEncryptionContext

public FileReadHeaders setEncryptionContext(String encryptionContext)

Encryption context that can be set on the file. Encryption context is intended to store metadata that can be used to decrypt the blob.

Parameters:

encryptionContext - the encryption context to be set on the file.

Returns:

the FileReadHeaders object itself.

setEncryptionKeySha256

public FileReadHeaders setEncryptionKeySha256(String encryptionKeySha256)

Set the encryptionKeySha256 property: The SHA-256 hash of the encryption key used to encrypt the file. This header is only returned when the file was encrypted with a customer-provided key.

Parameters:

encryptionKeySha256 - the encryptionKeySha256 value to set.

Returns:

the FileReadHeaders object itself.

setErrorCode

public FileReadHeaders setErrorCode(String errorCode)

Set the errorCode property: The errorCode property.

Parameters:

errorCode - the errorCode value to set.

Returns:

the FileReadHeaders object itself.

setFileContentMd5

public FileReadHeaders setFileContentMd5(byte[] fileContentMd5)

Set the fileContentMD5 property: If the file 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 file'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:

fileContentMd5 - the fileContentMD5 value to set.

Returns:

the FileReadHeaders object itself.

setLastModified

public FileReadHeaders setLastModified(OffsetDateTime lastModified)

Set the lastModified property: Returns the date and time the container was last modified. Any operation that modifies the file, including an update of the file's metadata or properties, changes the last-modified time of the file.

Parameters:

lastModified - the lastModified value to set.

Returns:

the FileReadHeaders object itself.

setLeaseDuration

public FileReadHeaders setLeaseDuration(LeaseDurationType leaseDuration)

Set the leaseDuration property: When a file 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 FileReadHeaders object itself.

setLeaseState

public FileReadHeaders setLeaseState(LeaseStateType leaseState)

Set the leaseState property: Lease state of the file. Possible values include: 'available', 'leased', 'expired', 'breaking', 'broken'.

Parameters:

leaseState - the leaseState value to set.

Returns:

the FileReadHeaders object itself.

setLeaseStatus

public FileReadHeaders setLeaseStatus(LeaseStatusType leaseStatus)

Set the leaseStatus property: The current lease status of the file. Possible values include: 'locked', 'unlocked'.

Parameters:

leaseStatus - the leaseStatus value to set.

Returns:

the FileReadHeaders object itself.

setMetadata

public FileReadHeaders setMetadata(Map metadata)

Set the metadata property: The metadata property.

Parameters:

metadata - the metadata value to set.

Returns:

the FileReadHeaders object itself.

setRequestId

public FileReadHeaders 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 FileReadHeaders object itself.

setServerEncrypted

public FileReadHeaders setServerEncrypted(Boolean serverEncrypted)

Set the isServerEncrypted property: The value of this header is set to true if the file data and application metadata are completely encrypted using the specified algorithm. Otherwise, the value is set to false (when the file is unencrypted, or if only parts of the file/application metadata are encrypted).

Parameters:

serverEncrypted - the isServerEncrypted value to set.

Returns:

the FileReadHeaders object itself.

setVersion

public FileReadHeaders 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 FileReadHeaders object itself.

Applies to