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

Class ShardPath.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch.indices.stats.ShardPath.Builder

All Implemented Interfaces:

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

Enclosing class:

ShardPath

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

Builder for ShardPath.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
ShardPath	build()	Builds a ShardPath.
ShardPath.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final ShardPath.Builder	dataPath(String value)	Required - The path to the shard's data.
final ShardPath.Builder	isCustomDataPath(boolean value)	Required - Whether the shard uses a custom data path.
final ShardPath.Builder	statePath(String value)	Required - The path to the shard's 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 ShardPath.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<ShardPath.Builder,ShardPath>

Returns:

a new builder instance.

dataPath

@Nonnull
public final ShardPath.Builder dataPath(String value)

Required - The path to the shard's data.

API name: data_path

isCustomDataPath

@Nonnull
public final ShardPath.Builder isCustomDataPath(boolean value)

Required - Whether the shard uses a custom data path.

API name: is_custom_data_path

statePath

@Nonnull
public final ShardPath.Builder statePath(String value)

Required - The path to the shard's state.

API name: state_path

build

@Nonnull
public ShardPath build()

Builds a ShardPath.

Specified by:

build in interface ObjectBuilder<ShardPath>

Throws:

NullPointerException - if some of the required fields are null.