FileDownloadOptions interface

Pacote:

@azure/storage-file-share

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

Consulte:

• download
• downloadToFile

Extends

CommonOptions

Propriedades

abortSignal	Uma implementação da AbortSignalLike interface para sinalizar a solicitação para cancelar a operação. Por exemplo, use o @azure/abort-controller para criar um AbortSignal.
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 terminar 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 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 AbortSignalLike interface para sinalizar a solicitação para cancelar a operação. Por exemplo, use o @azure/abort-controller para criar um AbortSignal.

abortSignal?: AbortSignalLike

Valor da propriedade

AbortSignalLike

leaseAccessConditions

Condições de acesso de concessão.

leaseAccessConditions?: LeaseAccessConditions

Valor da propriedade

LeaseAccessConditions

maxRetryRequests

Opcional. DISPONÍVEL APENAS EM NODE.JS.

Quantas tentativas serão executadas quando o fluxo de download do corpo original terminar 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 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

OperationTracingOptions

Herdado deCommonOptions.tracingOptions