GetDocumentOptions interface

Paquete:

@azure/search-documents

Opciones para recuperar un único documento.

Extends

OperationOptions

Propiedades

selectedFields	Lista de nombres de campo que se van a recuperar para el documento; Faltará cualquier campo que no se recupere del documento devuelto.
xMsEnableElevatedRead	Valor que habilita la lectura elevada que omite las comprobaciones de permisos de nivel de documento para la operación de consulta.
xMsQuerySourceAuthorization	Token que identifica al usuario para el que se ejecuta la consulta. Este token se utiliza para aplicar restricciones de seguridad en los documentos.

Propiedades heredadas

abortSignal	Señal que se puede usar para anular las solicitudes.
onResponse	Función a la que se llamará cada vez que se recibe una respuesta del servidor mientras se realiza la operación solicitada. Se puede llamar varias veces.
requestOptions	Opciones que se usan al crear y enviar solicitudes HTTP para esta operación.
serializerOptions	Opciones para invalidar el comportamiento de serialización o des serialización.
tracingOptions	Opciones que se usan al habilitar el seguimiento.

Detalles de las propiedades

selectedFields

Lista de nombres de campo que se van a recuperar para el documento; Faltará cualquier campo que no se recupere del documento devuelto.

selectedFields?: SelectArray<TFields>

Valor de propiedad

SelectArray<TFields>

xMsEnableElevatedRead

Valor que habilita la lectura elevada que omite las comprobaciones de permisos de nivel de documento para la operación de consulta.

xMsEnableElevatedRead?: boolean

Valor de propiedad

boolean

xMsQuerySourceAuthorization

Token que identifica al usuario para el que se ejecuta la consulta. Este token se utiliza para aplicar restricciones de seguridad en los documentos.

xMsQuerySourceAuthorization?: string

Valor de propiedad

string

Detalles de las propiedades heredadas

abortSignal

Señal que se puede usar para anular las solicitudes.

abortSignal?: AbortSignalLike

Valor de propiedad

AbortSignalLike

Heredado de OperationOptions.abortSignal

onResponse

Función a la que se llamará cada vez que se recibe una respuesta del servidor mientras se realiza la operación solicitada. Se puede llamar varias veces.

onResponse?: RawResponseCallback

Valor de propiedad

RawResponseCallback

Heredado de OperationOptions.onResponse

requestOptions

Opciones que se usan al crear y enviar solicitudes HTTP para esta operación.

requestOptions?: OperationRequestOptions

Valor de propiedad

OperationRequestOptions

Heredado de OperationOptions.requestOptions

serializerOptions

Opciones para invalidar el comportamiento de serialización o des serialización.

serializerOptions?: SerializerOptions

Valor de propiedad

SerializerOptions

heredado de OperationOptions.serializerOptions

tracingOptions

Opciones que se usan al habilitar el seguimiento.

tracingOptions?: OperationTracingOptions

Valor de propiedad

OperationTracingOptions

Heredado de OperationOptions.tracingOptions