DocumentsOperationsExtensions.GetAsync メソッド
定義
重要
一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。
オーバーロード
GetAsync(IDocumentsOperations, String, IEnumerable<String>, SearchRequestOptions, CancellationToken)
検索インデックスからドキュメントを取得します。 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)パラメーター
- operations
- IDocumentsOperations
この拡張メソッドの操作グループ。
- key
- String
取得するドキュメントのキー。有効なドキュメント キーを作成するための規則については、以下を参照してください https://docs.microsoft.com/rest/api/searchservice/Naming-rules 。
- selectedFields
- IEnumerable<String>
ドキュメント用に取得するフィールド名の一覧。取得されないフィールドは、返されたドキュメントに表示されません。
- searchRequestOptions
- SearchRequestOptions
操作の追加パラメーター
- cancellationToken
- CancellationToken
キャンセル トークン。
戻り値
要求されたドキュメント。
注釈
Get、GetAsync、GetWithHttpMessagesAsync メソッドの非ジェネリック オーバーロードでは、応答ペイロード内の JSON 型を .NET 型にマップするためのベスト エフォートの試行が行われます。 詳細については、「 GetWithHttpMessagesAsync(String, IEnumerable<String>, SearchRequestOptions, Dictionary<String,List<String>>, CancellationToken) 」を参照してください。
適用対象
GetAsync<T>(IDocumentsOperations, String, IEnumerable<String>, SearchRequestOptions, CancellationToken)
検索インデックスからドキュメントを取得します。 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)型パラメーター
- T
インデックス スキーマにマッピングされる CLR タイプ。 この型のインスタンスは、インデックスからドキュメントとして取得できます。
パラメーター
- operations
- IDocumentsOperations
この拡張メソッドの操作グループ。
- key
- String
取得するドキュメントのキー。有効なドキュメント キーを作成するための規則については、以下を参照してください https://docs.microsoft.com/rest/api/searchservice/Naming-rules 。
- selectedFields
- IEnumerable<String>
ドキュメント用に取得するフィールド名の一覧。取得されないフィールドは、返されるオブジェクトの対応するプロパティ値として null または既定値になります。 既定では、取得可能なすべてのフィールドが結果に含まれます。
- searchRequestOptions
- SearchRequestOptions
操作の追加パラメーター
- cancellationToken
- CancellationToken
キャンセル トークン。
戻り値
要求されたドキュメント。
注釈
Get、GetAsync、GetWithHttpMessagesAsync メソッドのジェネリック オーバーロードでは、型パラメーター T を使用した Azure Search フィールド型と .NET 型のマッピングがサポートされています。型マッピングの詳細については、以下を参照してください GetWithHttpMessagesAsync<T>(String, IEnumerable<String>, SearchRequestOptions, Dictionary<String,List<String>>, CancellationToken) 。
適用対象
Azure SDK for .NET