Class UpdateByQueryResponse

Inheritance
object
ResponseBase
UpdateByQueryResponse
Implements
Inherited Members
Namespace: OpenSearch.Client
Assembly: OpenSearch.Client.dll
Syntax
public class UpdateByQueryResponse : ResponseBase, IResponse, IOpenSearchResponse

Properties

| Edit this page View Source

Batches

Declaration
[DataMember(Name = "batches")]
public long Batches { get; }
Property Value
Type Description
long
| Edit this page View Source

Failures

Declaration
[DataMember(Name = "failures")]
public IReadOnlyCollection<BulkIndexByScrollFailure> Failures { get; }
Property Value
Type Description
IReadOnlyCollection<BulkIndexByScrollFailure>
| 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

Noops

Declaration
[DataMember(Name = "noops")]
public long Noops { get; }
Property Value
Type Description
long
| Edit this page View Source

RequestsPerSecond

Declaration
[DataMember(Name = "requests_per_second")]
public float RequestsPerSecond { get; }
Property Value
Type Description
float
| Edit this page View Source

Retries

Declaration
[DataMember(Name = "retries")]
public Retries Retries { get; }
Property Value
Type Description
Retries
| Edit this page View Source

Task

Only has a value if WaitForCompletion is set to false on the request

Declaration
[DataMember(Name = "task")]
public TaskId Task { get; }
Property Value
Type Description
TaskId
| Edit this page View Source

TimedOut

Declaration
[DataMember(Name = "timed_out")]
public bool TimedOut { get; }
Property Value
Type Description
bool
| Edit this page View Source

Took

Declaration
[DataMember(Name = "took")]
public long Took { get; }
Property Value
Type Description
long
| Edit this page View Source

Total

Declaration
[DataMember(Name = "total")]
public long Total { get; }
Property Value
Type Description
long
| Edit this page View Source

Updated

Declaration
[DataMember(Name = "updated")]
public long Updated { get; }
Property Value
Type Description
long
| Edit this page View Source

VersionConflicts

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

Implements

Extension Methods