GetDocumentOptions interface
1 つのドキュメントを取得するためのオプション。
- Extends
プロパティ
selected |
ドキュメント用に取得するフィールド名のリスト。取得されないフィールドは、返されたドキュメントに表示されません。 |
継承されたプロパティ
abort |
要求を中止するために使用できるシグナル。 |
on |
要求された操作の実行中にサーバーから応答を受信するたびに呼び出される関数。 複数回呼び出すことができます。 |
request |
この操作の HTTP 要求を作成および送信するときに使用されるオプション。 |
serializer |
シリアル化/シリアル化解除の動作をオーバーライドするオプション。 |
tracing |
トレースが有効な場合に使用されるオプション。 |
プロパティの詳細
selectedFields
ドキュメント用に取得するフィールド名のリスト。取得されないフィールドは、返されたドキュメントに表示されません。
selectedFields?: SelectArray<TFields>
プロパティ値
SelectArray<TFields>
継承されたプロパティの詳細
abortSignal
要求を中止するために使用できるシグナル。
abortSignal?: AbortSignalLike
プロパティ値
継承元 OperationOptions.abortSignal
onResponse
要求された操作の実行中にサーバーから応答を受信するたびに呼び出される関数。 複数回呼び出すことができます。
onResponse?: RawResponseCallback
プロパティ値
継承元 OperationOptions.onResponse
requestOptions
この操作の HTTP 要求を作成および送信するときに使用されるオプション。
requestOptions?: OperationRequestOptions
プロパティ値
継承元 OperationOptions.requestOptions
serializerOptions
シリアル化/シリアル化解除の動作をオーバーライドするオプション。
serializerOptions?: SerializerOptions
プロパティ値
継承元 OperationOptions.serializerOptions
tracingOptions
トレースが有効な場合に使用されるオプション。
tracingOptions?: OperationTracingOptions
プロパティ値
継承元 OperationOptions.tracingOptions