Class BlobDownloadDetails

Details returned when downloading a Blob

Inheritance

BlobDownloadDetails

Namespace: Azure.Storage.Blobs.Models

Assembly: Azure.Storage.Blobs.dll

Syntax

public class BlobDownloadDetails

Constructors

BlobDownloadDetails()

Declaration

public BlobDownloadDetails ();

Properties

If the blob 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 blob'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

Declaration

public byte[] BlobContentHash { get; }

Property Value

Byte[]

BlobSequenceNumber

The current sequence number for a page blob. This header is not returned for block blobs or append blobs

Declaration

public long BlobSequenceNumber { get; }

Property Value

Int64

CacheControl

This header is returned if it was previously specified for the blob.

Declaration

public string CacheControl { get; }

Property Value

String

ContentDisposition

This header returns the value that was specified for the 'x-ms-blob-content-disposition' header. The Content-Disposition response header field conveys additional information about how to process the response payload, and also can be used to attach additional metadata. For example, if set to attachment, it indicates that the user-agent should not display the response, but instead show a Save As dialog with a filename other than the blob name specified.

Declaration

public string ContentDisposition { get; }

Property Value

String

ContentEncoding

This header returns the value that was specified for the Content-Encoding request header

Declaration

public string ContentEncoding { get; }

Property Value

String

ContentLanguage

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

Declaration

public string ContentLanguage { get; }

Property Value

String

ContentRange

Indicates the range of bytes returned in the event that the client requested a subset of the blob by setting the 'Range' request header.

Declaration

public string ContentRange { get; }

Property Value

String

CopyCompletedOn

Conclusion time of the last attempted Copy Blob operation where this blob was the destination blob. This value can specify the time of a completed, aborted, or failed copy attempt. This header does not appear if a copy is pending, if this blob has never been the destination in a Copy Blob operation, or if this blob has been modified after a concluded Copy Blob operation using Set Blob Properties, Put Blob, or Put Block List.

Declaration

public DateTimeOffset CopyCompletedOn { get; }

Property Value

DateTimeOffset

CopyId

String identifier for this copy operation. Use with Get Blob Properties to check the status of this copy operation, or pass to Abort Copy Blob to abort a pending copy.

Declaration

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 Blob operation where this blob was the destination blob. Can show between 0 and Content-Length bytes copied. This header does not appear if this blob has never been the destination in a Copy Blob operation, or if this blob has been modified after a concluded Copy Blob operation using Set Blob Properties, Put Blob, or Put Block List

Declaration

public string CopyProgress { get; }

Property Value

String

CopySource

URL up to 2 KB in length that specifies the source blob or file used in the last attempted Copy Blob operation where this blob was the destination blob. This header does not appear if this blob has never been the destination in a Copy Blob operation, or if this blob has been modified after a concluded Copy Blob operation using Set Blob Properties, Put Blob, or Put Block List.

Declaration

public Uri CopySource { get; }

Property Value

Uri

CopyStatus

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

Declaration

public Azure.Storage.Blobs.Models.CopyStatus CopyStatus { get; }

Property Value

CopyStatus

CopyStatusDescription

Only appears when x-ms-copy-status is failed or pending. Describes the cause of the last fatal or non-fatal copy operation failure. This header does not appear if this blob has never been the destination in a Copy Blob operation, or if this blob has been modified after a concluded Copy Blob operation using Set Blob Properties, Put Blob, or Put Block List

Declaration

public string CopyStatusDescription { get; }

Property Value

String

EncryptionKeySha256

The SHA-256 hash of the encryption key used to encrypt the blob. This header is only returned when the blob was encrypted with a customer-provided key.

Declaration

public string EncryptionKeySha256 { get; }

Property Value

String

ETag

The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes.

Declaration

public Azure.ETag ETag { get; }

Property Value

ETag

IsServerEncrypted

The value of this header is set to true if the blob data and application metadata are completely encrypted using the specified algorithm. Otherwise, the value is set to false (when the blob is unencrypted, or if only parts of the blob/application metadata are encrypted).

Declaration

public bool IsServerEncrypted { get; }

Property Value

Boolean

LastModified

Returns the date and time the container was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob.

Declaration

public DateTimeOffset LastModified { get; }

Property Value

DateTimeOffset

LeaseDuration

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

Declaration

public Azure.Storage.Blobs.Models.LeaseDurationType LeaseDuration { get; }

Property Value

LeaseDurationType

LeaseState

Lease state of the blob.

Declaration

public Azure.Storage.Blobs.Models.LeaseState LeaseState { get; }

Property Value

LeaseState

LeaseStatus

The current lease status of the blob.

Declaration

public Azure.Storage.Blobs.Models.LeaseStatus LeaseStatus { get; }

Property Value

LeaseStatus

Metadata

x-ms-meta

Declaration

public System.Collections.Generic.IDictionary<string,string> Metadata { get; }

Property Value

IDictionary<String,String>