Options
All
  • Public
  • Public/Protected
  • All
Menu

Class BlobDownloadResponse

Package version

Contains response data for the download operation. ONLY AVAILABLE IN NODE.JS RUNTIME.

BlobDownloadResponse implements BlobDownloadResponseParsed interface, and in Node.js runtime it will automatically retry when internal read stream unexpected ends. (This kind of unexpected ends cannot trigger retries defined in pipeline retry policy.)

The readableStreamBody stream will retry underlayer, you can just use it as a normal Node.js Readable stream.

Hierarchy

  • BlobDownloadResponse

Implements

Index

Constructors

constructor

Accessors

_response

acceptRanges

  • get acceptRanges(): string | undefined

blobCommittedBlockCount

  • get blobCommittedBlockCount(): number | undefined

blobContentMD5

  • get blobContentMD5(): Uint8Array | undefined
  • 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.

    readonly

    Returns Uint8Array | undefined

blobSequenceNumber

  • get blobSequenceNumber(): number | undefined

blobType

cacheControl

  • get cacheControl(): string | undefined

clientRequestId

  • get clientRequestId(): string | undefined

contentAsBlob

  • get contentAsBlob(): Promise<Blob> | undefined

contentCrc64

  • get contentCrc64(): Uint8Array | undefined
  • If the request is to read a specified range and the x-ms-range-get-content-crc64 is set to true, then the request returns a crc64 for the range, as long as the range size is less than or equal to 4 MB. If both x-ms-range-get-content-crc64 & x-ms-range-get-content-md5 is specified in the same request, it will fail with 400(Bad Request)

    Returns Uint8Array | undefined

contentDisposition

  • get contentDisposition(): string | undefined

contentEncoding

  • get contentEncoding(): string | undefined

contentLanguage

  • get contentLanguage(): string | undefined

contentLength

  • get contentLength(): number | undefined

contentMD5

  • get contentMD5(): Uint8Array | undefined
  • 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.

    readonly

    Returns Uint8Array | undefined

contentRange

  • get contentRange(): string | undefined

contentType

  • get contentType(): string | undefined

copyCompletedOn

  • get copyCompletedOn(): Date | undefined
  • 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.

    readonly

    Returns Date | undefined

copyId

  • get copyId(): string | undefined

copyProgress

  • get copyProgress(): string | undefined
  • 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.

    readonly

    Returns string | undefined

copySource

  • get copySource(): string | undefined
  • 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.

    readonly

    Returns string | undefined

copyStatus

copyStatusDescription

  • get copyStatusDescription(): string | undefined

date

  • get date(): Date | undefined

encryptionKeySha256

  • get encryptionKeySha256(): string | undefined
  • The SHA-256 hash of the encryption key used to encrypt the blob. This value is only returned when the blob was encrypted with a customer-provided key.

    readonly

    Returns string | undefined

errorCode

  • get errorCode(): string | undefined

etag

  • get etag(): string | undefined

immutabilityPolicyExpiresOn

  • get immutabilityPolicyExpiresOn(): Date | undefined

immutabilityPolicyMode

isCurrentVersion

  • get isCurrentVersion(): boolean | undefined

isSealed

  • get isSealed(): boolean | undefined

isServerEncrypted

  • get isServerEncrypted(): boolean | undefined
  • 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).

    readonly

    Returns boolean | undefined

lastAccessed

  • get lastAccessed(): Date | undefined

lastModified

  • get lastModified(): Date | undefined
  • Returns the date and time the file was last modified. Any operation that modifies the file or its properties updates the last modified time.

    readonly

    Returns Date | undefined

leaseDuration

leaseState

leaseStatus

legalHold

  • get legalHold(): boolean | undefined

metadata

objectReplicationDestinationPolicyId

  • get objectReplicationDestinationPolicyId(): string | undefined

objectReplicationSourceProperties

readableStreamBody

  • get readableStreamBody(): NodeJS.ReadableStream | undefined
  • The response body as a node.js Readable stream. Always undefined in the browser.

    It will automatically retry when internal read stream unexpected ends.

    readonly

    Returns NodeJS.ReadableStream | undefined

requestId

  • get requestId(): string | undefined

tagCount

  • get tagCount(): number | undefined

version

  • get version(): string | undefined

versionId

  • get versionId(): string | undefined

Generated using TypeDoc