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:

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

Enclosing class:

ClusterIndicesShards

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

Builder for ClusterIndicesShards.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
ClusterIndicesShards	build()	Builds a ClusterIndicesShards.
ClusterIndicesShards.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final ClusterIndicesShards.Builder	index(Function<ClusterIndicesShardsIndex.Builder,ObjectBuilder<ClusterIndicesShardsIndex>> fn)	API name: index
final ClusterIndicesShards.Builder	index(ClusterIndicesShardsIndex value)	API name: index
final ClusterIndicesShards.Builder	primaries(Integer value)	Number of primary shards assigned to selected nodes.
final ClusterIndicesShards.Builder	replication(Integer value)	Ratio of replica shards to primary shards across all selected nodes.
final ClusterIndicesShards.Builder	total(Integer value)	Total number of 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 ClusterIndicesShards.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<ClusterIndicesShards.Builder,ClusterIndicesShards>

Returns:

a new builder instance.

index

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

API name: index

index

@Nonnull
public final ClusterIndicesShards.Builder index(Function<ClusterIndicesShardsIndex.Builder,ObjectBuilder<ClusterIndicesShardsIndex>> fn)

API name: index

primaries

@Nonnull
public final ClusterIndicesShards.Builder primaries(@Nullable
 Integer value)

Number of primary shards assigned to selected nodes.

API name: primaries

replication

@Nonnull
public final ClusterIndicesShards.Builder replication(@Nullable
 Integer value)

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

API name: replication

total

@Nonnull
public final ClusterIndicesShards.Builder total(@Nullable
 Integer value)

Total number of shards assigned to selected nodes.

API name: total

build

@Nonnull
public ClusterIndicesShards build()

Builds a ClusterIndicesShards.

Specified by:

build in interface ObjectBuilder<ClusterIndicesShards>

Throws:

NullPointerException - if some of the required fields are null.