Package com.azure.storage.file.share.models

Class ShareFileDownloadHeaders

java.lang.Object
com.azure.storage.file.share.models.ShareFileDownloadHeaders
public final class ShareFileDownloadHeaders extends Object
Defines headers for Download operation.

  • Constructor Details

    • ShareFileDownloadHeaders

      public ShareFileDownloadHeaders()

  • Method Details

    • getLastModified

      public OffsetDateTime getLastModified()
      Get the lastModified property: Returns the date and time the file was last modified. Any operation that modifies the file or its properties updates the last modified time.
      Returns:
      the lastModified value.

    • setLastModified

      public ShareFileDownloadHeaders setLastModified(OffsetDateTime lastModified)
      Set the lastModified property: Returns the date and time the file was last modified. Any operation that modifies the file or its properties updates the last modified time.
      Parameters:
      lastModified - the lastModified value to set.
      Returns:
      the ShareFileDownloadHeaders object itself.

    • getMetadata

      public Map<String,String> getMetadata()
      Get the metadata property: The metadata property.
      Returns:
      the metadata value.

    • setMetadata

      public ShareFileDownloadHeaders setMetadata(Map<String,String> metadata)
      Set the metadata property: The metadata property.
      Parameters:
      metadata - the metadata value to set.
      Returns:
      the ShareFileDownloadHeaders 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 ShareFileDownloadHeaders 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 ShareFileDownloadHeaders object itself.

    • getContentType

      public String getContentType()
      Get the contentType property: The content type specified for the file. The default content type is 'application/octet-stream'.
      Returns:
      the contentType value.

    • setContentType

      public ShareFileDownloadHeaders setContentType(String contentType)
      Set the contentType property: The content type specified for the file. The default content type is 'application/octet-stream'.
      Parameters:
      contentType - the contentType value to set.
      Returns:
      the ShareFileDownloadHeaders object itself.

    • getContentRange

      public 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.
      Returns:
      the contentRange value.

    • setContentRange

      public 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.
      Parameters:
      contentRange - the contentRange value to set.
      Returns:
      the ShareFileDownloadHeaders object itself.

    • getETag

      public String getETag()
      Get the eTag property: The ETag contains a value that you can use to perform operations conditionally, in quotes.
      Returns:
      the eTag value.

    • setETag

      public ShareFileDownloadHeaders setETag(String eTag)
      Set the eTag property: The ETag contains a value that you can use to perform operations conditionally, in quotes.
      Parameters:
      eTag - the eTag value to set.
      Returns:
      the ShareFileDownloadHeaders object itself.

    • getContentMd5

      public 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. If the request is to read a specified range and the 'x-ms-range-get-content-md5' is set to true, then the request returns an MD5 hash for the range, as long as the range size is less than or equal to 4 MB. If neither of these sets of conditions is true, then no value is returned for the 'Content-MD5' header.
      Returns:
      the contentMd5 value.

    • setContentMd5

      public 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. If the request is to read a specified range and the 'x-ms-range-get-content-md5' is set to true, then the request returns an MD5 hash for the range, as long as the range size is less than or equal to 4 MB. If neither of these sets of conditions is true, then no value is returned for the 'Content-MD5' header.
      Parameters:
      contentMd5 - the contentMd5 value to set.
      Returns:
      the ShareFileDownloadHeaders object itself.

    • getContentEncoding

      public String getContentEncoding()
      Get the contentEncoding property: Returns the value that was specified for the Content-Encoding request header.
      Returns:
      the contentEncoding value.

    • setContentEncoding

      public ShareFileDownloadHeaders setContentEncoding(String contentEncoding)
      Set the contentEncoding property: Returns the value that was specified for the Content-Encoding request header.
      Parameters:
      contentEncoding - the contentEncoding value to set.
      Returns:
      the ShareFileDownloadHeaders object itself.

    • getCacheControl

      public String getCacheControl()
      Get the cacheControl property: Returned if it was previously specified for the file.
      Returns:
      the cacheControl value.

    • setCacheControl

      public ShareFileDownloadHeaders setCacheControl(String cacheControl)
      Set the cacheControl property: Returned if it was previously specified for the file.
      Parameters:
      cacheControl - the cacheControl value to set.
      Returns:
      the ShareFileDownloadHeaders object itself.

    • getContentDisposition

      public 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.
      Returns:
      the contentDisposition value.

    • setContentDisposition

      public 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.
      Parameters:
      contentDisposition - the contentDisposition value to set.
      Returns:
      the ShareFileDownloadHeaders object itself.

    • getContentLanguage

      public String getContentLanguage()
      Get the contentLanguage property: Returns the value that was specified for the Content-Language request header.
      Returns:
      the contentLanguage value.

    • setContentLanguage

      public ShareFileDownloadHeaders setContentLanguage(String contentLanguage)
      Set the contentLanguage property: Returns the value that was specified for the Content-Language request header.
      Parameters:
      contentLanguage - the contentLanguage value to set.
      Returns:
      the ShareFileDownloadHeaders 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 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.
      Parameters:
      requestId - the requestId value to set.
      Returns:
      the ShareFileDownloadHeaders object itself.

    • getVersion

      public String getVersion()
      Get the version property: Indicates the version of the File service used to execute the request.
      Returns:
      the version value.

    • setVersion

      public ShareFileDownloadHeaders setVersion(String version)
      Set the version property: Indicates the version of the File service used to execute the request.
      Parameters:
      version - the version value to set.
      Returns:
      the ShareFileDownloadHeaders object itself.

    • getAcceptRanges

      public String getAcceptRanges()
      Get the acceptRanges property: Indicates that the service supports requests for partial file content.
      Returns:
      the acceptRanges value.

    • setAcceptRanges

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

    • getDateProperty

      public 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.
      Returns:
      the dateProperty value.

    • setDateProperty

      public 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.
      Parameters:
      dateProperty - the dateProperty value to set.
      Returns:
      the ShareFileDownloadHeaders object itself.

    • getCopyCompletionTime

      public OffsetDateTime getCopyCompletionTime()
      Get the copyCompletionTime property: Conclusion time of the last attempted Copy File operation where this file was the destination file. This value can specify the time of a completed, aborted, or failed copy attempt.
      Returns:
      the copyCompletionTime value.

    • setCopyCompletionTime

      public ShareFileDownloadHeaders setCopyCompletionTime(OffsetDateTime copyCompletionTime)
      Set the copyCompletionTime property: Conclusion time of the last attempted Copy File operation where this file was the destination file. This value can specify the time of a completed, aborted, or failed copy attempt.
      Parameters:
      copyCompletionTime - the copyCompletionTime value to set.
      Returns:
      the ShareFileDownloadHeaders object itself.

    • getCopyStatusDescription

      public String getCopyStatusDescription()
      Get the copyStatusDescription property: Only appears when x-ms-copy-status is failed or pending. Describes cause of fatal or non-fatal copy operation failure.
      Returns:
      the copyStatusDescription value.

    • setCopyStatusDescription

      public ShareFileDownloadHeaders setCopyStatusDescription(String copyStatusDescription)
      Set the copyStatusDescription property: Only appears when x-ms-copy-status is failed or pending. Describes cause of fatal or non-fatal copy operation failure.
      Parameters:
      copyStatusDescription - the copyStatusDescription value to set.
      Returns:
      the ShareFileDownloadHeaders object itself.

    • getCopyId

      public String getCopyId()
      Get the copyId property: String identifier for the last attempted Copy File operation where this file was the destination file.
      Returns:
      the copyId value.

    • setCopyId

      public ShareFileDownloadHeaders setCopyId(String copyId)
      Set the copyId property: String identifier for the last attempted Copy File operation where this file was the destination file.
      Parameters:
      copyId - the copyId value to set.
      Returns:
      the ShareFileDownloadHeaders 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 File operation where this file was the destination file. Can show between 0 and Content-Length bytes copied.
      Returns:
      the copyProgress value.

    • setCopyProgress

      public 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. Can show between 0 and Content-Length bytes copied.
      Parameters:
      copyProgress - the copyProgress value to set.
      Returns:
      the ShareFileDownloadHeaders object itself.

    • getCopySource

      public 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.
      Returns:
      the copySource value.

    • setCopySource

      public 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.
      Parameters:
      copySource - the copySource value to set.
      Returns:
      the ShareFileDownloadHeaders 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 ShareFileDownloadHeaders 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 ShareFileDownloadHeaders 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

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

    • 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.

    • setIsServerEncrypted

      public 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. Otherwise, the value is set to false (when the file is unencrypted, or if only parts of the file/application metadata are encrypted).
      Parameters:
      isServerEncrypted - the isServerEncrypted value to set.
      Returns:
      the ShareFileDownloadHeaders object itself.

    • getFileAttributes

      public String getFileAttributes()
      Get the fileAttributes property: Attributes set for the file.
      Returns:
      the fileAttributes value.

    • setFileAttributes

      public ShareFileDownloadHeaders setFileAttributes(String fileAttributes)
      Set the fileAttributes property: Attributes set for the file.
      Parameters:
      fileAttributes - the fileAttributes value to set.
      Returns:
      the ShareFileDownloadHeaders object itself.

    • getFileCreationTime

      public OffsetDateTime getFileCreationTime()
      Get the fileCreationTime property: Creation time for the file.
      Returns:
      the fileCreationTime value.

    • setFileCreationTime

      public ShareFileDownloadHeaders setFileCreationTime(OffsetDateTime fileCreationTime)
      Set the fileCreationTime property: Creation time for the file.
      Parameters:
      fileCreationTime - the fileCreationTime value to set.
      Returns:
      the ShareFileDownloadHeaders object itself.

    • getFileLastWriteTime

      public OffsetDateTime getFileLastWriteTime()
      Get the fileLastWriteTime property: Last write time for the file.
      Returns:
      the fileLastWriteTime value.

    • setFileLastWriteTime

      public ShareFileDownloadHeaders setFileLastWriteTime(OffsetDateTime fileLastWriteTime)
      Set the fileLastWriteTime property: Last write time for the file.
      Parameters:
      fileLastWriteTime - the fileLastWriteTime value to set.
      Returns:
      the ShareFileDownloadHeaders object itself.

    • getFileChangeTime

      public OffsetDateTime getFileChangeTime()
      Get the fileChangeTime property: Change time for the file.
      Returns:
      the fileChangeTime value.

    • setFileChangeTime

      public ShareFileDownloadHeaders setFileChangeTime(OffsetDateTime fileChangeTime)
      Set the fileChangeTime property: Change time for the file.
      Parameters:
      fileChangeTime - the fileChangeTime value to set.
      Returns:
      the ShareFileDownloadHeaders object itself.

    • getFilePermissionKey

      public String getFilePermissionKey()
      Get the filePermissionKey property: Key of the permission set for the file.
      Returns:
      the filePermissionKey value.

    • setFilePermissionKey

      public ShareFileDownloadHeaders setFilePermissionKey(String filePermissionKey)
      Set the filePermissionKey property: Key of the permission set for the file.
      Parameters:
      filePermissionKey - the filePermissionKey value to set.
      Returns:
      the ShareFileDownloadHeaders object itself.

    • getFileId

      public String getFileId()
      Get the fileId property: The fileId of the file.
      Returns:
      the fileId value.

    • setFileId

      public ShareFileDownloadHeaders setFileId(String fileId)
      Set the fileId property: The fileId of the file.
      Parameters:
      fileId - the fileId value to set.
      Returns:
      the ShareFileDownloadHeaders object itself.

    • getFileParentId

      public String getFileParentId()
      Get the fileParentId property: The parent fileId of the file.
      Returns:
      the fileParentId value.

    • setFileParentId

      public ShareFileDownloadHeaders setFileParentId(String fileParentId)
      Set the fileParentId property: The parent fileId of the file.
      Parameters:
      fileParentId - the fileParentId value to set.
      Returns:
      the ShareFileDownloadHeaders object itself.

    • 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.

    • setLeaseDuration

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

    • 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.

    • setLeaseState

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

    • getLeaseStatus

      public LeaseStatusType getLeaseStatus()
      Get the leaseStatus property: The current lease status of the file. Possible values include: 'locked', 'unlocked'.
      Returns:
      the leaseStatus value.

    • setLeaseStatus

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

    • getErrorCode

      public String getErrorCode()
      Get the errorCode property: The errorCode property.
      Returns:
      the errorCode value.

    • setErrorCode

      public ShareFileDownloadHeaders setErrorCode(String errorCode)
      Set the errorCode property: The errorCode property.
      Parameters:
      errorCode - the errorCode value to set.
      Returns:
      the ShareFileDownloadHeaders object itself.