QueueReceiveMessageOptions interface

パッケージ:

@azure/storage-queue

receiveMessages 操作を構成するためのオプション

Extends

MessagesDequeueOptionalParams,CommonOptions

継承されたプロパティ

abortSignal	中止コントローラーのシグナル。 ネットワーク要求の送信と応答の待機の両方を中止するために使用できます。
customHeaders	は、要求が送信される前に適用されます。
numberOfMessages	省略可能。 キューから取得するメッセージの数を示すゼロ以外の整数値を指定します (上限は 32 件)。 表示できるメッセージの数が指定された数よりも少ない場合は、表示できるメッセージが返されます。 既定では、この操作によってキューから 1 つのメッセージが取得されます。
onDownloadProgress	ダウンロードの進行状況時に発生するコールバック。
onUploadProgress	アップロードの進行状況時に発生するコールバック。
requestId	ストレージ解析ロギングが有効なときに解析ログに記録される、クライアントで生成された非透過の値を 1 KB の文字制限付きで提供します。
serializerOptions	XML 解析/構築の動作をオーバーライドするオプション。
shouldDeserialize	HttpOperationResponse を逆シリアル化する必要があるかどうか。 これが未定義の場合は、HttpOperationResponse を逆シリアル化する必要があります。
timeout	要求が自動的に終了するまでの時間 (ミリ秒)。 要求が終了すると、 AbortError がスローされます。
timeoutInSeconds	タイムアウト パラメーターは秒単位で表されます。 詳細については、「キュー サービス操作のタイムアウトの設定」を参照してください。
tracingContext	トレース: スパンの作成時に使用されるコンテキスト。
tracingOptions	トレースが有効になっているときに作成されたスパンを構成するためのオプション。
visibilityTimeout	省略可能。 サーバー時間を基準に、新しい表示タイムアウト値を秒単位で指定します。 既定値は 30 秒です。 指定した値は 1 秒以上である必要があり、バージョン 2011-08-18 より前の REST プロトコル バージョンでは 7 日以上、または 2 時間を超えることはできません。 メッセージの表示タイムアウト値は、有効期限より後の値に設定できます。

継承されたプロパティの詳細

abortSignal

中止コントローラーのシグナル。 ネットワーク要求の送信と応答の待機の両方を中止するために使用できます。

abortSignal?: AbortSignalLike

プロパティ値

AbortSignalLike

MessagesDequeueOptionalParams.abortSignalから継承

customHeaders

は、要求が送信される前に適用されます。

customHeaders?: {[key: string]: string}

プロパティ値

{[key: string]: string}

MessagesDequeueOptionalParams.customHeadersから継承

numberOfMessages

省略可能。 キューから取得するメッセージの数を示すゼロ以外の整数値を指定します (上限は 32 件)。 表示できるメッセージの数が指定された数よりも少ない場合は、表示できるメッセージが返されます。 既定では、この操作によってキューから 1 つのメッセージが取得されます。

numberOfMessages?: number

プロパティ値

number

MessagesDequeueOptionalParams.numberOfMessagesから継承

onDownloadProgress

ダウンロードの進行状況時に発生するコールバック。

onDownloadProgress?: (progress: TransferProgressEvent) => void

プロパティ値

(progress: TransferProgressEvent) => void

MessagesDequeueOptionalParams.onDownloadProgressから継承

onUploadProgress

アップロードの進行状況時に発生するコールバック。

onUploadProgress?: (progress: TransferProgressEvent) => void

プロパティ値

(progress: TransferProgressEvent) => void

MessagesDequeueOptionalParams.onUploadProgressから継承

requestId

ストレージ解析ロギングが有効なときに解析ログに記録される、クライアントで生成された非透過の値を 1 KB の文字制限付きで提供します。

requestId?: string

プロパティ値

string

MessagesDequeueOptionalParams.requestIdから継承

serializerOptions

XML 解析/構築の動作をオーバーライドするオプション。

serializerOptions?: SerializerOptions

プロパティ値

SerializerOptions

MessagesDequeueOptionalParams.serializerOptionsから継承

shouldDeserialize

HttpOperationResponse を逆シリアル化する必要があるかどうか。 これが未定義の場合は、HttpOperationResponse を逆シリアル化する必要があります。

shouldDeserialize?: boolean | (response: HttpOperationResponse) => boolean

プロパティ値

boolean | (response: HttpOperationResponse) => boolean

MessagesDequeueOptionalParams.shouldDeserializeから継承

timeout

要求が自動的に終了するまでの時間 (ミリ秒)。 要求が終了すると、 AbortError がスローされます。

timeout?: number

プロパティ値

number

MessagesDequeueOptionalParams.timeoutから継承

timeoutInSeconds

タイムアウト パラメーターは秒単位で表されます。 詳細については、「キュー サービス操作のタイムアウトの設定」を参照してください。

timeoutInSeconds?: number

プロパティ値

number

MessagesDequeueOptionalParams.timeoutInSecondsから継承

tracingContext

トレース: スパンの作成時に使用されるコンテキスト。

tracingContext?: Context

プロパティ値

@azure/core-tracing.Context

MessagesDequeueOptionalParams.tracingContextから継承

tracingOptions

トレースが有効になっているときに作成されたスパンを構成するためのオプション。

tracingOptions?: OperationTracingOptions

プロパティ値

OperationTracingOptions

CommonOptions.tracingOptionsから継承

visibilityTimeout

省略可能。 サーバー時間を基準に、新しい表示タイムアウト値を秒単位で指定します。 既定値は 30 秒です。 指定した値は 1 秒以上である必要があり、バージョン 2011-08-18 より前の REST プロトコル バージョンでは 7 日以上、または 2 時間を超えることはできません。 メッセージの表示タイムアウト値は、有効期限より後の値に設定できます。

visibilityTimeout?: number

プロパティ値

number

MessagesDequeueOptionalParams.visibilityTimeoutから継承