Class ShareFileDownloadDetails

Namespace

Azure.Storage.Files.Shares.Models

Assembly

Azure.Storage.Files.Shares.dll

Details returned when downloading a File

public class ShareFileDownloadDetails

Inheritance

object

ShareFileDownloadDetails

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Properties

AcceptRanges

Indicates that the service supports requests for partial file content.

public string AcceptRanges { get; }

Property Value

string

CacheControl

Returned if it was previously specified for the file.

public string CacheControl { get; }

Property Value

string

ContentDisposition

Returns the value that was specified for the 'x-ms-content-disposition' header and specifies how to process the response.

public string ContentDisposition { get; }

Property Value

string

ContentEncoding

Returns the value that was specified for the Content-Encoding request header.

public IEnumerable<string> ContentEncoding { get; }

Property Value

IEnumerable<string>

ContentLanguage

Returns the value that was specified for the Content-Language request header.

public IEnumerable<string> ContentLanguage { get; }

Property Value

IEnumerable<string>

ContentRange

Indicates the range of bytes returned if the client requested a subset of the file by setting the Range request header.

The format of the Content-Range is expected to comeback in the following format. [unit] [start]-[end]/[fileSize] (e.g. bytes 1024-3071/10240)

The [end] value will be the inclusive last byte (e.g. header "bytes 0-7/8" is the entire 8-byte file).

public string ContentRange { get; }

Property Value

string

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.

public DateTimeOffset CopyCompletedOn { get; }

Property Value

DateTimeOffset

CopyId

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

public string CopyId { get; }

Property Value

string

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.

public string CopyProgress { get; }

Property Value

string

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.

public Uri CopySource { get; }

Property Value

Uri

CopyStatus

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

public CopyStatus CopyStatus { get; }

Property Value

CopyStatus

CopyStatusDescription

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

public string CopyStatusDescription { get; }

Property Value

string

ETag

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

public ETag ETag { get; }

Property Value

ETag

FileContentHash

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.

public byte[] FileContentHash { get; }

Property Value

byte[]

IsServerEncrypted

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

public bool IsServerEncrypted { get; }

Property Value

bool

LastModified

Returns the date and time the file was last modified. Any operation that modifies the file or its properties updates the last modified time.

public DateTimeOffset LastModified { get; }

Property Value

DateTimeOffset

LeaseDuration

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

public ShareLeaseDuration LeaseDuration { get; }

Property Value

ShareLeaseDuration

LeaseState

Lease state of the file.

public ShareLeaseState LeaseState { get; }

Property Value

ShareLeaseState

LeaseStatus

The current lease status of the file.

public ShareLeaseStatus LeaseStatus { get; }

Property Value

ShareLeaseStatus

Metadata

A set of name-value pairs associated with this file as user-defined metadata.

public IDictionary<string, string> Metadata { get; }

Property Value

IDictionary<string, string>

SmbProperties

The SMB properties for the file

public FileSmbProperties SmbProperties { get; set; }

Property Value

FileSmbProperties