public final class FileReadHeaders extends Object
Constructor and Description |
---|
FileReadHeaders() |
Modifier and Type | Method and Description |
---|---|
String |
getAcceptRanges()
Get the acceptRanges property: Indicates that the service supports
requests for partial file content.
|
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 |
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 file.
|
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.
|
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 |
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 |
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 |
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 |
setETag(String eTag)
Set the eTag property: The ETag contains a value that you can use to
perform operations conditionally.
|
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.
|
public OffsetDateTime getLastModified()
public FileReadHeaders setLastModified(OffsetDateTime lastModified)
lastModified
- the lastModified value to set.public Map<String,String> getMetadata()
public FileReadHeaders setMetadata(Map<String,String> metadata)
metadata
- the metadata value to set.public Long getContentLength()
public FileReadHeaders setContentLength(Long contentLength)
contentLength
- the contentLength value to set.public String getContentType()
public FileReadHeaders setContentType(String contentType)
contentType
- the contentType value to set.public String getContentRange()
public FileReadHeaders setContentRange(String contentRange)
contentRange
- the contentRange value to set.public String getETag()
public FileReadHeaders setETag(String eTag)
eTag
- the eTag value to set.public byte[] getContentMd5()
public FileReadHeaders setContentMd5(byte[] contentMd5)
contentMd5
- the contentMd5 value to set.public String getContentEncoding()
public FileReadHeaders setContentEncoding(String contentEncoding)
contentEncoding
- the contentEncoding value to set.public String getCacheControl()
public FileReadHeaders setCacheControl(String cacheControl)
cacheControl
- the cacheControl value to set.public String getContentDisposition()
public FileReadHeaders setContentDisposition(String contentDisposition)
contentDisposition
- the contentDisposition value to set.public String getContentLanguage()
public FileReadHeaders setContentLanguage(String contentLanguage)
contentLanguage
- the contentLanguage value to set.public OffsetDateTime getCopyCompletionTime()
public FileReadHeaders setCopyCompletionTime(OffsetDateTime copyCompletionTime)
copyCompletionTime
- the copyCompletionTime value to set.public String getCopyStatusDescription()
public FileReadHeaders setCopyStatusDescription(String copyStatusDescription)
copyStatusDescription
- the copyStatusDescription value to set.public String getCopyId()
public FileReadHeaders setCopyId(String copyId)
copyId
- the copyId value to set.public String getCopyProgress()
public FileReadHeaders setCopyProgress(String copyProgress)
copyProgress
- the copyProgress value to set.public String getCopySource()
public FileReadHeaders setCopySource(String copySource)
copySource
- the copySource value to set.public CopyStatusType getCopyStatus()
public FileReadHeaders setCopyStatus(CopyStatusType copyStatus)
copyStatus
- the copyStatus value to set.public LeaseDurationType getLeaseDuration()
public FileReadHeaders setLeaseDuration(LeaseDurationType leaseDuration)
leaseDuration
- the leaseDuration value to set.public LeaseStateType getLeaseState()
public FileReadHeaders setLeaseState(LeaseStateType leaseState)
leaseState
- the leaseState value to set.public LeaseStatusType getLeaseStatus()
public FileReadHeaders setLeaseStatus(LeaseStatusType leaseStatus)
leaseStatus
- the leaseStatus value to set.public String getClientRequestId()
public FileReadHeaders setClientRequestId(String clientRequestId)
clientRequestId
- the clientRequestId value to set.public String getRequestId()
public FileReadHeaders setRequestId(String requestId)
requestId
- the requestId value to set.public String getVersion()
public FileReadHeaders setVersion(String version)
version
- the version value to set.public String getAcceptRanges()
public FileReadHeaders setAcceptRanges(String acceptRanges)
acceptRanges
- the acceptRanges value to set.public OffsetDateTime getDateProperty()
public FileReadHeaders setDateProperty(OffsetDateTime dateProperty)
dateProperty
- the dateProperty value to set.public Boolean isServerEncrypted()
public FileReadHeaders setServerEncrypted(Boolean serverEncrypted)
serverEncrypted
- the isServerEncrypted value to set.public String getEncryptionKeySha256()
public FileReadHeaders setEncryptionKeySha256(String encryptionKeySha256)
encryptionKeySha256
- the encryptionKeySha256 value to set.public byte[] getFileContentMd5()
public FileReadHeaders setFileContentMd5(byte[] fileContentMd5)
fileContentMd5
- the fileContentMD5 value to set.public byte[] getContentCrc64()
public FileReadHeaders setContentCrc64(byte[] contentCrc64)
contentCrc64
- the contentCrc64 value to set.public String getErrorCode()
public FileReadHeaders setErrorCode(String errorCode)
errorCode
- the errorCode value to set.Copyright © 2020 Microsoft Corporation. All rights reserved.