AgentsListOptimizationCandidatesOptionalParams interface
省略可能なパラメーター。
- Extends
プロパティ
| after | Candidate-ID 前のページの最後の項目を識別するカーソル。 |
| before | Candidate-ID カーソルで次のページの最初の項目を識別します。 |
| expand | 拡張キーのカンマ区切られたリスト。 変異 |
| limit | 返されるオブジェクトの数の制限。 制限の範囲は 1 から 100 で、既定値は 20 です。 |
| order | 候補者 |
継承されたプロパティ
| abort |
要求を中止するために使用できるシグナル。 |
| on |
要求された操作の実行中にサーバーから応答を受信するたびに呼び出される関数。 複数回呼び出すことができます。 |
| request |
この操作の HTTP 要求を作成および送信するときに使用されるオプション。 |
| tracing |
トレースが有効な場合に使用されるオプション。 |
プロパティの詳細
after
Candidate-ID 前のページの最後の項目を識別するカーソル。
after?: string
プロパティ値
string
before
Candidate-ID カーソルで次のページの最初の項目を識別します。
before?: string
プロパティ値
string
expand
拡張キーのカンマ区切られたリスト。 変異valueフィールドを埋めるために mutations パスし、変異項目のみをtypeだけ受け取るのは省略します。 今後のプレビューで追加の拡張キーが追加される可能性があります。
expand?: "mutations"[]
プロパティ値
"mutations"[]
limit
返されるオブジェクトの数の制限。 制限の範囲は 1 から 100 で、既定値は 20 です。
limit?: number
プロパティ値
number
order
継承されたプロパティの詳細
abortSignal
要求を中止するために使用できるシグナル。
abortSignal?: AbortSignalLike
プロパティ値
OperationOptions.abortSignal から継承された
onResponse
要求された操作の実行中にサーバーから応答を受信するたびに呼び出される関数。 複数回呼び出すことができます。
onResponse?: RawResponseCallback
プロパティ値
OperationOptions.onResponse から継承された
requestOptions
この操作の HTTP 要求を作成および送信するときに使用されるオプション。
requestOptions?: OperationRequestOptions
プロパティ値
OperationOptions.requestOptions から継承された
tracingOptions
トレースが有効な場合に使用されるオプション。
tracingOptions?: OperationTracingOptions
プロパティ値
OperationOptions.tracingOptions から継承された