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

Class ClusterIndicesShards.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch.cluster.stats.ClusterIndicesShards.Builder

All Implemented Interfaces:

ObjectBuilder<ClusterIndicesShards>

Enclosing class:

ClusterIndicesShards

public static class ClusterIndicesShards.Builder
extends ObjectBuilderBase
implements ObjectBuilder<ClusterIndicesShards>

Builder for ClusterIndicesShards.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
ClusterIndicesShards	build()	Builds a ClusterIndicesShards.
ClusterIndicesShards.Builder	index(java.util.function.Function<ClusterIndicesShardsIndex.Builder,ObjectBuilder<ClusterIndicesShardsIndex>> fn)	Contains statistics about shards assigned to selected nodes.
ClusterIndicesShards.Builder	index(ClusterIndicesShardsIndex value)	Contains statistics about shards assigned to selected nodes.
ClusterIndicesShards.Builder	primaries(java.lang.Double value)	Number of primary shards assigned to selected nodes.
ClusterIndicesShards.Builder	replication(java.lang.Double value)	Ratio of replica shards to primary shards across all selected nodes.
ClusterIndicesShards.Builder	total(java.lang.Double value)	Total number of shards assigned to selected nodes.

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

_checkSingleUse, _listAdd, _listAddAll, _mapPut, _mapPutAll

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

index

public final ClusterIndicesShards.Builder index(@Nullable
                                                ClusterIndicesShardsIndex value)

Contains statistics about shards assigned to selected nodes.

API name: index

index

public final ClusterIndicesShards.Builder index(java.util.function.Function<ClusterIndicesShardsIndex.Builder,ObjectBuilder<ClusterIndicesShardsIndex>> fn)

Contains statistics about shards assigned to selected nodes.

API name: index

primaries

public final ClusterIndicesShards.Builder primaries(@Nullable
                                                    java.lang.Double value)

Number of primary shards assigned to selected nodes.

API name: primaries

replication

public final ClusterIndicesShards.Builder replication(@Nullable
                                                      java.lang.Double value)

Ratio of replica shards to primary shards across all selected nodes.

API name: replication

total

public final ClusterIndicesShards.Builder total(@Nullable
                                                java.lang.Double value)

Total number of shards assigned to selected nodes.

API name: total

build

public ClusterIndicesShards build()

Builds a ClusterIndicesShards.

Specified by:

build in interface ObjectBuilder<ClusterIndicesShards>

Throws:

java.lang.NullPointerException - if some of the required fields are null.