GetDocumentOptions interface

Package:

@azure/search-documents

Options for retrieving a single document.

Extends

OperationOptions

Properties

selectedFields	List of field names to retrieve for the document; Any field not retrieved will be missing from the returned document.
xMsEnableElevatedRead	A value that enables elevated read that bypass document level permission checks for the query operation.
xMsQuerySourceAuthorization	Token identifying the user for which the query is being executed. This token is used to enforce security restrictions on documents.

Inherited Properties

abortSignal	The signal which can be used to abort requests.
onResponse	A function to be called each time a response is received from the server while performing the requested operation. May be called multiple times.
requestOptions	Options used when creating and sending HTTP requests for this operation.
serializerOptions	Options to override serialization/de-serialization behavior.
tracingOptions	Options used when tracing is enabled.

Property Details

selectedFields

List of field names to retrieve for the document; Any field not retrieved will be missing from the returned document.

selectedFields?: SelectArray<TFields>

Property Value

SelectArray<TFields>

xMsEnableElevatedRead

A value that enables elevated read that bypass document level permission checks for the query operation.

xMsEnableElevatedRead?: boolean

Property Value

boolean

xMsQuerySourceAuthorization

Token identifying the user for which the query is being executed. This token is used to enforce security restrictions on documents.

xMsQuerySourceAuthorization?: string

Property Value

string

Inherited Property Details

abortSignal

The signal which can be used to abort requests.

abortSignal?: AbortSignalLike

Property Value

AbortSignalLike

Inherited From OperationOptions.abortSignal

onResponse

A function to be called each time a response is received from the server while performing the requested operation. May be called multiple times.

onResponse?: RawResponseCallback

Property Value

RawResponseCallback

Inherited From OperationOptions.onResponse

requestOptions

Options used when creating and sending HTTP requests for this operation.

requestOptions?: OperationRequestOptions

Property Value

OperationRequestOptions

Inherited From OperationOptions.requestOptions

serializerOptions

Options to override serialization/de-serialization behavior.

serializerOptions?: SerializerOptions

Property Value

SerializerOptions

Inherited From OperationOptions.serializerOptions

tracingOptions

Options used when tracing is enabled.

tracingOptions?: OperationTracingOptions

Property Value

OperationTracingOptions

Inherited From OperationOptions.tracingOptions