GetDocumentOptions interface

Paket:

@azure/search-documents

Opsi untuk mengambil satu dokumen.

Memperluas

OperationOptions

Properti

selectedFields	Daftar nama bidang yang akan diambil untuk dokumen; Bidang apa pun yang tidak diambil akan hilang dari dokumen yang dikembalikan.
xMsEnableElevatedRead	Nilai yang memungkinkan pembacaan tinggi yang melewati pemeriksaan izin tingkat dokumen untuk operasi kueri.
xMsQuerySourceAuthorization	Token yang mengidentifikasi pengguna tempat kueri sedang dijalankan. Token ini digunakan untuk menegakkan pembatasan keamanan pada dokumen.

Properti yang Diwariskan

abortSignal	Sinyal yang dapat digunakan untuk membatalkan permintaan.
onResponse	Fungsi yang akan dipanggil setiap kali respons diterima dari server saat melakukan operasi yang diminta. Dapat dipanggil beberapa kali.
requestOptions	Opsi yang digunakan saat membuat dan mengirim permintaan HTTP untuk operasi ini.
serializerOptions	Opsi untuk mengambil alih perilaku serialisasi/de-serialisasi.
tracingOptions	Opsi yang digunakan saat pelacakan diaktifkan.

Detail Properti

selectedFields

Daftar nama bidang yang akan diambil untuk dokumen; Bidang apa pun yang tidak diambil akan hilang dari dokumen yang dikembalikan.

selectedFields?: SelectArray<TFields>

Nilai Properti

SelectArray<TFields>

xMsEnableElevatedRead

Nilai yang memungkinkan pembacaan tinggi yang melewati pemeriksaan izin tingkat dokumen untuk operasi kueri.

xMsEnableElevatedRead?: boolean

Nilai Properti

boolean

xMsQuerySourceAuthorization

Token yang mengidentifikasi pengguna tempat kueri sedang dijalankan. Token ini digunakan untuk menegakkan pembatasan keamanan pada dokumen.

xMsQuerySourceAuthorization?: string

Nilai Properti

string

Detail Properti yang Diwariskan

abortSignal

Sinyal yang dapat digunakan untuk membatalkan permintaan.

abortSignal?: AbortSignalLike

Nilai Properti

AbortSignalLike

Diwariskan Dari OperationOptions.abortSignal

onResponse

Fungsi yang akan dipanggil setiap kali respons diterima dari server saat melakukan operasi yang diminta. Dapat dipanggil beberapa kali.

onResponse?: RawResponseCallback

Nilai Properti

RawResponseCallback

Diwariskan Dari OperationOptions.onResponse

requestOptions

Opsi yang digunakan saat membuat dan mengirim permintaan HTTP untuk operasi ini.

requestOptions?: OperationRequestOptions

Nilai Properti

OperationRequestOptions

Diwariskan Dari OperationOptions.requestOptions

serializerOptions

Opsi untuk mengambil alih perilaku serialisasi/de-serialisasi.

serializerOptions?: SerializerOptions

Nilai Properti

SerializerOptions

Diwariskan Dari OperationOptions.serializerOptions

tracingOptions

Opsi yang digunakan saat pelacakan diaktifkan.

tracingOptions?: OperationTracingOptions

Nilai Properti

OperationTracingOptions

Diwariskan Dari OperationOptions.tracingOptions