public final class ShareFileDownloadHeaders extends Object
Constructor and Description |
---|
ShareFileDownloadHeaders() |
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: Returned if it was previously specified
for the file.
|
String |
getContentDisposition()
Get the contentDisposition property: Returns the value that was
specified for the 'x-ms-content-disposition' header and specifies how to
process the response.
|
String |
getContentEncoding()
Get the contentEncoding property: Returns the value that was specified
for the Content-Encoding request header.
|
String |
getContentLanguage()
Get the contentLanguage property: 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 the request
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 if
the client requested a subset of the file by setting the Range request
header.
|
String |
getContentType()
Get the contentType property: The content type specified for the file.
|
OffsetDateTime |
getCopyCompletionTime()
Get the copyCompletionTime property: Conclusion time of the last
attempted Copy File operation where this file was the destination file.
|
String |
getCopyId()
Get the copyId property: String identifier for the last attempted Copy
File operation where this file was the destination file.
|
String |
getCopyProgress()
Get the copyProgress property: Contains the number of bytes copied and
the total bytes in the source in the last attempted Copy File operation
where this file was the destination file.
|
String |
getCopySource()
Get the copySource property: URL up to 2KB in length that specifies the
source file used in the last attempted Copy File 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: A UTC date/time value generated by the
service that indicates the time at which the response was initiated.
|
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, in quotes.
|
String |
getFileAttributes()
Get the fileAttributes property: Attributes set for the file.
|
OffsetDateTime |
getFileChangeTime()
Get the fileChangeTime property: Change time for the file.
|
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 |
getFileCreationTime()
Get the fileCreationTime property: Creation time for the file.
|
String |
getFileId()
Get the fileId property: The fileId of the file.
|
OffsetDateTime |
getFileLastWriteTime()
Get the fileLastWriteTime property: Last write time for the file.
|
String |
getFileParentId()
Get the fileParentId property: The parent fileId of the file.
|
String |
getFilePermissionKey()
Get the filePermissionKey property: Key of the permission set for the
file.
|
OffsetDateTime |
getLastModified()
Get the lastModified property: Returns the date and time the file 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 File 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.
|
ShareFileDownloadHeaders |
setAcceptRanges(String acceptRanges)
Set the acceptRanges property: Indicates that the service supports
requests for partial file content.
|
ShareFileDownloadHeaders |
setCacheControl(String cacheControl)
Set the cacheControl property: Returned if it was previously specified
for the file.
|
ShareFileDownloadHeaders |
setContentDisposition(String contentDisposition)
Set the contentDisposition property: Returns the value that was
specified for the 'x-ms-content-disposition' header and specifies how to
process the response.
|
ShareFileDownloadHeaders |
setContentEncoding(String contentEncoding)
Set the contentEncoding property: Returns the value that was specified
for the Content-Encoding request header.
|
ShareFileDownloadHeaders |
setContentLanguage(String contentLanguage)
Set the contentLanguage property: Returns the value that was specified
for the Content-Language request header.
|
ShareFileDownloadHeaders |
setContentLength(Long contentLength)
Set the contentLength property: The number of bytes present in the
response body.
|
ShareFileDownloadHeaders |
setContentMd5(byte[] contentMd5)
Set the contentMd5 property: If the file has an MD5 hash and the request
is to read the full file, this response header is returned so that the
client can check for message content integrity.
|
ShareFileDownloadHeaders |
setContentRange(String contentRange)
Set the contentRange property: Indicates the range of bytes returned if
the client requested a subset of the file by setting the Range request
header.
|
ShareFileDownloadHeaders |
setContentType(String contentType)
Set the contentType property: The content type specified for the file.
|
ShareFileDownloadHeaders |
setCopyCompletionTime(OffsetDateTime copyCompletionTime)
Set the copyCompletionTime property: Conclusion time of the last
attempted Copy File operation where this file was the destination file.
|
ShareFileDownloadHeaders |
setCopyId(String copyId)
Set the copyId property: String identifier for the last attempted Copy
File operation where this file was the destination file.
|
ShareFileDownloadHeaders |
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 File operation
where this file was the destination file.
|
ShareFileDownloadHeaders |
setCopySource(String copySource)
Set the copySource property: URL up to 2KB in length that specifies the
source file used in the last attempted Copy File operation where this
file was the destination file.
|
ShareFileDownloadHeaders |
setCopyStatus(CopyStatusType copyStatus)
Set the copyStatus property: State of the copy operation identified by
'x-ms-copy-id'.
|
ShareFileDownloadHeaders |
setCopyStatusDescription(String copyStatusDescription)
Set the copyStatusDescription property: Only appears when
x-ms-copy-status is failed or pending.
|
ShareFileDownloadHeaders |
setDateProperty(OffsetDateTime dateProperty)
Set the dateProperty property: A UTC date/time value generated by the
service that indicates the time at which the response was initiated.
|
ShareFileDownloadHeaders |
setErrorCode(String errorCode)
Set the errorCode property: The errorCode property.
|
ShareFileDownloadHeaders |
setETag(String eTag)
Set the eTag property: The ETag contains a value that you can use to
perform operations conditionally, in quotes.
|
ShareFileDownloadHeaders |
setFileAttributes(String fileAttributes)
Set the fileAttributes property: Attributes set for the file.
|
ShareFileDownloadHeaders |
setFileChangeTime(OffsetDateTime fileChangeTime)
Set the fileChangeTime property: Change time for the file.
|
ShareFileDownloadHeaders |
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.
|
ShareFileDownloadHeaders |
setFileCreationTime(OffsetDateTime fileCreationTime)
Set the fileCreationTime property: Creation time for the file.
|
ShareFileDownloadHeaders |
setFileId(String fileId)
Set the fileId property: The fileId of the file.
|
ShareFileDownloadHeaders |
setFileLastWriteTime(OffsetDateTime fileLastWriteTime)
Set the fileLastWriteTime property: Last write time for the file.
|
ShareFileDownloadHeaders |
setFileParentId(String fileParentId)
Set the fileParentId property: The parent fileId of the file.
|
ShareFileDownloadHeaders |
setFilePermissionKey(String filePermissionKey)
Set the filePermissionKey property: Key of the permission set for the
file.
|
ShareFileDownloadHeaders |
setIsServerEncrypted(Boolean isServerEncrypted)
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.
|
ShareFileDownloadHeaders |
setLastModified(OffsetDateTime lastModified)
Set the lastModified property: Returns the date and time the file was
last modified.
|
ShareFileDownloadHeaders |
setLeaseDuration(LeaseDurationType leaseDuration)
Set the leaseDuration property: When a file is leased, specifies whether
the lease is of infinite or fixed duration.
|
ShareFileDownloadHeaders |
setLeaseState(LeaseStateType leaseState)
Set the leaseState property: Lease state of the file.
|
ShareFileDownloadHeaders |
setLeaseStatus(LeaseStatusType leaseStatus)
Set the leaseStatus property: The current lease status of the file.
|
ShareFileDownloadHeaders |
setMetadata(Map<String,String> metadata)
Set the metadata property: The metadata property.
|
ShareFileDownloadHeaders |
setRequestId(String requestId)
Set the requestId property: This header uniquely identifies the request
that was made and can be used for troubleshooting the request.
|
ShareFileDownloadHeaders |
setVersion(String version)
Set the version property: Indicates the version of the File service used
to execute the request.
|
public OffsetDateTime getLastModified()
public ShareFileDownloadHeaders setLastModified(OffsetDateTime lastModified)
lastModified
- the lastModified value to set.public Map<String,String> getMetadata()
public ShareFileDownloadHeaders setMetadata(Map<String,String> metadata)
metadata
- the metadata value to set.public Long getContentLength()
public ShareFileDownloadHeaders setContentLength(Long contentLength)
contentLength
- the contentLength value to set.public String getContentType()
public ShareFileDownloadHeaders setContentType(String contentType)
contentType
- the contentType value to set.public String getContentRange()
public ShareFileDownloadHeaders setContentRange(String contentRange)
contentRange
- the contentRange value to set.public String getETag()
public ShareFileDownloadHeaders setETag(String eTag)
eTag
- the eTag value to set.public byte[] getContentMd5()
public ShareFileDownloadHeaders setContentMd5(byte[] contentMd5)
contentMd5
- the contentMd5 value to set.public String getContentEncoding()
public ShareFileDownloadHeaders setContentEncoding(String contentEncoding)
contentEncoding
- the contentEncoding value to set.public String getCacheControl()
public ShareFileDownloadHeaders setCacheControl(String cacheControl)
cacheControl
- the cacheControl value to set.public String getContentDisposition()
public ShareFileDownloadHeaders setContentDisposition(String contentDisposition)
contentDisposition
- the contentDisposition value to set.public String getContentLanguage()
public ShareFileDownloadHeaders setContentLanguage(String contentLanguage)
contentLanguage
- the contentLanguage value to set.public String getRequestId()
public ShareFileDownloadHeaders setRequestId(String requestId)
requestId
- the requestId value to set.public String getVersion()
public ShareFileDownloadHeaders setVersion(String version)
version
- the version value to set.public String getAcceptRanges()
public ShareFileDownloadHeaders setAcceptRanges(String acceptRanges)
acceptRanges
- the acceptRanges value to set.public OffsetDateTime getDateProperty()
public ShareFileDownloadHeaders setDateProperty(OffsetDateTime dateProperty)
dateProperty
- the dateProperty value to set.public OffsetDateTime getCopyCompletionTime()
public ShareFileDownloadHeaders setCopyCompletionTime(OffsetDateTime copyCompletionTime)
copyCompletionTime
- the copyCompletionTime value to set.public String getCopyStatusDescription()
public ShareFileDownloadHeaders setCopyStatusDescription(String copyStatusDescription)
copyStatusDescription
- the copyStatusDescription value to set.public String getCopyId()
public ShareFileDownloadHeaders setCopyId(String copyId)
copyId
- the copyId value to set.public String getCopyProgress()
public ShareFileDownloadHeaders setCopyProgress(String copyProgress)
copyProgress
- the copyProgress value to set.public String getCopySource()
public ShareFileDownloadHeaders setCopySource(String copySource)
copySource
- the copySource value to set.public CopyStatusType getCopyStatus()
public ShareFileDownloadHeaders setCopyStatus(CopyStatusType copyStatus)
copyStatus
- the copyStatus value to set.public byte[] getFileContentMd5()
public ShareFileDownloadHeaders setFileContentMd5(byte[] fileContentMd5)
fileContentMd5
- the fileContentMd5 value to set.public Boolean isServerEncrypted()
public ShareFileDownloadHeaders setIsServerEncrypted(Boolean isServerEncrypted)
isServerEncrypted
- the isServerEncrypted value to set.public String getFileAttributes()
public ShareFileDownloadHeaders setFileAttributes(String fileAttributes)
fileAttributes
- the fileAttributes value to set.public OffsetDateTime getFileCreationTime()
public ShareFileDownloadHeaders setFileCreationTime(OffsetDateTime fileCreationTime)
fileCreationTime
- the fileCreationTime value to set.public OffsetDateTime getFileLastWriteTime()
public ShareFileDownloadHeaders setFileLastWriteTime(OffsetDateTime fileLastWriteTime)
fileLastWriteTime
- the fileLastWriteTime value to set.public OffsetDateTime getFileChangeTime()
public ShareFileDownloadHeaders setFileChangeTime(OffsetDateTime fileChangeTime)
fileChangeTime
- the fileChangeTime value to set.public String getFilePermissionKey()
public ShareFileDownloadHeaders setFilePermissionKey(String filePermissionKey)
filePermissionKey
- the filePermissionKey value to set.public String getFileId()
public ShareFileDownloadHeaders setFileId(String fileId)
fileId
- the fileId value to set.public String getFileParentId()
public ShareFileDownloadHeaders setFileParentId(String fileParentId)
fileParentId
- the fileParentId value to set.public LeaseDurationType getLeaseDuration()
public ShareFileDownloadHeaders setLeaseDuration(LeaseDurationType leaseDuration)
leaseDuration
- the leaseDuration value to set.public LeaseStateType getLeaseState()
public ShareFileDownloadHeaders setLeaseState(LeaseStateType leaseState)
leaseState
- the leaseState value to set.public LeaseStatusType getLeaseStatus()
public ShareFileDownloadHeaders setLeaseStatus(LeaseStatusType leaseStatus)
leaseStatus
- the leaseStatus value to set.public String getErrorCode()
public ShareFileDownloadHeaders setErrorCode(String errorCode)
errorCode
- the errorCode value to set.Copyright © 2020 Microsoft Corporation. All rights reserved.