ListModelsOptions interface
省略可能なパラメーター。
- Extends
プロパティ
| dependencies |
指定した場合は、指定したモデルのセットとその依存関係のみを返します。 省略すると、すべてのモデルが取得されます。 |
| include |
true の場合、モデル定義は結果の一部として返されます。 |
| results |
要求ごとに取得する項目の最大数。 サーバーは、要求された数よりも少ない数を返すことを選択できます。 |
継承されたプロパティ
| abort |
要求を中止するために使用できるシグナル。 |
| on |
要求された操作の実行中にサーバーから応答を受信するたびに呼び出される関数。 複数回呼び出すことができます。 |
| request |
この操作の HTTP 要求を作成および送信するときに使用されるオプション。 |
| serializer |
シリアル化/シリアル化解除の動作をオーバーライドするオプション。 |
| tracing |
トレースが有効な場合に使用されるオプション。 |
プロパティの詳細
dependenciesFor
指定した場合は、指定したモデルのセットとその依存関係のみを返します。 省略すると、すべてのモデルが取得されます。
dependenciesFor?: string[]
プロパティ値
string[]
includeModelDefinition
true の場合、モデル定義は結果の一部として返されます。
includeModelDefinition?: boolean
プロパティ値
boolean
resultsPerPage
要求ごとに取得する項目の最大数。 サーバーは、要求された数よりも少ない数を返すことを選択できます。
resultsPerPage?: number
プロパティ値
number
継承されたプロパティの詳細
abortSignal
要求を中止するために使用できるシグナル。
abortSignal?: AbortSignalLike
プロパティ値
coreClient.OperationOptions.abortSignal から継承
onResponse
要求された操作の実行中にサーバーから応答を受信するたびに呼び出される関数。 複数回呼び出すことができます。
onResponse?: RawResponseCallback
プロパティ値
coreClient.OperationOptions.onResponse から継承
requestOptions
この操作の HTTP 要求を作成および送信するときに使用されるオプション。
requestOptions?: OperationRequestOptions
プロパティ値
coreClient.OperationOptions.requestOptions から継承
serializerOptions
シリアル化/シリアル化解除の動作をオーバーライドするオプション。
serializerOptions?: SerializerOptions
プロパティ値
coreClient.OperationOptions.serializerOptions から継承
tracingOptions
トレースが有効な場合に使用されるオプション。
tracingOptions?: OperationTracingOptions
プロパティ値
coreClient.OperationOptions.tracingOptions から継承