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

export
implements

{BlobDownloadResponseModel}

Hierarchy

  • BlobDownloadResponse

Implements

Index

Constructors

constructor

Accessors

_response

acceptRanges

  • get acceptRanges(): string | undefined
  • Indicates that the service supports requests for partial file content.

    readonly
    memberof

    BlobDownloadResponse

    Returns string | undefined

blobCommittedBlockCount

  • get blobCommittedBlockCount(): number | undefined
  • The number of committed blocks present in the blob. This header is returned only for append blobs.

    readonly
    memberof

    BlobDownloadResponse

    Returns 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
    memberof

    BlobDownloadResponse

    Returns Uint8Array | undefined

blobSequenceNumber

  • get blobSequenceNumber(): number | undefined
  • The current sequence number for a page blob. This header is not returned for block blobs or append blobs.

    readonly
    memberof

    BlobDownloadResponse

    Returns number | undefined

blobType

  • The blob's type. Possible values include: 'BlockBlob', 'PageBlob', 'AppendBlob'.

    readonly
    memberof

    BlobDownloadResponse

    Returns BlobType | undefined

cacheControl

  • get cacheControl(): string | undefined
  • Returns if it was previously specified for the file.

    readonly
    memberof

    BlobDownloadResponse

    Returns string | undefined

clientRequestId

  • get clientRequestId(): string | undefined
  • If a client request id header is sent in the request, this header will be present in the response with the same value.

    readonly
    memberof

    BlobDownloadResponse

    Returns string | undefined

contentAsBlob

  • get contentAsBlob(): Promise<Blob> | undefined
  • The response body as a browser Blob. Always undefined in node.js.

    readonly
    memberof

    BlobDownloadResponse

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

    memberof

    BlobDownloadResponse

    Returns Uint8Array | undefined

contentDisposition

  • get contentDisposition(): string | undefined
  • Returns the value that was specified for the 'x-ms-content-disposition' header and specifies how to process the response.

    readonly
    memberof

    BlobDownloadResponse

    Returns string | undefined

contentEncoding

  • get contentEncoding(): string | undefined
  • Returns the value that was specified for the Content-Encoding request header.

    readonly
    memberof

    BlobDownloadResponse

    Returns string | undefined

contentLanguage

  • get contentLanguage(): string | undefined
  • Returns the value that was specified for the Content-Language request header.

    readonly
    memberof

    BlobDownloadResponse

    Returns string | undefined

contentLength

  • get contentLength(): number | undefined
  • The number of bytes present in the response body.

    readonly
    memberof

    BlobDownloadResponse

    Returns 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
    memberof

    BlobDownloadResponse

    Returns Uint8Array | undefined

contentRange

  • get contentRange(): string | undefined
  • Indicates the range of bytes returned if the client requested a subset of the file by setting the Range request header.

    readonly
    memberof

    BlobDownloadResponse

    Returns string | undefined

contentType

  • get contentType(): string | undefined
  • The content type specified for the file. The default content type is 'application/octet-stream'

    readonly
    memberof

    BlobDownloadResponse

    Returns 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
    memberof

    BlobDownloadResponse

    Returns Date | undefined

copyId

  • get copyId(): string | undefined
  • String identifier for the last attempted Copy File operation where this file was the destination file.

    readonly
    memberof

    BlobDownloadResponse

    Returns 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
    memberof

    BlobDownloadResponse

    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
    memberof

    BlobDownloadResponse

    Returns string | undefined

copyStatus

  • State of the copy operation identified by 'x-ms-copy-id'. Possible values include: 'pending', 'success', 'aborted', 'failed'

    readonly
    memberof

    BlobDownloadResponse

    Returns CopyStatusType | undefined

copyStatusDescription

  • get copyStatusDescription(): string | undefined
  • Only appears when x-ms-copy-status is failed or pending. Describes cause of fatal or non-fatal copy operation failure.

    readonly
    memberof

    BlobDownloadResponse

    Returns string | undefined

date

  • get date(): Date | undefined
  • A UTC date/time value generated by the service that indicates the time at which the response was initiated.

    readonly
    memberof

    BlobDownloadResponse

    Returns 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
    memberof

    BlobDownloadResponse

    Returns string | undefined

errorCode

  • get errorCode(): string | undefined

etag

  • get etag(): string | undefined
  • The ETag contains a value that you can use to perform operations conditionally, in quotes.

    readonly
    memberof

    BlobDownloadResponse

    Returns string | 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
    memberof

    BlobDownloadResponse

    Returns boolean | 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
    memberof

    BlobDownloadResponse

    Returns Date | undefined

leaseDuration

  • When a blob is leased, specifies whether the lease is of infinite or fixed duration. Possible values include: 'infinite', 'fixed'.

    readonly
    memberof

    BlobDownloadResponse

    Returns LeaseDurationType | undefined

leaseState

  • Lease state of the blob. Possible values include: 'available', 'leased', 'expired', 'breaking', 'broken'.

    readonly
    memberof

    BlobDownloadResponse

    Returns LeaseStateType | undefined

leaseStatus

metadata

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
    memberof

    BlobDownloadResponse

    Returns NodeJS.ReadableStream | undefined

requestId

  • get requestId(): string | undefined
  • This header uniquely identifies the request that was made and can be used for troubleshooting the request.

    readonly
    memberof

    BlobDownloadResponse

    Returns string | undefined

version

  • get version(): string | undefined
  • Indicates the version of the File service used to execute the request.

    readonly
    memberof

    BlobDownloadResponse

    Returns string | undefined

Generated using TypeDoc