DocumentsOperationsExtensions.GetAsync Methode

Definition

Namespace:

Microsoft.Azure.Search

Assembly:

Microsoft.Azure.Search.Data.dll

Paket:

Microsoft.Azure.Search.Data v10.1.0

Überlädt

GetAsync(IDocumentsOperations, String, IEnumerable<String>, SearchRequestOptions, CancellationToken)	Ruft ein Dokument aus dem Suchindex ab. https://docs.microsoft.com/rest/api/searchservice/Lookup-Document
GetAsync<T>(IDocumentsOperations, String, IEnumerable<String>, SearchRequestOptions, CancellationToken)	Ruft ein Dokument aus dem Suchindex ab. https://docs.microsoft.com/rest/api/searchservice/Lookup-Document

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

Quelle:

DocumentsOperationsExtensions.cs

Ruft ein Dokument aus dem Suchindex ab. 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)

Parameter

operations

IDocumentsOperations

Die Vorgangsgruppe für diese Erweiterungsmethode.

key

String

Der Schlüssel des abzurufenden Dokuments; Die Regeln zum Erstellen gültiger Dokumentschlüssel finden Sie unter https://docs.microsoft.com/rest/api/searchservice/Naming-rules .

selectedFields

IEnumerable<String>

Liste der Feldnamen, die für das Dokument abgerufen werden sollen; Alle nicht abgerufenen Felder fehlen im zurückgegebenen Dokument.

searchRequestOptions

SearchRequestOptions

Zusätzliche Parameter für den Vorgang

cancellationToken

CancellationToken

Das Abbruchtoken.

Gibt zurück

Task<Document>

Das angeforderte Dokument.

Hinweise

Die nicht generischen Überladungen der Methoden Get, GetAsync und GetWithHttpMessagesAsync versuchen, JSON-Typen in der Antwortnutzlast .NET-Typen zuzuordnen. Weitere Informationen finden Sie unter GetWithHttpMessagesAsync(String, IEnumerable<String>, SearchRequestOptions, Dictionary<String,List<String>>, CancellationToken).

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

Quelle:

DocumentsOperationsExtensions.cs

Ruft ein Dokument aus dem Suchindex ab. 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)

Typparameter

T

Der CLR-Typ, der dem Indexschema zugeordnet wird. Instanzen dieses Typs können als Dokumente aus dem Index abgerufen werden.

Parameter

operations

IDocumentsOperations

Die Vorgangsgruppe für diese Erweiterungsmethode.

key

String

Der Schlüssel des abzurufenden Dokuments; Die Regeln zum Erstellen gültiger Dokumentschlüssel finden Sie unter https://docs.microsoft.com/rest/api/searchservice/Naming-rules .

selectedFields

IEnumerable<String>

Liste der Feldnamen, die für das Dokument abgerufen werden sollen; Jedes nicht abgerufene Feld weist null oder default als entsprechenden Eigenschaftswert im zurückgegebenen Objekt auf. Alle abrufbaren Felder sind standardmäßig im Ergebnis enthalten.

searchRequestOptions

SearchRequestOptions

Zusätzliche Parameter für den Vorgang

cancellationToken

CancellationToken

Das Abbruchtoken.

Gibt zurück

Task<T>

Das angeforderte Dokument.

Hinweise

Die generischen Überladungen der Methoden Get, GetAsync und GetWithHttpMessagesAsync unterstützen die Zuordnung von Azure Search-Feldtypen zu .NET-Typen über den Typparameter T. Weitere Informationen zur Typzuordnung finden Sie GetWithHttpMessagesAsync<T>(String, IEnumerable<String>, SearchRequestOptions, Dictionary<String,List<String>>, CancellationToken) unter.