QueueReceiveMessageOptions interface
receiveMessages 操作を構成するためのオプション
- Extends
継承されたプロパティ
| number |
省略可能。 キューから取得するメッセージの数を示すゼロ以外の整数値を指定します (上限は 32 件)。 表示できるメッセージの数が指定された数よりも少ない場合は、表示できるメッセージが返されます。 既定では、この操作によってキューから 1 つのメッセージが取得されます。 |
| request |
ストレージ解析ロギングが有効なときに解析ログに記録される、クライアントで生成された非透過の値を 1 KB の文字制限付きで提供します。 |
| timeout |
タイムアウト パラメーターは秒単位で表されます。 詳細については、「キュー サービス操作のタイムアウトの設定」を参照してください。 |
| tracing |
トレースが有効になっているときに作成されたスパンを構成するためのオプション。 |
| visibility |
省略可能。 サーバー時間を基準に、新しい表示タイムアウト値を秒単位で指定します。 既定値は 30 秒です。 指定した値は 1 秒以上である必要があり、バージョン 2011-08-18 より前の REST プロトコル バージョンでは 7 日以上、または 2 時間を超えることはできません。 メッセージの表示タイムアウト値は、有効期限より後の値に設定できます。 |
継承されたプロパティの詳細
numberOfMessages
省略可能。 キューから取得するメッセージの数を示すゼロ以外の整数値を指定します (上限は 32 件)。 表示できるメッセージの数が指定された数よりも少ない場合は、表示できるメッセージが返されます。 既定では、この操作によってキューから 1 つのメッセージが取得されます。
numberOfMessages?: numberプロパティ値
number
requestId
ストレージ解析ロギングが有効なときに解析ログに記録される、クライアントで生成された非透過の値を 1 KB の文字制限付きで提供します。
requestId?: stringプロパティ値
string
timeoutInSeconds
タイムアウト パラメーターは秒単位で表されます。 詳細については、「キュー サービス操作のタイムアウトの設定」を参照してください。
timeoutInSeconds?: numberプロパティ値
number
tracingOptions
トレースが有効になっているときに作成されたスパンを構成するためのオプション。
tracingOptions?: OperationTracingOptionsプロパティ値
visibilityTimeout
省略可能。 サーバー時間を基準に、新しい表示タイムアウト値を秒単位で指定します。 既定値は 30 秒です。 指定した値は 1 秒以上である必要があり、バージョン 2011-08-18 より前の REST プロトコル バージョンでは 7 日以上、または 2 時間を超えることはできません。 メッセージの表示タイムアウト値は、有効期限より後の値に設定できます。
visibilityTimeout?: numberプロパティ値
number