FileDownloadHeaders interface

Pacote:

@azure/storage-file-share

Define cabeçalhos para File_download operação.

Propriedades

acceptRanges	Indica que o serviço oferece suporte a solicitações de conteúdo parcial de arquivo.
cacheControl	Retornado se tiver sido especificado anteriormente para o arquivo.
contentDisposition	Retorna o valor especificado para o cabeçalho 'x-ms-content-disposition' e especifica como processar a resposta.
contentEncoding	Retorna o valor especificado para o cabeçalho da solicitação Content-Encoding .
contentLanguage	Retorna o valor especificado para o cabeçalho da solicitação Content-Language.
contentLength	O número de bytes presentes no corpo da resposta.
contentMD5	Se o arquivo tiver um hash MD5 e a solicitação for para ler o arquivo completo, esse cabeçalho de resposta será retornado para que o cliente possa verificar a integridade do conteúdo da mensagem. Se a solicitação for para ler um intervalo especificado e o 'x-ms-range-get-content-md5' estiver definido como true, a solicitação retornará um hash MD5 para o intervalo, desde que o tamanho do intervalo seja menor ou igual a 4 MB. Se nenhum desses conjuntos de condições for verdadeiro, nenhum valor será retornado para o cabeçalho 'Content-MD5'.
contentRange	Indica o intervalo de bytes retornados se o cliente solicitou um subconjunto do arquivo definindo o cabeçalho de solicitação Range.
contentType	O tipo de conteúdo especificado para o arquivo. O tipo de conteúdo padrão é 'application/octet-stream'
copyCompletedOn	Hora de conclusão da última tentativa de operação Copiar ficheiro em que este ficheiro era o ficheiro de destino. Esse valor pode especificar a hora de uma tentativa de cópia concluída, abortada ou com falha.
copyId	Identificador de cadeia de caracteres para a última tentativa de operação de cópia de arquivo em que esse arquivo era o arquivo de destino.
copyProgress	Contém o número de bytes copiados e o total de bytes na origem na última tentativa de operação Copiar arquivo em que esse arquivo era o arquivo de destino. Pode mostrar entre 0 e bytes de comprimento de conteúdo copiados.
copySource	URL de até 2 KB de comprimento que especifica o arquivo de origem usado na última tentativa de operação de cópia de arquivo onde esse arquivo era o arquivo de destino.
copyStatus	Estado da operação de cópia identificado por «x-ms-copy-id».
copyStatusDescription	Só aparece quando x-ms-copy-status está com falha ou pendente. Descreve a causa da falha fatal ou não fatal da operação de cópia.
date	Um valor de data/hora UTC gerado pelo serviço que indica a hora em que a resposta foi iniciada.
errorCode	Código de erro
etag	O ETag contém um valor que você pode usar para executar operações condicionalmente, entre aspas.
fileAttributes	Atributos definidos para o arquivo.
fileChangeOn	Altere a hora do arquivo.
fileContentMD5	Se o arquivo tiver um hash MD5 e se a solicitação contiver cabeçalho de intervalo (Range ou x-ms-range), esse cabeçalho de resposta será retornado com o valor MD5 do arquivo inteiro. Esse valor pode ou não ser igual ao valor retornado no cabeçalho Content-MD5, com o último calculado a partir do intervalo solicitado.
fileCreatedOn	Tempo de criação do arquivo.
fileId	O fileId do arquivo.
fileLastWriteOn	Última hora de gravação do arquivo.
fileParentId	O fileId pai do arquivo.
filePermissionKey	Chave do conjunto de permissões para o arquivo.
isServerEncrypted	O valor desse cabeçalho será definido como true se os dados do arquivo e os metadados do aplicativo forem completamente criptografados usando o algoritmo especificado. Caso contrário, o valor é definido como false (quando o ficheiro não está encriptado ou se apenas partes dos metadados do ficheiro/aplicação estiverem encriptadas).
lastModified	Retorna a data e a hora em que o arquivo foi modificado pela última vez. Qualquer operação que modifique o arquivo ou suas propriedades atualiza a hora da última modificação.
leaseDuration	Quando um arquivo é concedido, especifica se a concessão é de duração infinita ou fixa.
leaseState	Estado de concessão do arquivo.
leaseStatus	O status atual da concessão do arquivo.
metadata	Um conjunto de pares nome-valor associados a esse arquivo como metadados definidos pelo usuário.
requestId	Esse cabeçalho identifica exclusivamente a solicitação que foi feita e pode ser usado para solucionar a solicitação.
version	Indica a versão do serviço de arquivo usada para executar a solicitação.

Detalhes de Propriedade

acceptRanges

Indica que o serviço oferece suporte a solicitações de conteúdo parcial de arquivo.

acceptRanges?: string

Valor de Propriedade

string

cacheControl

Retornado se tiver sido especificado anteriormente para o arquivo.

cacheControl?: string

Valor de Propriedade

string

contentDisposition

Retorna o valor especificado para o cabeçalho 'x-ms-content-disposition' e especifica como processar a resposta.

contentDisposition?: string

Valor de Propriedade

string

contentEncoding

Retorna o valor especificado para o cabeçalho da solicitação Content-Encoding .

contentEncoding?: string

Valor de Propriedade

string

contentLanguage

Retorna o valor especificado para o cabeçalho da solicitação Content-Language.

contentLanguage?: string

Valor de Propriedade

string

contentLength

O número de bytes presentes no corpo da resposta.

contentLength?: number

Valor de Propriedade

number

contentMD5

Se o arquivo tiver um hash MD5 e a solicitação for para ler o arquivo completo, esse cabeçalho de resposta será retornado para que o cliente possa verificar a integridade do conteúdo da mensagem. Se a solicitação for para ler um intervalo especificado e o 'x-ms-range-get-content-md5' estiver definido como true, a solicitação retornará um hash MD5 para o intervalo, desde que o tamanho do intervalo seja menor ou igual a 4 MB. Se nenhum desses conjuntos de condições for verdadeiro, nenhum valor será retornado para o cabeçalho 'Content-MD5'.

contentMD5?: Uint8Array

Valor de Propriedade

Uint8Array

contentRange

Indica o intervalo de bytes retornados se o cliente solicitou um subconjunto do arquivo definindo o cabeçalho de solicitação Range.

contentRange?: string

Valor de Propriedade

string

contentType

O tipo de conteúdo especificado para o arquivo. O tipo de conteúdo padrão é 'application/octet-stream'

contentType?: string

Valor de Propriedade

string

copyCompletedOn

Hora de conclusão da última tentativa de operação Copiar ficheiro em que este ficheiro era o ficheiro de destino. Esse valor pode especificar a hora de uma tentativa de cópia concluída, abortada ou com falha.

copyCompletedOn?: Date

Valor de Propriedade

Date

copyId

Identificador de cadeia de caracteres para a última tentativa de operação de cópia de arquivo em que esse arquivo era o arquivo de destino.

copyId?: string

Valor de Propriedade

string

copyProgress

Contém o número de bytes copiados e o total de bytes na origem na última tentativa de operação Copiar arquivo em que esse arquivo era o arquivo de destino. Pode mostrar entre 0 e bytes de comprimento de conteúdo copiados.

copyProgress?: string

Valor de Propriedade

string

copySource

URL de até 2 KB de comprimento que especifica o arquivo de origem usado na última tentativa de operação de cópia de arquivo onde esse arquivo era o arquivo de destino.

copySource?: string

Valor de Propriedade

string

copyStatus

Estado da operação de cópia identificado por «x-ms-copy-id».

copyStatus?: CopyStatusType

Valor de Propriedade

CopyStatusType

copyStatusDescription

Só aparece quando x-ms-copy-status está com falha ou pendente. Descreve a causa da falha fatal ou não fatal da operação de cópia.

copyStatusDescription?: string

Valor de Propriedade

string

date

Um valor de data/hora UTC gerado pelo serviço que indica a hora em que a resposta foi iniciada.

date?: Date

Valor de Propriedade

Date

errorCode

Código de erro

errorCode?: string

Valor de Propriedade

string

etag

O ETag contém um valor que você pode usar para executar operações condicionalmente, entre aspas.

etag?: string

Valor de Propriedade

string

fileAttributes

Atributos definidos para o arquivo.

fileAttributes?: string

Valor de Propriedade

string

fileChangeOn

Altere a hora do arquivo.

fileChangeOn?: Date

Valor de Propriedade

Date

fileContentMD5

Se o arquivo tiver um hash MD5 e se a solicitação contiver cabeçalho de intervalo (Range ou x-ms-range), esse cabeçalho de resposta será retornado com o valor MD5 do arquivo inteiro. Esse valor pode ou não ser igual ao valor retornado no cabeçalho Content-MD5, com o último calculado a partir do intervalo solicitado.

fileContentMD5?: Uint8Array

Valor de Propriedade

Uint8Array

fileCreatedOn

Tempo de criação do arquivo.

fileCreatedOn?: Date

Valor de Propriedade

Date

fileId

O fileId do arquivo.

fileId?: string

Valor de Propriedade

string

fileLastWriteOn

Última hora de gravação do arquivo.

fileLastWriteOn?: Date

Valor de Propriedade

Date

fileParentId

O fileId pai do arquivo.

fileParentId?: string

Valor de Propriedade

string

filePermissionKey

Chave do conjunto de permissões para o arquivo.

filePermissionKey?: string

Valor de Propriedade

string

isServerEncrypted

O valor desse cabeçalho será definido como true se os dados do arquivo e os metadados do aplicativo forem completamente criptografados usando o algoritmo especificado. Caso contrário, o valor é definido como false (quando o ficheiro não está encriptado ou se apenas partes dos metadados do ficheiro/aplicação estiverem encriptadas).

isServerEncrypted?: boolean

Valor de Propriedade

boolean

lastModified

Retorna a data e a hora em que o arquivo foi modificado pela última vez. Qualquer operação que modifique o arquivo ou suas propriedades atualiza a hora da última modificação.

lastModified?: Date

Valor de Propriedade

Date

leaseDuration

Quando um arquivo é concedido, especifica se a concessão é de duração infinita ou fixa.

leaseDuration?: LeaseDurationType

Valor de Propriedade

LeaseDurationType

leaseState

Estado de concessão do arquivo.

leaseState?: LeaseStateType

Valor de Propriedade

LeaseStateType

leaseStatus

O status atual da concessão do arquivo.

leaseStatus?: LeaseStatusType

Valor de Propriedade

LeaseStatusType

metadata

Um conjunto de pares nome-valor associados a esse arquivo como metadados definidos pelo usuário.

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

Valor de Propriedade

{[propertyName: string]: string}

requestId

Esse cabeçalho identifica exclusivamente a solicitação que foi feita e pode ser usado para solucionar a solicitação.

requestId?: string

Valor de Propriedade

string

version

Indica a versão do serviço de arquivo usada para executar a solicitação.

version?: string

Valor de Propriedade

string