Class MultiGetResponse

Inheritance
object
ResponseBase
MultiGetResponse
Implements
Inherited Members
Namespace: OpenSearch.Client
Assembly: OpenSearch.Client.dll
Syntax
[DataContract]
public class MultiGetResponse : ResponseBase, IResponse, IOpenSearchResponse

Properties

| Edit this page View Source

Hits

Declaration
public IReadOnlyCollection<IMultiGetHit<object>> Hits { get; }
Property Value
Type Description
IReadOnlyCollection<IMultiGetHit<object>>
| Edit this page View Source

IsValid

Checks if a response is functionally valid or not. This is a OpenSearch.Client abstraction to have a single property to check whether there was something wrong with a request.

For instance, an OpenSearch bulk response always returns 200 and individual bulk items may fail, IsValid will be false in that case.

You can also configure the client to always throw an OpenSearchClientException using ThrowExceptions if the response is not valid

Declaration
public override bool IsValid { get; }
Property Value
Type Description
bool
Overrides

Methods

| Edit this page View Source

GetFieldSelection<T>(long)

Declaration
public FieldValues GetFieldSelection<T>(long id) where T : class
Parameters
Type Name Description
long id
Returns
Type Description
FieldValues
Type Parameters
Name Description
T
| Edit this page View Source

GetFieldValues<T>(string)

Declaration
public FieldValues GetFieldValues<T>(string id) where T : class
Parameters
Type Name Description
string id
Returns
Type Description
FieldValues
Type Parameters
Name Description
T
| Edit this page View Source

GetMany<T>(IEnumerable<long>)

Declaration
public IEnumerable<IMultiGetHit<T>> GetMany<T>(IEnumerable<long> ids) where T : class
Parameters
Type Name Description
IEnumerable<long> ids
Returns
Type Description
IEnumerable<IMultiGetHit<T>>
Type Parameters
Name Description
T
| Edit this page View Source

GetMany<T>(IEnumerable<string>)

Retrieves the hits for each distinct id.

Declaration
public IEnumerable<IMultiGetHit<T>> GetMany<T>(IEnumerable<string> ids) where T : class
Parameters
Type Name Description
IEnumerable<string> ids

The ids to retrieve source for
Returns
Type Description
IEnumerable<IMultiGetHit<T>>

An IEnumerable{T} of hits
Type Parameters
Name Description
T

The document type for the hits to return
| Edit this page View Source

Get<T>(long)

Declaration
public MultiGetHit<T> Get<T>(long id) where T : class
Parameters
Type Name Description
long id
Returns
Type Description
MultiGetHit<T>
Type Parameters
Name Description
T
| Edit this page View Source

Get<T>(string)

Declaration
public MultiGetHit<T> Get<T>(string id) where T : class
Parameters
Type Name Description
string id
Returns
Type Description
MultiGetHit<T>
Type Parameters
Name Description
T
| Edit this page View Source

SourceMany<T>(IEnumerable<long>)

Declaration
public IEnumerable<T> SourceMany<T>(IEnumerable<long> ids) where T : class
Parameters
Type Name Description
IEnumerable<long> ids
Returns
Type Description
IEnumerable<T>
Type Parameters
Name Description
T
| Edit this page View Source

SourceMany<T>(IEnumerable<string>)

Retrieves the source, if available, for each distinct id.

Declaration
public IEnumerable<T> SourceMany<T>(IEnumerable<string> ids) where T : class
Parameters
Type Name Description
IEnumerable<string> ids

The ids to retrieve source for
Returns
Type Description
IEnumerable<T>

An IEnumerable{T} of sources
Type Parameters
Name Description
T

The document type for the hits to return
| Edit this page View Source

Source<T>(long)

Declaration
public T Source<T>(long id) where T : class
Parameters
Type Name Description
long id
Returns
Type Description
T
Type Parameters
Name Description
T
| Edit this page View Source

Source<T>(string)

Declaration
public T Source<T>(string id) where T : class
Parameters
Type Name Description
string id
Returns
Type Description
T
Type Parameters
Name Description
T

Implements

Extension Methods