Package org.opensearch.client.opensearch._types

Class NodeStatistics.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch._types.NodeStatistics.Builder

All Implemented Interfaces:

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

Enclosing class:

NodeStatistics

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

Builder for NodeStatistics.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
NodeStatistics	build()	Builds a NodeStatistics.
NodeStatistics.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final NodeStatistics.Builder	failed(int value)	Required - The number of nodes that rejected the request or failed to respond.
final NodeStatistics.Builder	failures(Function<ErrorCause.Builder,ObjectBuilder<ErrorCause>> fn)	API name: failures
final NodeStatistics.Builder	failures(List<ErrorCause> list)	API name: failures
final NodeStatistics.Builder	failures(ErrorCause value, ErrorCause... values)	API name: failures
final NodeStatistics.Builder	successful(int value)	Required - The number of nodes that responded successfully to the request.
final NodeStatistics.Builder	total(int value)	Required - The total number of nodes selected by the request.

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 NodeStatistics.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<NodeStatistics.Builder,NodeStatistics>

Returns:

a new builder instance.

failed

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

Required - The number of nodes that rejected the request or failed to respond. If this value is not 0, then a reason for the rejection or failure is included in the response.

API name: failed

failures

@Nonnull
public final NodeStatistics.Builder failures(List<ErrorCause> list)

API name: failures

Adds all elements of list to failures.

failures

@Nonnull
public final NodeStatistics.Builder failures(ErrorCause value,
 ErrorCause... values)

API name: failures

Adds one or more values to failures.

failures

@Nonnull
public final NodeStatistics.Builder failures(Function<ErrorCause.Builder,ObjectBuilder<ErrorCause>> fn)

API name: failures

Adds a value to failures using a builder lambda.

successful

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

Required - The number of nodes that responded successfully to the request.

API name: successful

total

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

Required - The total number of nodes selected by the request.

API name: total

build

@Nonnull
public NodeStatistics build()

Builds a NodeStatistics.

Specified by:

build in interface ObjectBuilder<NodeStatistics>

Throws:

NullPointerException - if some of the required fields are null.