GetDocumentOptions interface

Пакет:

@azure/search-documents

Параметры получения одного документа.

Extends

OperationOptions

Свойства

selectedFields	Список имен полей для получения документа; Любое поле, не полученное, будет пропущено из возвращаемого документа.
xMsEnableElevatedRead	Значение, которое разрешает чтение с повышенными привилегиями и обход проверок разрешений на уровне документа для операции запроса.
xMsQuerySourceAuthorization	Маркер, идентифицирующий пользователя, для которого выполняется запрос. Этот маркер используется для применения ограничений безопасности к документам.

Унаследованные свойства

abortSignal	Сигнал, который можно использовать для прерывания запросов.
onResponse	Функция, вызываемая каждый раз при получении ответа от сервера при выполнении запрошенной операции. Может вызываться несколько раз.
requestOptions	Параметры, используемые при создании и отправке HTTP-запросов для этой операции.
serializerOptions	Параметры переопределения поведения сериализации и десериализации.
tracingOptions	Параметры, используемые при включении трассировки.

Сведения о свойстве

selectedFields

Список имен полей для получения документа; Любое поле, не полученное, будет пропущено из возвращаемого документа.

selectedFields?: SelectArray<TFields>

Значение свойства

SelectArray<TFields>

xMsEnableElevatedRead

Значение, которое разрешает чтение с повышенными привилегиями и обход проверок разрешений на уровне документа для операции запроса.

xMsEnableElevatedRead?: boolean

Значение свойства

boolean

xMsQuerySourceAuthorization

Маркер, идентифицирующий пользователя, для которого выполняется запрос. Этот маркер используется для применения ограничений безопасности к документам.

xMsQuerySourceAuthorization?: string

Значение свойства

string

Сведения об унаследованном свойстве

abortSignal

Сигнал, который можно использовать для прерывания запросов.

abortSignal?: AbortSignalLike

Значение свойства

AbortSignalLike

Наследуется от OperationOptions.abortSignal

onResponse

Функция, вызываемая каждый раз при получении ответа от сервера при выполнении запрошенной операции. Может вызываться несколько раз.

onResponse?: RawResponseCallback

Значение свойства

RawResponseCallback

Наследуется от OperationOptions.onResponse

requestOptions

Параметры, используемые при создании и отправке HTTP-запросов для этой операции.

requestOptions?: OperationRequestOptions

Значение свойства

OperationRequestOptions

Наследуется от OperationOptions.requestOptions

serializerOptions

Параметры переопределения поведения сериализации и десериализации.

serializerOptions?: SerializerOptions

Значение свойства

SerializerOptions

наследуется от OperationOptions.serializerOptions

tracingOptions

Параметры, используемые при включении трассировки.

tracingOptions?: OperationTracingOptions

Значение свойства

OperationTracingOptions

Наследуется от OperationOptions.tracingOptions