Package org.opensearch.client.opensearch.indices.stats

Class ShardRouting.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch.indices.stats.ShardRouting.Builder

All Implemented Interfaces:

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

Enclosing class:

ShardRouting

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

Builder for ShardRouting.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
ShardRouting	build()	Builds a ShardRouting.
ShardRouting.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final ShardRouting.Builder	node(String value)	Required - The node containing the shard.
final ShardRouting.Builder	primary(boolean value)	Required - Whether this is a primary shard.
final ShardRouting.Builder	relocatingNode(String value)	The node where the shard is relocating to.
final ShardRouting.Builder	state(ShardRoutingState value)	Required - API name: state

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

Returns:

a new builder instance.

node

@Nonnull
public final ShardRouting.Builder node(String value)

Required - The node containing the shard.

API name: node

primary

@Nonnull
public final ShardRouting.Builder primary(boolean value)

Required - Whether this is a primary shard.

API name: primary

relocatingNode

@Nonnull
public final ShardRouting.Builder relocatingNode(@Nullable
 String value)

The node where the shard is relocating to.

API name: relocating_node

state

@Nonnull
public final ShardRouting.Builder state(ShardRoutingState value)

Required - API name: state

build

@Nonnull
public ShardRouting build()

Builds a ShardRouting.

Specified by:

build in interface ObjectBuilder<ShardRouting>

Throws:

NullPointerException - if some of the required fields are null.