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