Class BulkResponse

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

Properties

| Edit this page View Source

Errors

Declaration
[DataMember(Name = "errors")]
public bool Errors { get; }
Property Value
Type Description
bool
| 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

Items

Declaration
[DataMember(Name = "items")]
public IReadOnlyList<BulkResponseItemBase> Items { get; }
Property Value
Type Description
IReadOnlyList<BulkResponseItemBase>
| Edit this page View Source

ItemsWithErrors

Declaration
[IgnoreDataMember]
public IEnumerable<BulkResponseItemBase> ItemsWithErrors { get; }
Property Value
Type Description
IEnumerable<BulkResponseItemBase>
| Edit this page View Source

Took

Declaration
[DataMember(Name = "took")]
public long Took { get; }
Property Value
Type Description
long

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

Implements

Extension Methods