DocumentOperationsExtensions.GetAsync Method (IDocumentOperations, String, IEnumerable)

Article
03/04/2015
2 minutes to read

Retrieves a document from the Azure Search index. (see https://msdn.microsoft.com/en-us/library/azure/dn798929.aspx for more information)

Namespace: Microsoft.Azure.Search
Assembly: Microsoft.Azure.Search (in Microsoft.Azure.Search.dll)

Usage

'Usage
Dim operations As IDocumentOperations
Dim key As String
Dim selectedFields As IEnumerable(Of String)
Dim returnValue As Task(Of DocumentGetResponse(Of T))

returnValue = DocumentOperationsExtensions.GetAsync(operations, key, selectedFields)

Syntax

'Declaration
<ExtensionAttribute> _
Public Shared Function GetAsync(Of T) ( _
    operations As IDocumentOperations, _
    key As String, _
    selectedFields As IEnumerable(Of String) _
) As Task(Of DocumentGetResponse(Of T))

[ExtensionAttribute] 
public static Task<DocumentGetResponse<T>> GetAsync<T> (
    IDocumentOperations operations,
    string key,
    IEnumerable<string> selectedFields
)

[ExtensionAttribute] 
public:
generic<typename T>
static Task<DocumentGetResponse<T>^>^ GetAsync (
    IDocumentOperations^ operations, 
    String^ key, 
    IEnumerable<String^>^ selectedFields
)

GenericParameters

T
The CLR type that maps to the index schema. Instances of this type can be retrieved as documents from the index.

Parameters

key
The key of the document to retrieve; See https://msdn.microsoft.com/en-us/library/azure/dn857353.aspx for the rules for constructing valid document keys.

selectedFields
List of field names to retrieve for the document; Any field not retrieved will have null or default as its corresponding property value in the returned object.

Return Value

Response containing the document.

Remarks

The generic overloads of the Get and GetAsync methods support mapping of Azure Search field types to .NET types via the type parameter T. See GetAsync(String,Generic IEnumerable,CancellationToken) for more details on the type mapping.

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Platforms

Development Platforms

Windows Vista, Windows 7, Windows Server 2008, Windows 8.1, Windows Server 2012 R2, Windows 8 and Windows Server 2012