DocumentSuggestResponse<T> Class

 

Applies To: Microsoft Azure

Response containing suggestion query results from an Azure Search index.

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

Inheritance Hierarchy

System.Object
  Hyak.Common.HttpOperationResponse
    Microsoft.Azure.AzureOperationResponse
      Microsoft.Azure.Search.Models.DocumentSuggestResponseBase<TResult, TDoc>
        Microsoft.Azure.Search.Models.DocumentSuggestResponse<T>

Syntax

public class DocumentSuggestResponse<T> : DocumentSuggestResponseBase<SuggestResult<T>, T>
where T : class
generic<typename T>
where T : ref class
public ref class DocumentSuggestResponse : DocumentSuggestResponseBase<SuggestResult<T>^, T>
type DocumentSuggestResponse<'T when 'T : not struct> = 
    class
        inherit DocumentSuggestResponseBase<SuggestResult<'T>, 'T>
    end
Public Class DocumentSuggestResponse(Of T As Class)
    Inherits DocumentSuggestResponseBase(Of SuggestResult(Of T), T)

Type Parameters

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

Constructors

Name Description
System_CAPS_pubmethod DocumentSuggestResponse<T>()

Initializes a new instance of the DocumentSuggestResponse class.

Properties

Name Description
System_CAPS_pubproperty Coverage

Gets a value indicating the percentage of the index that was included in the query, or null if MinimumCoverage was not set in the SuggestParameters. (Inherited from DocumentSuggestResponseBase<TResult, TDoc>.)

System_CAPS_pubproperty RequestId

(Inherited from AzureOperationResponse.)

System_CAPS_pubproperty Results

Gets the sequence of results returned by the query. (Inherited from DocumentSuggestResponseBase<TResult, TDoc>.)

System_CAPS_pubproperty StatusCode

(Inherited from HttpOperationResponse.)

Methods

Name Description
System_CAPS_pubmethod Equals(Object)

(Inherited from Object.)

System_CAPS_protmethod Finalize()

(Inherited from Object.)

System_CAPS_pubmethod GetEnumerator()

Gets the sequence of Results. (Inherited from DocumentSuggestResponseBase<TResult, TDoc>.)

System_CAPS_pubmethod GetHashCode()

(Inherited from Object.)

System_CAPS_pubmethod GetType()

(Inherited from Object.)

System_CAPS_protmethod MemberwiseClone()

(Inherited from Object.)

System_CAPS_pubmethod ToString()

(Inherited from Object.)

Explicit Interface Implementations

Name Description
System_CAPS_pubinterfaceSystem_CAPS_privmethod IEnumerable.GetEnumerator()

Gets the sequence of Results. (Inherited from DocumentSuggestResponseBase<TResult, TDoc>.)

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.

See Also

Microsoft.Azure.Search.Models Namespace

Return to top