DocumentSearchResponseBase<TResult, TDoc> Class

Article
10/31/2015
2 minutes to read

Applies To: Microsoft Azure

Response containing search 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.DocumentSearchResponseBase<TResult, TDoc>
Microsoft.Azure.Search.Models.DocumentSearchResponse
Microsoft.Azure.Search.Models.DocumentSearchResponse<T>

Syntax

public class DocumentSearchResponseBase<TResult, TDoc> : AzureOperationResponse, 
    IEnumerable<TResult>, IEnumerable
where TResult : SearchResultBase<TDoc>
where TDoc : class

generic<typename TResult, typename TDoc>
where TResult : SearchResultBase<TDoc>
where TDoc : ref class
public ref class DocumentSearchResponseBase : AzureOperationResponse, 
    IEnumerable<TResult>, IEnumerable

type DocumentSearchResponseBase<'TResult, 'TDoc when 'TResult : SearchResultBase<'TDoc> when 'TDoc : not struct> = 
    class
        inherit AzureOperationResponse
        interface IEnumerable<'TResult>
        interface IEnumerable
    end

Public Class DocumentSearchResponseBase(Of TResult As SearchResultBase(Of TDoc), TDoc As Class)
    Inherits AzureOperationResponse
    Implements IEnumerable(Of TResult), IEnumerable

Type Parameters

TResult
Type of the model class that encapsulates documents in a search response.

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

Constructors

	Name	Description
	DocumentSearchResponseBase<TResult, TDoc>()	Initializes a new instance of the DocumentSearchResponseBase class.

Properties

	Name	Description
	ContinuationToken	Gets a continuation token that can be used to fetch the next page of search results from an Azure Search index.
	Count	Gets the total count of results found by the search operation, or null if the count was not requested.
	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 SearchParameters.
	Facets	Gets the facet query results for the search operation, or null if the query did not include any facet expressions.
	RequestId	(Inherited from AzureOperationResponse.)
	Results	Gets the sequence of results returned by the query.
	StatusCode	(Inherited from HttpOperationResponse.)

Methods

	Name	Description
	Equals(Object)	(Inherited from Object.)
	Finalize()	(Inherited from Object.)
	GetEnumerator()	Gets the sequence of Results.
	GetHashCode()	(Inherited from Object.)
	GetType()	(Inherited from Object.)
	MemberwiseClone()	(Inherited from Object.)
	ToString()	(Inherited from Object.)