Package org.opensearch.client.opensearch._types

Class ShardStatistics.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch._types.ShardStatistics.Builder

All Implemented Interfaces:

CopyableBuilder<ShardStatistics.Builder,ShardStatistics>, MutableBuilder<ShardStatistics.Builder,ShardStatistics>, ObjectBuilder<ShardStatistics>

Enclosing class:

ShardStatistics

public static class ShardStatistics.Builder
extends ObjectBuilderBase
implements CopyableBuilder<ShardStatistics.Builder,ShardStatistics>

Builder for ShardStatistics.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
ShardStatistics	build()	Builds a ShardStatistics.
ShardStatistics.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final ShardStatistics.Builder	failed(int value)	Required - API name: failed
final ShardStatistics.Builder	failures(Function<ShardFailure.Builder,ObjectBuilder<ShardFailure>> fn)	API name: failures
final ShardStatistics.Builder	failures(List<ShardFailure> list)	API name: failures
final ShardStatistics.Builder	failures(ShardFailure value, ShardFailure... values)	API name: failures
final ShardStatistics.Builder	skipped(Integer value)	API name: skipped
final ShardStatistics.Builder	successful(int value)	Required - API name: successful
final ShardStatistics.Builder	total(int value)	Required - API name: total

Methods inherited from class org.opensearch.client.util.ObjectBuilderBase

_checkSingleUse, _listAdd, _listAddAll, _listCopy, _mapCopy, _mapPut, _mapPutAll

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.opensearch.client.util.MutableBuilder

applyMutation

Constructor Details

Builder

public Builder()

Method Details

copy

@Nonnull
public ShardStatistics.Builder copy()

Description copied from interface: CopyableBuilder

Create a new builder CopyableBuilder that is a copy of this one.

Specified by:

copy in interface CopyableBuilder<ShardStatistics.Builder,ShardStatistics>

Returns:

a new builder instance.

failed

@Nonnull
public final ShardStatistics.Builder failed(int value)

Required - API name: failed

failures

@Nonnull
public final ShardStatistics.Builder failures(List<ShardFailure> list)

API name: failures

Adds all elements of list to failures.

failures

@Nonnull
public final ShardStatistics.Builder failures(ShardFailure value,
 ShardFailure... values)

API name: failures

Adds one or more values to failures.

failures

@Nonnull
public final ShardStatistics.Builder failures(Function<ShardFailure.Builder,ObjectBuilder<ShardFailure>> fn)

API name: failures

Adds a value to failures using a builder lambda.

skipped

@Nonnull
public final ShardStatistics.Builder skipped(@Nullable
 Integer value)

API name: skipped

successful

@Nonnull
public final ShardStatistics.Builder successful(int value)

Required - API name: successful

total

@Nonnull
public final ShardStatistics.Builder total(int value)

Required - API name: total

build

@Nonnull
public ShardStatistics build()

Builds a ShardStatistics.

Specified by:

build in interface ObjectBuilder<ShardStatistics>

Throws:

NullPointerException - if some of the required fields are null.