FileDownloadToBufferOptions interface
downloadToBuffer 操作のオプション インターフェイス。
- Extends
プロパティ
| abort |
操作を |
| concurrency | コンカレンシーは、並列でダウンロードする範囲の最大数を示します。 指定しない場合、既定では 5 つのコンカレンシーが使用されます。 |
| lease |
リース アクセス条件。 |
| max |
省略可能。 NODE.JSでのみ使用できます。 元の範囲ダウンロード ストリームの予期しない終了時に実行される再試行回数。 上記の種類の終了では、ネットワーク エラーを出力しないため、パイプラインで定義されている再試行ポリシーはトリガーされません。 このオプションを使用すると、再試行するたびに、要求された範囲が正常にダウンロードされるか、maxRetryRequestsPerRange に達するまで、破損したポイントから追加の ShareFileClient.download() 要求が行われます。 既定値は 5 です。ネットワークが不十分な場合は、より大きな値を設定してください。 |
| on |
進行状況アップデーター。 |
| range |
Azure ファイルをダウンロードする場合、ダウンロード方法は大きなファイルを小さな範囲に分割しようとします。 小さい範囲はすべて、個別の要求を介してダウンロードされます。 このオプションは、ダウンロードしようとしている小さな要求ごとにサイズ データを定義します。 0 より大きい必要があります。未定義の場合は既定値が使用されます。 |
継承されたプロパティ
| tracing |
プロパティの詳細
abortSignal
操作を AbortSignalLike 取り消す要求を通知する インターフェイスの実装。
たとえば、@azure/abort-controller を使用して を作成します AbortSignal。
abortSignal?: AbortSignalLikeプロパティ値
concurrency
コンカレンシーは、並列でダウンロードする範囲の最大数を示します。 指定しない場合、既定では 5 つのコンカレンシーが使用されます。
concurrency?: numberプロパティ値
number
leaseAccessConditions
maxRetryRequestsPerRange
省略可能。 NODE.JSでのみ使用できます。
元の範囲ダウンロード ストリームの予期しない終了時に実行される再試行回数。 上記の種類の終了では、ネットワーク エラーを出力しないため、パイプラインで定義されている再試行ポリシーはトリガーされません。
このオプションを使用すると、再試行するたびに、要求された範囲が正常にダウンロードされるか、maxRetryRequestsPerRange に達するまで、破損したポイントから追加の ShareFileClient.download() 要求が行われます。
既定値は 5 です。ネットワークが不十分な場合は、より大きな値を設定してください。
maxRetryRequestsPerRange?: numberプロパティ値
number
onProgress
進行状況アップデーター。
onProgress?: (progress: TransferProgressEvent) => voidプロパティ値
(progress: TransferProgressEvent) => void
rangeSize
Azure ファイルをダウンロードする場合、ダウンロード方法は大きなファイルを小さな範囲に分割しようとします。 小さい範囲はすべて、個別の要求を介してダウンロードされます。 このオプションは、ダウンロードしようとしている小さな要求ごとにサイズ データを定義します。 0 より大きい必要があります。未定義の場合は既定値が使用されます。
rangeSize?: numberプロパティ値
number
継承されたプロパティの詳細
tracingOptions
tracingOptions?: OperationTracingOptions