Partager via

BlobDownloadToBufferOptions interface

  • Référence
Paquet:
@azure/storage-blob

Interface d’option pour l’opération <xref:BlobClient.downloadToBuffer> .

Extends
CommonOptions

Propriétés

abortSignal

Implémentation de l’interface AbortSignalLike pour signaler la demande d’annulation de l’opération. Par exemple, utilisez le @azure/abort-controller pour créer un AbortSignal.
blockSize

blockSize est les données que chaque demande tente de télécharger. Doit être supérieur ou égal à 0. Si la valeur est 0 ou non définie, blockSize est automatiquement calculé en fonction de la taille de l’objet blob.
concurrency

Concurrence du téléchargement parallèle.
conditions

En-têtes des conditions d’accès.
customerProvidedKey

Informations de clé fournies par le client.
maxRetryRequestsPerBlock

facultatif. DISPONIBLE UNIQUEMENT DANS NODE.JS. Nombre de nouvelles tentatives effectuées lorsque le flux de téléchargement de bloc d’origine se termine de façon inattendue. Le type de terminaison ci-dessus ne déclenche pas la stratégie de nouvelle tentative définie dans un pipeline, car elles n’émettent pas d’erreurs réseau.

Avec cette option, chaque nouvelle tentative supplémentaire signifie qu’une requête FileClient.download() supplémentaire est effectuée à partir du point de rupture, jusqu’à ce que le bloc demandé ait été correctement téléchargé ou que maxRetryRequestsPerBlock soit atteint.

La valeur par défaut est 5. Définissez une valeur plus élevée lorsque le réseau est médiocre.
onProgress

Progress Updater.
tracingOptions

Options de configuration des étendues créées lorsque le suivi est activé.

Détails de la propriété

abortSignal

Implémentation de l’interface AbortSignalLike pour signaler la demande d’annulation de l’opération. Par exemple, utilisez le @azure/abort-controller pour créer un AbortSignal.

abortSignal?: AbortSignalLike

Valeur de propriété

AbortSignalLike

blockSize

blockSize est les données que chaque demande tente de télécharger. Doit être supérieur ou égal à 0. Si la valeur est 0 ou non définie, blockSize est automatiquement calculé en fonction de la taille de l’objet blob.

blockSize?: number

Valeur de propriété

number

concurrency

Concurrence du téléchargement parallèle.

concurrency?: number

Valeur de propriété

number

conditions

En-têtes des conditions d’accès.

conditions?: BlobRequestConditions

Valeur de propriété

BlobRequestConditions

customerProvidedKey

Informations de clé fournies par le client.

customerProvidedKey?: CpkInfo

Valeur de propriété

CpkInfo

maxRetryRequestsPerBlock

facultatif. DISPONIBLE UNIQUEMENT DANS NODE.JS. Nombre de nouvelles tentatives effectuées lorsque le flux de téléchargement de bloc d’origine se termine de façon inattendue. Le type de terminaison ci-dessus ne déclenche pas la stratégie de nouvelle tentative définie dans un pipeline, car elles n’émettent pas d’erreurs réseau.

Avec cette option, chaque nouvelle tentative supplémentaire signifie qu’une requête FileClient.download() supplémentaire est effectuée à partir du point de rupture, jusqu’à ce que le bloc demandé ait été correctement téléchargé ou que maxRetryRequestsPerBlock soit atteint.

La valeur par défaut est 5. Définissez une valeur plus élevée lorsque le réseau est médiocre.

maxRetryRequestsPerBlock?: number

Valeur de propriété

number

onProgress

Progress Updater.

onProgress?: (progress: TransferProgressEvent) => void

Valeur de propriété

(progress: TransferProgressEvent) => void

tracingOptions

Options de configuration des étendues créées lorsque le suivi est activé.

tracingOptions?: OperationTracingOptions

Valeur de propriété

OperationTracingOptions