BlobDownloadToBufferOptions interface
操作の <xref:BlobClient.downloadToBuffer> オプション インターフェイス。
- Extends
プロパティ
abort |
操作を |
block |
blockSize は、すべての要求がダウンロードしようとしているデータです。 0 以上である必要があります。 0 または undefined に設定すると、blockSize は BLOB サイズに応じて自動的に計算されます。 |
concurrency | 並列ダウンロードのコンカレンシー。 |
conditions | アクセス条件ヘッダー。 |
customer |
顧客提供のキー情報。 |
max |
省略可能。 NODE.JSでのみ使用できます。 元のブロック ダウンロード ストリームの予期しない終了時に実行される再試行回数。 上記の種類の終了では、ネットワーク エラーを出力しないため、パイプラインで定義された再試行ポリシーはトリガーされません。 このオプションを使用すると、再試行するたびに、要求されたブロックが正常にダウンロードされるか、maxRetryRequestsPerBlock に達するまで、破損したポイントから追加の FileClient.download() 要求が行われます。 既定値は 5 です。ネットワークが悪い場合は、より大きな値を設定してください。 |
on |
進行状況アップデーター。 |
tracing |
トレースが有効になっているときに作成されたスパンを構成するためのオプション。 |
プロパティの詳細
abortSignal
操作を AbortSignalLike
取り消す要求を通知するインターフェイスの実装。
たとえば、@azure/abort-controller を使用して を作成します AbortSignal
。
abortSignal?: AbortSignalLike
プロパティ値
AbortSignalLike
blockSize
blockSize は、すべての要求がダウンロードしようとしているデータです。 0 以上である必要があります。 0 または undefined に設定すると、blockSize は BLOB サイズに応じて自動的に計算されます。
blockSize?: number
プロパティ値
number
concurrency
並列ダウンロードのコンカレンシー。
concurrency?: number
プロパティ値
number
conditions
customerProvidedKey
maxRetryRequestsPerBlock
省略可能。 NODE.JSでのみ使用できます。 元のブロック ダウンロード ストリームの予期しない終了時に実行される再試行回数。 上記の種類の終了では、ネットワーク エラーを出力しないため、パイプラインで定義された再試行ポリシーはトリガーされません。
このオプションを使用すると、再試行するたびに、要求されたブロックが正常にダウンロードされるか、maxRetryRequestsPerBlock に達するまで、破損したポイントから追加の FileClient.download() 要求が行われます。
既定値は 5 です。ネットワークが悪い場合は、より大きな値を設定してください。
maxRetryRequestsPerBlock?: number
プロパティ値
number
onProgress
進行状況アップデーター。
onProgress?: (progress: TransferProgressEvent) => void
プロパティ値
(progress: TransferProgressEvent) => void
tracingOptions
トレースが有効になっているときに作成されたスパンを構成するためのオプション。
tracingOptions?: OperationTracingOptions
プロパティ値
OperationTracingOptions
Azure SDK for JavaScript