FileDownloadOptions interface

Opções para configurar o Arquivo – Operações de download.

Ver:

Extends

Propriedades

abortSignal

Uma implementação da interface AbortSignalLike para sinalizar a solicitação para cancelar a operação. Por exemplo, use o controlador de @azure/anulação para criar um AbortSignal.

contentChecksumAlgorithm

Opções para indicar qual algoritmo usar para validação de conteúdo no download.

leaseAccessConditions

Condições de acesso de concessão.

maxRetryRequests

Opcional. DISPONÍVEL APENAS EM NODE.JS.

Quantas tentativas serão executadas quando o fluxo de download do corpo original for encerrado inesperadamente. O tipo acima de extremidades não disparará a política de repetição definida em um pipeline, pois elas não emitem erros de rede.

Com essa opção, cada repetição adicional significa que uma solicitação adicional do ShareFileClient.download() será feita a partir do ponto interrompido, até que o intervalo solicitado tenha sido baixado com êxito ou maxRetryRequests seja atingido.

O valor padrão é 5, defina um valor maior ao carregar arquivos grandes em uma rede ruim.

onProgress

Baixe o manipulador de eventos de atualização de progresso.

rangeGetContentMD5

Quando esse cabeçalho é definido como true e especificado junto com o cabeçalho Range, o serviço retorna o hash MD5 para o intervalo, desde que o intervalo seja menor ou igual a 4 MB de tamanho.

Propriedades herdadas

tracingOptions

Detalhes da propriedade

abortSignal

Uma implementação da interface AbortSignalLike para sinalizar a solicitação para cancelar a operação. Por exemplo, use o controlador de @azure/anulação para criar um AbortSignal.

abortSignal?: AbortSignalLike

Valor da propriedade

contentChecksumAlgorithm

Opções para indicar qual algoritmo usar para validação de conteúdo no download.

contentChecksumAlgorithm?: StorageChecksumAlgorithm

Valor da propriedade

leaseAccessConditions

Condições de acesso de concessão.

leaseAccessConditions?: LeaseAccessConditions

Valor da propriedade

maxRetryRequests

Opcional. DISPONÍVEL APENAS EM NODE.JS.

Quantas tentativas serão executadas quando o fluxo de download do corpo original for encerrado inesperadamente. O tipo acima de extremidades não disparará a política de repetição definida em um pipeline, pois elas não emitem erros de rede.

Com essa opção, cada repetição adicional significa que uma solicitação adicional do ShareFileClient.download() será feita a partir do ponto interrompido, até que o intervalo solicitado tenha sido baixado com êxito ou maxRetryRequests seja atingido.

O valor padrão é 5, defina um valor maior ao carregar arquivos grandes em uma rede ruim.

maxRetryRequests?: number

Valor da propriedade

number

onProgress

Baixe o manipulador de eventos de atualização de progresso.

onProgress?: (progress: TransferProgressEvent) => void

Valor da propriedade

(progress: TransferProgressEvent) => void

rangeGetContentMD5

Quando esse cabeçalho é definido como true e especificado junto com o cabeçalho Range, o serviço retorna o hash MD5 para o intervalo, desde que o intervalo seja menor ou igual a 4 MB de tamanho.

rangeGetContentMD5?: boolean

Valor da propriedade

boolean

Detalhes das propriedades herdadas

tracingOptions

tracingOptions?: OperationTracingOptions

Valor da propriedade

Herdado deCommonOptions.tracingOptions