Class MultiSearchResponse

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

Constructors

| Edit this page View Source

MultiSearchResponse()

Declaration
public MultiSearchResponse()

Properties

| Edit this page View Source

AllResponses

Declaration
public IEnumerable<IResponse> AllResponses { get; }
Property Value
Type Description
IEnumerable<IResponse>
| 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
| Edit this page View Source

Took

Declaration
public long Took { get; set; }
Property Value
Type Description
long
| Edit this page View Source

TotalResponses

Declaration
public int TotalResponses { get; }
Property Value
Type Description
int

Methods

| Edit this page View Source

DebugIsValid(StringBuilder)

Subclasses can override this to provide more information on why a call is not valid.

Declaration
protected override void DebugIsValid(StringBuilder sb)
Parameters
Type Name Description
StringBuilder sb
Overrides
| Edit this page View Source

GetInvalidResponses()

Declaration
public IEnumerable<IResponse> GetInvalidResponses()
Returns
Type Description
IEnumerable<IResponse>
| Edit this page View Source

GetResponse<T>(string)

Declaration
public ISearchResponse<T> GetResponse<T>(string name) where T : class
Parameters
Type Name Description
string name
Returns
Type Description
ISearchResponse<T>
Type Parameters
Name Description
T
| Edit this page View Source

GetResponses<T>()

Declaration
public IEnumerable<ISearchResponse<T>> GetResponses<T>() where T : class
Returns
Type Description
IEnumerable<ISearchResponse<T>>
Type Parameters
Name Description
T

Implements

Extension Methods