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

Class ClusterIndicesShards.Builder

java.lang.Object

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

All Implemented Interfaces:

ObjectBuilder<ClusterIndicesShards>

Enclosing class:

ClusterIndicesShards

public static class ClusterIndicesShards.Builder
extends java.lang.Object
implements ObjectBuilder<ClusterIndicesShards>

Builder for ClusterIndicesShards.

Nested Class Summary

Nested classes/interfaces inherited from interface org.opensearch.client.util.ObjectBuilder

ObjectBuilder.Constant<V>

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.Number value)	Number of primary shards assigned to selected nodes.
ClusterIndicesShards.Builder	replication(java.lang.Number value)	Ratio of replica shards to primary shards across all selected nodes.
ClusterIndicesShards.Builder	total(java.lang.Number value)	Total number of shards assigned to selected nodes.

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

index

public ClusterIndicesShards.Builder index(@Nullable ClusterIndicesShardsIndex value)

Contains statistics about shards assigned to selected nodes. API name: index

index

public 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 ClusterIndicesShards.Builder primaries(@Nullable java.lang.Number value)

Number of primary shards assigned to selected nodes. API name: primaries

replication

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

Ratio of replica shards to primary shards across all selected nodes. API name: replication

total

public ClusterIndicesShards.Builder total(@Nullable java.lang.Number 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.