GetDocumentOptions interface

Pacote:

@azure/search-documents

Opções para recuperar um único documento.

Extends

OperationOptions

Propriedades

selectedFields	Lista de nomes de campo a serem recuperados para o documento; Qualquer campo não recuperado estará ausente do documento retornado.
xMsEnableElevatedRead	Um valor que permite a leitura elevada que ignora as verificações de permissão no nível do documento para a operação de consulta.
xMsQuerySourceAuthorization	Token que identifica o usuário para o qual a consulta está sendo executada. Esse token é usado para impor restrições de segurança em documentos.

Propriedades herdadas

abortSignal	O sinal que pode ser usado para anular solicitações.
onResponse	Uma função a ser chamada sempre que uma resposta é recebida do servidor durante a execução da operação solicitada. Pode ser chamado várias vezes.
requestOptions	Opções usadas ao criar e enviar solicitações HTTP para esta operação.
serializerOptions	Opções para substituir o comportamento de serialização/des serialização.
tracingOptions	Opções usadas quando o rastreamento está habilitado.

Detalhes da propriedade

selectedFields

Lista de nomes de campo a serem recuperados para o documento; Qualquer campo não recuperado estará ausente do documento retornado.

selectedFields?: SelectArray<TFields>

Valor da propriedade

SelectArray<TFields>

xMsEnableElevatedRead

Um valor que permite a leitura elevada que ignora as verificações de permissão no nível do documento para a operação de consulta.

xMsEnableElevatedRead?: boolean

Valor da propriedade

boolean

xMsQuerySourceAuthorization

Token que identifica o usuário para o qual a consulta está sendo executada. Esse token é usado para impor restrições de segurança em documentos.

xMsQuerySourceAuthorization?: string

Valor da propriedade

string

Detalhes das propriedades herdadas

abortSignal

O sinal que pode ser usado para anular solicitações.

abortSignal?: AbortSignalLike

Valor da propriedade

AbortSignalLike

Herdado de OperationOptions.abortSignal

onResponse

Uma função a ser chamada sempre que uma resposta é recebida do servidor durante a execução da operação solicitada. Pode ser chamado várias vezes.

onResponse?: RawResponseCallback

Valor da propriedade

RawResponseCallback

Herdado de OperationOptions.onResponse

requestOptions

Opções usadas ao criar e enviar solicitações HTTP para esta operação.

requestOptions?: OperationRequestOptions

Valor da propriedade

OperationRequestOptions

Herdado de OperationOptions.requestOptions

serializerOptions

Opções para substituir o comportamento de serialização/des serialização.

serializerOptions?: SerializerOptions

Valor da propriedade

SerializerOptions

herdado de OperationOptions.serializerOptions

tracingOptions

Opções usadas quando o rastreamento está habilitado.

tracingOptions?: OperationTracingOptions

Valor da propriedade

OperationTracingOptions

Herdado de OperationOptions.tracingOptions