Class FileQueryHeaders
java.lang.Object
com.azure.storage.file.datalake.models.FileQueryHeaders
Defines headers for Read operation.
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionGet the acceptRanges property: Indicates that the service supports requests for partial file content.Get the cacheControl property: This header is returned if it was previously specified for the file.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[]
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.Get the contentDisposition property: This header returns the value that was specified for the 'x-ms-blob-content-disposition' header.Get the contentEncoding property: This header returns the value that was specified for the Content-Encoding request header.Get the contentLanguage property: This header returns the value that was specified for the Content-Language request header.Get the contentLength property: The number of bytes present in the response body.byte[]
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.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.Get the contentType property: The media type of the body of the response.Get the copyCompletionTime property: Conclusion time of the last attempted Copy Blob operation where this file was the destination file.Get the copyId property: String identifier for this copy operation.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.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.Get the copyStatus property: State of the copy operation identified by x-ms-copy-id.Get the copyStatusDescription property: Only appears when x-ms-copy-status is failed or pending.Get the dateProperty property: UTC date/time value generated by the service that indicates the time at which the response was initiated.Get the encryptionKeySha256 property: The SHA-256 hash of the encryption key used to encrypt the file.Get the errorCode property: The errorCode property.getETag()
Get the eTag property: The ETag contains a value that you can use to perform operations conditionally.byte[]
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.Get the lastModified property: Returns the date and time the container was last modified.Get the leaseDuration property: When a file is leased, specifies whether the lease is of infinite or fixed duration.Get the leaseState property: Lease state of the file.Get the leaseStatus property: The current lease status of the file.Get the metadata property: The metadata property.Get the requestId property: This header uniquely identifies the request that was made and can be used for troubleshooting the request.Get the version property: Indicates the version of the Blob service used to execute the request.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.setAcceptRanges
(String acceptRanges) Set the acceptRanges property: Indicates that the service supports requests for partial file content.setCacheControl
(String cacheControl) Set the cacheControl property: This header is returned if it was previously specified for the file.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.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.setContentDisposition
(String contentDisposition) Set the contentDisposition property: This header returns the value that was specified for the 'x-ms-blob-content-disposition' header.setContentEncoding
(String contentEncoding) Set the contentEncoding property: This header returns the value that was specified for the Content-Encoding request header.setContentLanguage
(String contentLanguage) Set the contentLanguage property: This header returns the value that was specified for the Content-Language request header.setContentLength
(Long contentLength) Set the contentLength property: The number of bytes present in the response body.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.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.setContentType
(String contentType) Set the contentType property: The media type of the body of the response.setCopyCompletionTime
(OffsetDateTime copyCompletionTime) Set the copyCompletionTime property: Conclusion time of the last attempted Copy Blob operation where this file was the destination file.Set the copyId property: String identifier for this copy operation.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.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.setCopyStatus
(CopyStatusType copyStatus) Set the copyStatus property: State of the copy operation identified by x-ms-copy-id.setCopyStatusDescription
(String copyStatusDescription) Set the copyStatusDescription property: Only appears when x-ms-copy-status is failed or pending.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.setEncryptionKeySha256
(String encryptionKeySha256) Set the encryptionKeySha256 property: The SHA-256 hash of the encryption key used to encrypt the file.setErrorCode
(String errorCode) Set the errorCode property: The errorCode property.Set the eTag property: The ETag contains a value that you can use to perform operations conditionally.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.setLastModified
(OffsetDateTime lastModified) Set the lastModified property: Returns the date and time the container was last modified.setLeaseDuration
(LeaseDurationType leaseDuration) Set the leaseDuration property: When a file is leased, specifies whether the lease is of infinite or fixed duration.setLeaseState
(LeaseStateType leaseState) Set the leaseState property: Lease state of the file.setLeaseStatus
(LeaseStatusType leaseStatus) Set the leaseStatus property: The current lease status of the file.setMetadata
(Map<String, String> metadata) Set the metadata property: The metadata property.setRequestId
(String requestId) Set the requestId property: This header uniquely identifies the request that was made and can be used for troubleshooting the request.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.setVersion
(String version) Set the version property: Indicates the version of the Blob service used to execute the request.
-
Constructor Details
-
FileQueryHeaders
public FileQueryHeaders()
-
-
Method Details
-
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.
-
setLastModified
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 FileQueryHeaders object itself.
-
getMetadata
Get the metadata property: The metadata property.- Returns:
- the metadata value.
-
setMetadata
Set the metadata property: The metadata property.- Parameters:
metadata
- the metadata value to set.- Returns:
- the FileQueryHeaders object itself.
-
getContentLength
Get the contentLength property: The number of bytes present in the response body.- Returns:
- the contentLength value.
-
setContentLength
Set the contentLength property: The number of bytes present in the response body.- Parameters:
contentLength
- the contentLength value to set.- Returns:
- the FileQueryHeaders object itself.
-
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
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 FileQueryHeaders object itself.
-
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.
-
setContentRange
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 FileQueryHeaders object itself.
-
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
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 FileQueryHeaders object itself.
-
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.
-
setContentMd5
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 FileQueryHeaders object itself.
-
getContentEncoding
Get the contentEncoding property: This header returns the value that was specified for the Content-Encoding request header.- Returns:
- the contentEncoding value.
-
setContentEncoding
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 FileQueryHeaders object itself.
-
getCacheControl
Get the cacheControl property: This header is returned if it was previously specified for the file.- Returns:
- the cacheControl value.
-
setCacheControl
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 FileQueryHeaders object itself.
-
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.
-
setContentDisposition
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 FileQueryHeaders object itself.
-
getContentLanguage
Get the contentLanguage property: This header returns the value that was specified for the Content-Language request header.- Returns:
- the contentLanguage value.
-
setContentLanguage
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 FileQueryHeaders object itself.
-
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.
-
setCopyCompletionTime
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 FileQueryHeaders object itself.
-
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.
-
setCopyStatusDescription
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 FileQueryHeaders object itself.
-
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
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 FileQueryHeaders object itself.
-
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.
-
setCopyProgress
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 FileQueryHeaders object itself.
-
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.
-
setCopySource
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 FileQueryHeaders object itself.
-
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
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 FileQueryHeaders object itself.
-
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.
-
setLeaseDuration
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 FileQueryHeaders object itself.
-
getLeaseState
Get the leaseState property: Lease state of the file. Possible values include: 'available', 'leased', 'expired', 'breaking', 'broken'.- Returns:
- the leaseState value.
-
setLeaseState
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 FileQueryHeaders object itself.
-
getLeaseStatus
Get the leaseStatus property: The current lease status of the file. Possible values include: 'locked', 'unlocked'.- Returns:
- the leaseStatus value.
-
setLeaseStatus
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 FileQueryHeaders object itself.
-
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
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 FileQueryHeaders object itself.
-
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
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 FileQueryHeaders object itself.
-
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
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 FileQueryHeaders object itself.
-
getAcceptRanges
Get the acceptRanges property: Indicates that the service supports requests for partial file content.- Returns:
- the acceptRanges value.
-
setAcceptRanges
Set the acceptRanges property: Indicates that the service supports requests for partial file content.- Parameters:
acceptRanges
- the acceptRanges value to set.- Returns:
- the FileQueryHeaders object itself.
-
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
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 FileQueryHeaders object itself.
-
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.
-
setServerEncrypted
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 FileQueryHeaders object itself.
-
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.
-
setEncryptionKeySha256
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 FileQueryHeaders object itself.
-
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.
-
setFileContentMd5
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 FileQueryHeaders 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
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 FileQueryHeaders object itself.
-
getErrorCode
Get the errorCode property: The errorCode property.- Returns:
- the errorCode value.
-
setErrorCode
Set the errorCode property: The errorCode property.- Parameters:
errorCode
- the errorCode value to set.- Returns:
- the FileQueryHeaders object itself.
-