GetDocumentOptions interface

Pacote:

@azure/search-documents

Opções para recuperar um único documento.

Extends

OperationOptions

Propriedades

selectedFields	Lista de nomes de campos a recuperar para o documento; Qualquer campo não recuperado estará ausente do documento devolvido.
xMsEnableElevatedRead	Um valor que permite 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. Este token é usado para impor restrições de segurança em documentos.

Propriedades Herdadas

abortSignal	O sinal que pode ser usado para abortar solicitações.
onResponse	Uma função a ser chamada cada vez 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/desserialização.
tracingOptions	Opções usadas quando o rastreamento está habilitado.

Detalhes de Propriedade

selectedFields

Lista de nomes de campos a recuperar para o documento; Qualquer campo não recuperado estará ausente do documento devolvido.

selectedFields?: SelectArray<TFields>

Valor de Propriedade

SelectArray<TFields>

xMsEnableElevatedRead

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

xMsEnableElevatedRead?: boolean

Valor de Propriedade

boolean

xMsQuerySourceAuthorization

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

xMsQuerySourceAuthorization?: string

Valor de Propriedade

string

Detalhes da Propriedade Herdada

abortSignal

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

abortSignal?: AbortSignalLike

Valor de Propriedade

AbortSignalLike

Herdado de OperationOptions.abortSignal

onResponse

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

onResponse?: RawResponseCallback

Valor de Propriedade

RawResponseCallback

Herdado de OperationOptions.onResponse

requestOptions

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

requestOptions?: OperationRequestOptions

Valor de Propriedade

OperationRequestOptions

Herdado de OperationOptions.requestOptions

serializerOptions

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

serializerOptions?: SerializerOptions

Valor de Propriedade

SerializerOptions

herdado de OperationOptions.serializerOptions

tracingOptions

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

tracingOptions?: OperationTracingOptions

Valor de Propriedade

OperationTracingOptions

Herdado de OperationOptions.tracingOptions