Package org.opensearch.client.opensearch._types

Class NodeShard.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch._types.NodeShard.Builder

All Implemented Interfaces:

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

Enclosing class:

NodeShard

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

Builder for NodeShard.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
final NodeShard.Builder	allocationId(String key, String value)	API name: allocation_id
final NodeShard.Builder	allocationId(Map<String,String> map)	API name: allocation_id
NodeShard	build()	Builds a NodeShard.
NodeShard.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final NodeShard.Builder	index(String value)	Required - API name: index
final NodeShard.Builder	node(String value)	API name: node
final NodeShard.Builder	primary(boolean value)	Required - API name: primary
final NodeShard.Builder	recoverySource(String key, String value)	The recovery source information for this shard.
final NodeShard.Builder	recoverySource(Map<String,String> map)	The recovery source information for this shard.
final NodeShard.Builder	relocatingNode(String value)	API name: relocating_node
final NodeShard.Builder	searchOnly(Boolean value)	Indicates if this shard is configured for search operations only
final NodeShard.Builder	shard(int value)	Required - API name: shard
final NodeShard.Builder	state(ShardRoutingState value)	Required - API name: state
final NodeShard.Builder	unassignedInfo(Function<UnassignedInformation.Builder,ObjectBuilder<UnassignedInformation>> fn)	API name: unassigned_info
final NodeShard.Builder	unassignedInfo(UnassignedInformation value)	API name: unassigned_info

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

Returns:

a new builder instance.

allocationId

@Nonnull
public final NodeShard.Builder allocationId(Map<String,String> map)

API name: allocation_id

Adds all elements of map to allocationId.

allocationId

@Nonnull
public final NodeShard.Builder allocationId(String key,
 String value)

API name: allocation_id

Adds an entry to allocationId.

index

@Nonnull
public final NodeShard.Builder index(String value)

Required - API name: index

node

@Nonnull
public final NodeShard.Builder node(@Nullable
 String value)

API name: node

primary

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

Required - API name: primary

recoverySource

@Nonnull
public final NodeShard.Builder recoverySource(Map<String,String> map)

The recovery source information for this shard.

API name: recovery_source

Adds all elements of map to recoverySource.

recoverySource

@Nonnull
public final NodeShard.Builder recoverySource(String key,
 String value)

The recovery source information for this shard.

API name: recovery_source

Adds an entry to recoverySource.

relocatingNode

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

API name: relocating_node

searchOnly

@Nonnull
public final NodeShard.Builder searchOnly(@Nullable
 Boolean value)

Indicates if this shard is configured for search operations only

API name: searchOnly

shard

@Nonnull
public final NodeShard.Builder shard(int value)

Required - API name: shard

state

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

Required - API name: state

unassignedInfo

@Nonnull
public final NodeShard.Builder unassignedInfo(@Nullable
 UnassignedInformation value)

API name: unassigned_info

unassignedInfo

@Nonnull
public final NodeShard.Builder unassignedInfo(Function<UnassignedInformation.Builder,ObjectBuilder<UnassignedInformation>> fn)

API name: unassigned_info

build

@Nonnull
public NodeShard build()

Builds a NodeShard.

Specified by:

build in interface ObjectBuilder<NodeShard>

Throws:

NullPointerException - if some of the required fields are null.