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