Package version
Creates an instance of BlobDownloadResponse.
-
-
-
-
-
The HTTP response.
Indicates that the service supports requests for partial file content.
The number of committed blocks present in the blob. This header is returned only for append blobs.
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.
The current sequence number for a page blob. This header is not returned for block blobs or append blobs.
The blob's type. Possible values include: 'BlockBlob', 'PageBlob', 'AppendBlob'.
Returns if it was previously specified for the file.
If a client request id header is sent in the request, this header will be present in the response with the same value.
The response body as a browser Blob. Always undefined in node.js.
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 the value that was specified for the 'x-ms-content-disposition' header and specifies how to process the response.
Returns the value that was specified for the Content-Encoding request header.
Returns the value that was specified for the Content-Language request header.
The number of bytes present in the response body.
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.
Indicates the range of bytes returned if the client requested a subset of the file by setting the Range request header.
The content type specified for the file. The default content type is 'application/octet-stream'
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.
String identifier for the last attempted Copy File operation where this file was the destination file.
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.
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.
State of the copy operation identified by 'x-ms-copy-id'. Possible values include: 'pending', 'success', 'aborted', 'failed'
Only appears when x-ms-copy-status is failed or pending. Describes cause of fatal or non-fatal copy operation failure.
A UTC date/time value generated by the service that indicates the time at which the response was initiated.
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.
The error code.
The ETag contains a value that you can use to perform operations conditionally, in quotes.
UTC date/time value generated by the service that indicates the time at which the blob immutability policy will expire.
Indicates immutability policy mode.
Indicates whether version of this blob is a current version.
If this blob has been sealed.
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).
Returns the UTC date and time generated by the service that indicates the time at which the blob was last read or written to.
Returns the date and time the file was last modified. Any operation that modifies the file or its properties updates the last modified time.
When a blob is leased, specifies whether the lease is of infinite or fixed duration. Possible values include: 'infinite', 'fixed'.
Lease state of the blob. Possible values include: 'available', 'leased', 'expired', 'breaking', 'broken'.
The current lease status of the blob. Possible values include: 'locked', 'unlocked'.
Indicates if a legal hold is present on the blob.
A name-value pair to associate with a file storage object.
Object Replication Policy Id of the destination blob.
Parsed Object Replication Policy Id, Rule Id(s) and status of the source blob.
The response body as a node.js Readable stream. Always undefined in the browser.
It will automatically retry when internal read stream unexpected ends.
This header uniquely identifies the request that was made and can be used for troubleshooting the request.
The number of tags associated with the blob
Indicates the version of the Blob service used to execute the request.
Indicates the versionId of the downloaded blob version.
Generated using TypeDoc
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.