Package org.opensearch.client.opensearch.cluster.stats

Class ClusterShardMetrics.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch.cluster.stats.ClusterShardMetrics.Builder

All Implemented Interfaces:

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

Enclosing class:

ClusterShardMetrics

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

Builder for ClusterShardMetrics.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
final ClusterShardMetrics.Builder	avg(double value)	Required - Mean number of shards in an index, counting only shards assigned to selected nodes.
ClusterShardMetrics	build()	Builds a ClusterShardMetrics.
ClusterShardMetrics.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final ClusterShardMetrics.Builder	max(double value)	Required - Maximum number of shards in an index, counting only shards assigned to selected nodes.
final ClusterShardMetrics.Builder	min(double value)	Required - Minimum number of shards in an index, counting only shards assigned to selected nodes.

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

Returns:

a new builder instance.

avg

@Nonnull
public final ClusterShardMetrics.Builder avg(double value)

Required - Mean number of shards in an index, counting only shards assigned to selected nodes.

API name: avg

max

@Nonnull
public final ClusterShardMetrics.Builder max(double value)

Required - Maximum number of shards in an index, counting only shards assigned to selected nodes.

API name: max

min

@Nonnull
public final ClusterShardMetrics.Builder min(double value)

Required - Minimum number of shards in an index, counting only shards assigned to selected nodes.

API name: min

build

@Nonnull
public ClusterShardMetrics build()

Builds a ClusterShardMetrics.

Specified by:

build in interface ObjectBuilder<ClusterShardMetrics>

Throws:

NullPointerException - if some of the required fields are null.