azure-storage-files-shares
Public Attributes | List of all members
Azure::Storage::Files::Shares::Models::FileProperties Struct Referencefinal

The serialized return result for operation: GetFileProperties.

#include <share_rest_client.hpp>

Public Attributes

DateTime LastModified
 
Storage::Metadata Metadata
 
int64_t FileSize = int64_t()
 
FileHttpHeaders HttpHeaders
 
Azure::ETag ETag
 
Azure::Nullable< DateTime > CopyCompletedOn
 
Azure::Nullable< std::string > CopyStatusDescription
 
Azure::Nullable< std::string > CopyId
 
Azure::Nullable< std::string > CopyProgress
 
Azure::Nullable< std::string > CopySource
 
Azure::Nullable< Models::CopyStatusCopyStatus
 
bool IsServerEncrypted = bool()
 
FileSmbProperties SmbProperties
 
Azure::Nullable< Models::LeaseDurationLeaseDuration
 
Azure::Nullable< Models::LeaseStateLeaseState
 
Azure::Nullable< Models::LeaseStatusLeaseStatus
 

Member Data Documentation

◆ CopyCompletedOn

Azure::Nullable<DateTime> Azure::Storage::Files::Shares::Models::FileProperties::CopyCompletedOn

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.

◆ CopyId

Azure::Nullable<std::string> Azure::Storage::Files::Shares::Models::FileProperties::CopyId

String identifier for the last attempted Copy File operation where this file was the destination file.

◆ CopyProgress

Azure::Nullable<std::string> Azure::Storage::Files::Shares::Models::FileProperties::CopyProgress

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.

◆ CopySource

Azure::Nullable<std::string> Azure::Storage::Files::Shares::Models::FileProperties::CopySource

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.

◆ CopyStatus

Azure::Nullable<Models::CopyStatus> Azure::Storage::Files::Shares::Models::FileProperties::CopyStatus

State of the copy operation identified by 'x-ms-copy-id'.

◆ CopyStatusDescription

Azure::Nullable<std::string> Azure::Storage::Files::Shares::Models::FileProperties::CopyStatusDescription

Only appears when x-ms-copy-status is failed or pending. Describes cause of fatal or non-fatal copy operation failure.

◆ ETag

Azure::ETag Azure::Storage::Files::Shares::Models::FileProperties::ETag

The ETag contains a value that you can use to perform operations conditionally, in quotes.

◆ FileSize

int64_t Azure::Storage::Files::Shares::Models::FileProperties::FileSize = int64_t()

The size of the file in bytes. This header returns the value of the 'x-ms-content-length' header that is stored with the file.

◆ HttpHeaders

FileHttpHeaders Azure::Storage::Files::Shares::Models::FileProperties::HttpHeaders

The HTTP headers of the object.

◆ IsServerEncrypted

bool Azure::Storage::Files::Shares::Models::FileProperties::IsServerEncrypted = bool()

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

◆ LastModified

DateTime Azure::Storage::Files::Shares::Models::FileProperties::LastModified

Returns the date and time the file was last modified. The date format follows RFC 1123. Any operation that modifies the file or its properties updates the last modified time.

◆ LeaseDuration

Azure::Nullable<Models::LeaseDuration> Azure::Storage::Files::Shares::Models::FileProperties::LeaseDuration

When a file or share is leased, specifies whether the lease is of infinite or fixed duration.

◆ LeaseState

Azure::Nullable<Models::LeaseState> Azure::Storage::Files::Shares::Models::FileProperties::LeaseState

Lease state of the file or share.

◆ LeaseStatus

Azure::Nullable<Models::LeaseStatus> Azure::Storage::Files::Shares::Models::FileProperties::LeaseStatus

The current lease status of the file or share.

◆ Metadata

Storage::Metadata Azure::Storage::Files::Shares::Models::FileProperties::Metadata

The metadata of the object.

◆ SmbProperties

FileSmbProperties Azure::Storage::Files::Shares::Models::FileProperties::SmbProperties

The SMB related properties of the file or directory.


The documentation for this struct was generated from the following file: