FileDownloadHeaders interface

Paquete:

@azure/storage-file

Define encabezados para la operación de descarga.

Propiedades

acceptRanges	Indica que el servicio admite solicitudes de contenido parcial de archivos.
cacheControl	Se devuelve si se especificó anteriormente para el archivo.
contentDisposition	Devuelve el valor especificado para el encabezado "x-ms-content-disposition" y especifica cómo procesar la respuesta.
contentEncoding	Devuelve el valor especificado para el encabezado de solicitud Content-Encoding.
contentLanguage	Devuelve el valor especificado para el encabezado de solicitud Content-Language.
contentLength	Número de bytes presentes en el cuerpo de la respuesta.
contentMD5	Si el archivo tiene un hash MD5 y la solicitud es leer el archivo completo, se devuelve este encabezado de respuesta para que el cliente pueda comprobar la integridad del contenido del mensaje. Si la solicitud es leer un intervalo especificado y "x-ms-range-get-content-md5" se establece en true, la solicitud devuelve un hash MD5 para el intervalo, siempre y cuando el tamaño del intervalo sea menor o igual que 4 MB. Si ninguno de estos conjuntos de condiciones es true, no se devuelve ningún valor para el encabezado "Content-MD5".
contentRange	Indica el intervalo de bytes devuelto si el cliente solicitó un subconjunto del archivo estableciendo el encabezado de solicitud Range.
contentType	Tipo de contenido especificado para el archivo. El tipo de contenido predeterminado es "application/octet-stream"
copyCompletionTime	Hora de conclusión del último intento de operación Copiar archivo donde este archivo era el archivo de destino. Este valor puede especificar la hora de un intento de copia completado, anulado o erróneo.
copyId	Identificador de cadena para la última operación de copiar archivo en la que este archivo era el archivo de destino.
copyProgress	Contiene el número de bytes copiados y el total de bytes del origen en la última operación de copiar archivo en la que este archivo era el archivo de destino. Puede mostrar entre 0 y bytes de longitud de contenido copiados.
copySource	Dirección URL de hasta 2 KB de longitud que especifica el archivo de origen usado en la última operación de copiar archivo en la que este archivo era el archivo de destino.
copyStatus	Estado de la operación de copia identificada por "x-ms-copy-id". Entre los valores posibles se incluyen: 'pendiente', 'success', 'aborted', 'failed'
copyStatusDescription	Solo aparece cuando x-ms-copy-status se produce un error o está pendiente. Describe la causa del error irrecuperable o no grave de la operación de copia.
date	Valor de fecha y hora UTC generado por el servicio que indica la hora en la que se inició la respuesta.
errorCode
eTag	La ETag contiene un valor que puede usar para realizar operaciones condicionalmente, entre comillas.
fileAttributes	Atributos establecidos para el archivo.
fileChangeTime	Cambiar la hora del archivo.
fileContentMD5	Si el archivo tiene un hash MD5 y, si la solicitud contiene el encabezado de intervalo (Range o x-ms-range), este encabezado de respuesta se devuelve con el valor del valor MD5 del archivo completo. Este valor puede o no ser igual al valor devuelto en el encabezado Content-MD5, con el último calculado a partir del intervalo solicitado.
fileCreationTime	Hora de creación del archivo.
fileId	FileId del archivo.
fileLastWriteTime	Hora de última escritura del archivo.
fileParentId	FileId primario del archivo.
filePermissionKey	Clave del conjunto de permisos para el archivo.
isServerEncrypted	El valor de este encabezado se establece en true si los datos de archivo y los metadatos de la aplicación se cifran completamente mediante el algoritmo especificado. De lo contrario, el valor se establece en false (cuando el archivo está sin cifrar o si solo se cifran partes de los metadatos de archivo o aplicación).
lastModified	Devuelve la fecha y hora en que se modificó por última vez el archivo. Cualquier operación que modifique el archivo o sus propiedades actualiza la hora de la última modificación.
metadata
requestId	Este encabezado identifica de forma única la solicitud realizada y se puede usar para solucionar problemas de la solicitud.
version	Indica la versión del servicio File usado para ejecutar la solicitud.

Detalles de las propiedades

acceptRanges

Indica que el servicio admite solicitudes de contenido parcial de archivos.

acceptRanges?: undefined | string

Valor de propiedad

undefined | string

cacheControl

Se devuelve si se especificó anteriormente para el archivo.

cacheControl?: undefined | string

Valor de propiedad

undefined | string

contentDisposition

Devuelve el valor especificado para el encabezado "x-ms-content-disposition" y especifica cómo procesar la respuesta.

contentDisposition?: undefined | string

Valor de propiedad

undefined | string

contentEncoding

Devuelve el valor especificado para el encabezado de solicitud Content-Encoding.

contentEncoding?: undefined | string

Valor de propiedad

undefined | string

contentLanguage

Devuelve el valor especificado para el encabezado de solicitud Content-Language.

contentLanguage?: undefined | string

Valor de propiedad

undefined | string

contentLength

Número de bytes presentes en el cuerpo de la respuesta.

contentLength?: undefined | number

Valor de propiedad

undefined | number

contentMD5

Si el archivo tiene un hash MD5 y la solicitud es leer el archivo completo, se devuelve este encabezado de respuesta para que el cliente pueda comprobar la integridad del contenido del mensaje. Si la solicitud es leer un intervalo especificado y "x-ms-range-get-content-md5" se establece en true, la solicitud devuelve un hash MD5 para el intervalo, siempre y cuando el tamaño del intervalo sea menor o igual que 4 MB. Si ninguno de estos conjuntos de condiciones es true, no se devuelve ningún valor para el encabezado "Content-MD5".

contentMD5?: Uint8Array

Valor de propiedad

Uint8Array

contentRange

Indica el intervalo de bytes devuelto si el cliente solicitó un subconjunto del archivo estableciendo el encabezado de solicitud Range.

contentRange?: undefined | string

Valor de propiedad

undefined | string

contentType

Tipo de contenido especificado para el archivo. El tipo de contenido predeterminado es "application/octet-stream"

contentType?: undefined | string

Valor de propiedad

undefined | string

copyCompletionTime

Hora de conclusión del último intento de operación Copiar archivo donde este archivo era el archivo de destino. Este valor puede especificar la hora de un intento de copia completado, anulado o erróneo.

copyCompletionTime?: Date

Valor de propiedad

Date

copyId

Identificador de cadena para la última operación de copiar archivo en la que este archivo era el archivo de destino.

copyId?: undefined | string

Valor de propiedad

undefined | string

copyProgress

Contiene el número de bytes copiados y el total de bytes del origen en la última operación de copiar archivo en la que este archivo era el archivo de destino. Puede mostrar entre 0 y bytes de longitud de contenido copiados.

copyProgress?: undefined | string

Valor de propiedad

undefined | string

copySource

Dirección URL de hasta 2 KB de longitud que especifica el archivo de origen usado en la última operación de copiar archivo en la que este archivo era el archivo de destino.

copySource?: undefined | string

Valor de propiedad

undefined | string

copyStatus

Estado de la operación de copia identificada por "x-ms-copy-id". Entre los valores posibles se incluyen: 'pendiente', 'success', 'aborted', 'failed'

copyStatus?: CopyStatusType

Valor de propiedad

CopyStatusType

copyStatusDescription

Solo aparece cuando x-ms-copy-status se produce un error o está pendiente. Describe la causa del error irrecuperable o no grave de la operación de copia.

copyStatusDescription?: undefined | string

Valor de propiedad

undefined | string

date

Valor de fecha y hora UTC generado por el servicio que indica la hora en la que se inició la respuesta.

date?: Date

Valor de propiedad

Date

errorCode

errorCode?: undefined | string

Valor de propiedad

undefined | string

eTag

La ETag contiene un valor que puede usar para realizar operaciones condicionalmente, entre comillas.

eTag?: undefined | string

Valor de propiedad

undefined | string

fileAttributes

Atributos establecidos para el archivo.

fileAttributes?: undefined | string

Valor de propiedad

undefined | string

fileChangeTime

Cambiar la hora del archivo.

fileChangeTime?: Date

Valor de propiedad

Date

fileContentMD5

Si el archivo tiene un hash MD5 y, si la solicitud contiene el encabezado de intervalo (Range o x-ms-range), este encabezado de respuesta se devuelve con el valor del valor MD5 del archivo completo. Este valor puede o no ser igual al valor devuelto en el encabezado Content-MD5, con el último calculado a partir del intervalo solicitado.

fileContentMD5?: Uint8Array

Valor de propiedad

Uint8Array

fileCreationTime

Hora de creación del archivo.

fileCreationTime?: Date

Valor de propiedad

Date

fileId

FileId del archivo.

fileId?: undefined | string

Valor de propiedad

undefined | string

fileLastWriteTime

Hora de última escritura del archivo.

fileLastWriteTime?: Date

Valor de propiedad

Date

fileParentId

FileId primario del archivo.

fileParentId?: undefined | string

Valor de propiedad

undefined | string

filePermissionKey

Clave del conjunto de permisos para el archivo.

filePermissionKey?: undefined | string

Valor de propiedad

undefined | string

isServerEncrypted

El valor de este encabezado se establece en true si los datos de archivo y los metadatos de la aplicación se cifran completamente mediante el algoritmo especificado. De lo contrario, el valor se establece en false (cuando el archivo está sin cifrar o si solo se cifran partes de los metadatos de archivo o aplicación).

isServerEncrypted?: undefined | false | true

Valor de propiedad

undefined | false | true

lastModified

Devuelve la fecha y hora en que se modificó por última vez el archivo. Cualquier operación que modifique el archivo o sus propiedades actualiza la hora de la última modificación.

lastModified?: Date

Valor de propiedad

Date

metadata

metadata?: undefined | [key: string]: string

Valor de propiedad

undefined | [key: string]: string

requestId

Este encabezado identifica de forma única la solicitud realizada y se puede usar para solucionar problemas de la solicitud.

requestId?: undefined | string

Valor de propiedad

undefined | string

version

Indica la versión del servicio File usado para ejecutar la solicitud.

version?: undefined | string

Valor de propiedad

undefined | string