Partilhar via


DocumentsOperationsExtensions.GetAsync Método

Definição

Sobrecargas

GetAsync(IDocumentsOperations, String, IEnumerable<String>, SearchRequestOptions, CancellationToken)

Recupera um documento do índice de pesquisa. https://docs.microsoft.com/rest/api/searchservice/Lookup-Document

GetAsync<T>(IDocumentsOperations, String, IEnumerable<String>, SearchRequestOptions, CancellationToken)

Recupera um documento do índice de pesquisa. https://docs.microsoft.com/rest/api/searchservice/Lookup-Document

GetAsync(IDocumentsOperations, String, IEnumerable<String>, SearchRequestOptions, CancellationToken)

Origem:
DocumentsOperationsExtensions.cs

Recupera um documento do índice de pesquisa. https://docs.microsoft.com/rest/api/searchservice/Lookup-Document

public static System.Threading.Tasks.Task<Microsoft.Azure.Search.Models.Document> GetAsync (this Microsoft.Azure.Search.IDocumentsOperations operations, string key, System.Collections.Generic.IEnumerable<string> selectedFields = default, Microsoft.Azure.Search.Models.SearchRequestOptions searchRequestOptions = default, System.Threading.CancellationToken cancellationToken = default);
static member GetAsync : Microsoft.Azure.Search.IDocumentsOperations * string * seq<string> * Microsoft.Azure.Search.Models.SearchRequestOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Search.Models.Document>
<Extension()>
Public Function GetAsync (operations As IDocumentsOperations, key As String, Optional selectedFields As IEnumerable(Of String) = Nothing, Optional searchRequestOptions As SearchRequestOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Document)

Parâmetros

operations
IDocumentsOperations

O grupo de operações para esse método de extensão.

key
String

A chave do documento a ser recuperado; Consulte https://docs.microsoft.com/rest/api/searchservice/Naming-rules as regras para construir chaves de documento válidas.

selectedFields
IEnumerable<String>

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

searchRequestOptions
SearchRequestOptions

Parâmetros adicionais para a operação

cancellationToken
CancellationToken

O token de cancelamento.

Retornos

O documento solicitado.

Comentários

As sobrecargas não genéricas dos métodos Get, GetAsync e GetWithHttpMessagesAsync fazem uma tentativa de melhor esforço para mapear tipos JSON na carga de resposta para tipos .NET. Consulte GetWithHttpMessagesAsync(String, IEnumerable<String>, SearchRequestOptions, Dictionary<String,List<String>>, CancellationToken) para obter mais informações.

Aplica-se a

GetAsync<T>(IDocumentsOperations, String, IEnumerable<String>, SearchRequestOptions, CancellationToken)

Origem:
DocumentsOperationsExtensions.cs

Recupera um documento do índice de pesquisa. https://docs.microsoft.com/rest/api/searchservice/Lookup-Document

public static System.Threading.Tasks.Task<T> GetAsync<T> (this Microsoft.Azure.Search.IDocumentsOperations operations, string key, System.Collections.Generic.IEnumerable<string> selectedFields = default, Microsoft.Azure.Search.Models.SearchRequestOptions searchRequestOptions = default, System.Threading.CancellationToken cancellationToken = default);
static member GetAsync : Microsoft.Azure.Search.IDocumentsOperations * string * seq<string> * Microsoft.Azure.Search.Models.SearchRequestOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<'T>
<Extension()>
Public Function GetAsync(Of T) (operations As IDocumentsOperations, key As String, Optional selectedFields As IEnumerable(Of String) = Nothing, Optional searchRequestOptions As SearchRequestOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of T)

Parâmetros de tipo

T

O tipo CLR que mapeia para o esquema de indexação. Instâncias desse tipo podem ser recuperadas como documentos do índice.

Parâmetros

operations
IDocumentsOperations

O grupo de operações para esse método de extensão.

key
String

A chave do documento a ser recuperado; Consulte https://docs.microsoft.com/rest/api/searchservice/Naming-rules as regras para construir chaves de documento válidas.

selectedFields
IEnumerable<String>

Lista de nomes de campo a serem recuperados para o documento; Qualquer campo não recuperado terá nulo ou padrão como seu valor de propriedade correspondente no objeto retornado. Todos os campos recuperáveis são incluídos no resultado por padrão.

searchRequestOptions
SearchRequestOptions

Parâmetros adicionais para a operação

cancellationToken
CancellationToken

O token de cancelamento.

Retornos

Task<T>

O documento solicitado.

Comentários

As sobrecargas genéricas dos métodos Get, GetAsync e GetWithHttpMessagesAsync dão suporte ao mapeamento de tipos de campo do Azure Search para tipos .NET por meio do parâmetro de tipo T. Consulte GetWithHttpMessagesAsync<T>(String, IEnumerable<String>, SearchRequestOptions, Dictionary<String,List<String>>, CancellationToken) para obter mais detalhes sobre o mapeamento de tipo.

Aplica-se a