Class ShareFileProperties
java.lang.Object
com.azure.storage.file.share.models.ShareFileProperties
Contains property information about a File in the storage File service.
-
Constructor Summary
ConstructorDescriptionShareFileProperties
(String eTag, OffsetDateTime lastModified, Map<String, String> metadata, String fileType, Long contentLength, String contentType, byte[] contentMd5, String contentEncoding, String cacheControl, String contentDisposition, LeaseStatusType leaseStatusType, LeaseStateType leaseStateType, LeaseDurationType leaseDurationType, OffsetDateTime copyCompletionTime, String copyStatusDescription, String copyId, String copyProgress, String copySource, CopyStatusType copyStatus, Boolean isServerEncrypted, FileSmbProperties smbProperties) Creates an instance of property information about a specific File.ShareFileProperties
(String eTag, OffsetDateTime lastModified, Map<String, String> metadata, String fileType, Long contentLength, String contentType, byte[] contentMd5, String contentEncoding, String cacheControl, String contentDisposition, OffsetDateTime copyCompletionTime, String copyStatusDescription, String copyId, String copyProgress, String copySource, CopyStatusType copyStatus, Boolean isServerEncrypted, FileSmbProperties smbProperties) Creates an instance of property information about a specific File. -
Method Summary
-
Constructor Details
-
Method Details
-
getETag
- Returns:
- Entity tag that corresponds to the directory.
-
getLastModified
- Returns:
- Last time the directory was modified.
-
getMetadata
- Returns:
- A set of name-value pairs associated with this file as user-defined metadata.
-
getContentLength
- Returns:
- The number of bytes present in the response body.
-
getFileType
- Returns:
- The type of the file.
-
getContentType
- Returns:
- The content type specified for the file. The default content type is application/octet-stream.
-
getContentMd5
public byte[] getContentMd5()- Returns:
- The MD5 hash of the file.
-
getContentEncoding
- Returns:
- The value that was specified for the Content-Encoding request header.
-
getCacheControl
- Returns:
- This header is returned if it was previously specified for the file.
-
getContentDisposition
- Returns:
- The value that was specified for the x-ms-content-disposition header and specifies how to process the response.
-
getLeaseStatus
- Returns:
- the lease status of the file
-
getLeaseState
- Returns:
- the lease state of the file
-
getLeaseDuration
- Returns:
- the lease duration if the file is leased
-
getCopyCompletionTime
- Returns:
- Conclusion time of the last attempted Copy File operation where this file was the destination file.
-
getCopyStatusDescription
- Returns:
- When x-ms-copy-status is failed or pending. Describes cause of fatal or non-fatal copy operation failure.
-
getCopyId
- Returns:
- String identifier for the last attempted Copy File operation where this file was the destination file.
-
getCopyProgress
- Returns:
- 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.
-
getCopySource
- Returns:
- 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.
-
getCopyStatus
- Returns:
- State of the copy operation identified by x-ms-copy-id, with these values: - success: Copy completed successfully. - pending: Copy is in progress. Check x-ms-copy-status-description if intermittent, non-fatal errors impede copy progress but don't cause failure. - aborted: Copy was ended by Abort Copy File. - failed: Copy failed. See x-ms-copy-status-description for failure details.
-
isServerEncrypted
- Returns:
- True if the file data and application metadata are completely encrypted using the specified algorithm. Otherwise, return false.
-
getSmbProperties
- Returns:
- The SMB properties of the file.
-