Compartilhar via


FileDownloadToBufferOptions interface

Interface de opção para a operação baixar o ToBuffer.

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.

concurrency

A simultaneidade indica o número máximo de intervalos a serem baixados em paralelo. Se não for fornecido, a simultaneidade 5 será usada por padrão.

leaseAccessConditions

Condições de acesso de concessão.

maxRetryRequestsPerRange

Opcional. DISPONÍVEL APENAS EM NODE.JS.

Quantas tentativas serão executadas quando o fluxo de download do intervalo 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 do ShareFileClient.download() será feita a partir do ponto interrompido, até que o intervalo solicitado tenha sido baixado com êxito ou maxRetryRequestsPerRange seja atingido.

O valor padrão é 5, defina um valor maior quando estiver em uma rede ruim.

onProgress

Atualizador de progresso.

rangeSize

Ao baixar arquivos do Azure, o método de download tentará dividir um arquivo grande em pequenos intervalos. Cada pequeno intervalo será baixado por meio de uma solicitação separada. Essa opção define dados de tamanho a cada solicitação pequena que tenta baixar. Deve ser maior que 0, usará o valor padrão se indefinido,

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

concurrency

A simultaneidade indica o número máximo de intervalos a serem baixados em paralelo. Se não for fornecido, a simultaneidade 5 será usada por padrão.

concurrency?: number

Valor da propriedade

number

leaseAccessConditions

Condições de acesso de concessão.

leaseAccessConditions?: LeaseAccessConditions

Valor da propriedade

maxRetryRequestsPerRange

Opcional. DISPONÍVEL APENAS EM NODE.JS.

Quantas tentativas serão executadas quando o fluxo de download do intervalo 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 do ShareFileClient.download() será feita a partir do ponto interrompido, até que o intervalo solicitado tenha sido baixado com êxito ou maxRetryRequestsPerRange seja atingido.

O valor padrão é 5, defina um valor maior quando estiver em uma rede ruim.

maxRetryRequestsPerRange?: number

Valor da propriedade

number

onProgress

Atualizador de progresso.

onProgress?: (progress: TransferProgressEvent) => void

Valor da propriedade

(progress: TransferProgressEvent) => void

rangeSize

Ao baixar arquivos do Azure, o método de download tentará dividir um arquivo grande em pequenos intervalos. Cada pequeno intervalo será baixado por meio de uma solicitação separada. Essa opção define dados de tamanho a cada solicitação pequena que tenta baixar. Deve ser maior que 0, usará o valor padrão se indefinido,

rangeSize?: number

Valor da propriedade

number

Detalhes das propriedades herdadas

tracingOptions

tracingOptions?: OperationTracingOptions

Valor da propriedade

Herdado deCommonOptions.tracingOptions