FileDownloadHeaders interface

Package:

@azure/storage-file-share

Defines headers for File_download operation.

Properties

acceptRanges	Indicates that the service supports requests for partial file content.
cacheControl	Returned if it was previously specified for the file.
contentDisposition	Returns the value that was specified for the 'x-ms-content-disposition' header and specifies how to process the response.
contentEncoding	Returns the value that was specified for the Content-Encoding request header.
contentLanguage	Returns the value that was specified for the Content-Language request header.
contentLength	The number of bytes present in the response body.
contentMD5	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.
contentRange	Indicates the range of bytes returned if the client requested a subset of the file by setting the Range request header.
contentType	The content type specified for the file. The default content type is 'application/octet-stream'
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.
copyId	String identifier for the last attempted Copy File operation where this file was the destination file.
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.
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.
copyStatus	State of the copy operation identified by 'x-ms-copy-id'.
copyStatusDescription	Only appears when x-ms-copy-status is failed or pending. Describes cause of fatal or non-fatal copy operation failure.
date	A UTC date/time value generated by the service that indicates the time at which the response was initiated.
errorCode	Error Code
etag	The ETag contains a value that you can use to perform operations conditionally, in quotes.
fileAttributes	Attributes set for the file.
fileChangeOn	Change time for the file.
fileContentMD5	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.
fileCreatedOn	Creation time for the file.
fileId	The fileId of the file.
fileLastWriteOn	Last write time for the file.
fileParentId	The parent fileId of the file.
filePermissionKey	Key of the permission set for the file.
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).
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.
leaseDuration	When a file is leased, specifies whether the lease is of infinite or fixed duration.
leaseState	Lease state of the file.
leaseStatus	The current lease status of the file.
metadata	A set of name-value pairs associated with this file as user-defined metadata.
requestId	This header uniquely identifies the request that was made and can be used for troubleshooting the request.
version	Indicates the version of the File service used to execute the request.

Property Details

acceptRanges

Indicates that the service supports requests for partial file content.

acceptRanges?: string

Property Value

string

cacheControl

Returned if it was previously specified for the file.

cacheControl?: string

Property Value

string

contentDisposition

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

contentDisposition?: string

Property Value

string

contentEncoding

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

contentEncoding?: string

Property Value

string

contentLanguage

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

contentLanguage?: string

Property Value

string

contentLength

The number of bytes present in the response body.

contentLength?: number

Property Value

number

contentMD5

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.

contentMD5?: Uint8Array

Property Value

Uint8Array

contentRange

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

contentRange?: string

Property Value

string

contentType

The content type specified for the file. The default content type is 'application/octet-stream'

contentType?: string

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.

copyCompletedOn?: Date

Property Value

Date

copyId

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

copyId?: string

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.

copyProgress?: string

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.

copySource?: string

Property Value

string

copyStatus

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

copyStatus?: CopyStatusType

Property Value

CopyStatusType

copyStatusDescription

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

copyStatusDescription?: string

Property Value

string

date

A UTC date/time value generated by the service that indicates the time at which the response was initiated.

date?: Date

Property Value

Date

errorCode

Error Code

errorCode?: string

Property Value

string

etag

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

etag?: string

Property Value

string

fileAttributes

Attributes set for the file.

fileAttributes?: string

Property Value

string

fileChangeOn

Change time for the file.

fileChangeOn?: Date

Property Value

Date

fileContentMD5

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.

fileContentMD5?: Uint8Array

Property Value

Uint8Array

fileCreatedOn

Creation time for the file.

fileCreatedOn?: Date

Property Value

Date

fileId

The fileId of the file.

fileId?: string

Property Value

string

fileLastWriteOn

Last write time for the file.

fileLastWriteOn?: Date

Property Value

Date

fileParentId

The parent fileId of the file.

fileParentId?: string

Property Value

string

filePermissionKey

Key of the permission set for the file.

filePermissionKey?: string

Property Value

string

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

isServerEncrypted?: boolean

Property Value

boolean

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.

lastModified?: Date

Property Value

Date

leaseDuration

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

leaseDuration?: LeaseDurationType

Property Value

LeaseDurationType

leaseState

Lease state of the file.

leaseState?: LeaseStateType

Property Value

LeaseStateType

leaseStatus

The current lease status of the file.

leaseStatus?: LeaseStatusType

Property Value

LeaseStatusType

metadata

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

metadata?: {[propertyName: string]: string}

Property Value

{[propertyName: string]: string}

requestId

This header uniquely identifies the request that was made and can be used for troubleshooting the request.

requestId?: string

Property Value

string

version

Indicates the version of the File service used to execute the request.

version?: string

Property Value

string