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

Class ShardPath

java.lang.Object

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

All Implemented Interfaces:

JsonpSerializable, PlainJsonSerializable, ToCopyableBuilder<ShardPath.Builder,ShardPath>

@JsonpDeserializable
@Generated("org.opensearch.client.codegen.CodeGenerator")
public class ShardPath
extends Object
implements PlainJsonSerializable, ToCopyableBuilder<ShardPath.Builder,ShardPath>

The path information for a shard.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ShardPath.Builder	Builder for ShardPath.

Field Summary

Fields

Modifier and Type	Field	Description
static final JsonpDeserializer<ShardPath>	_DESERIALIZER	Json deserializer for ShardPath

Method Summary

Modifier and Type	Method	Description
static ShardPath.Builder	builder()
final String	dataPath()	Required - The path to the shard's data.
boolean	equals(Object o)
int	hashCode()
final boolean	isCustomDataPath()	Required - Whether the shard uses a custom data path.
static ShardPath	of(Function<ShardPath.Builder,ObjectBuilder<ShardPath>> fn)
void	serialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)	Serialize this object to JSON.
protected void	serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
protected static void	setupShardPathDeserializer(ObjectDeserializer<ShardPath.Builder> op)
final String	statePath()	Required - The path to the shard's state.
ShardPath.Builder	toBuilder()	Create a new builder ToCopyableBuilder that is initialised with the current state of this object.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opensearch.client.json.PlainJsonSerializable

toJsonString

Methods inherited from interface org.opensearch.client.util.ToCopyableBuilder

copy

Field Details

_DESERIALIZER

public static final JsonpDeserializer<ShardPath> _DESERIALIZER

Json deserializer for ShardPath

Method Details

of

public static ShardPath of(Function<ShardPath.Builder,ObjectBuilder<ShardPath>> fn)

dataPath

@Nonnull
public final String dataPath()

Required - The path to the shard's data.

API name: data_path

isCustomDataPath

public final boolean isCustomDataPath()

Required - Whether the shard uses a custom data path.

API name: is_custom_data_path

statePath

@Nonnull
public final String statePath()

Required - The path to the shard's state.

API name: state_path

serialize

public void serialize(jakarta.json.stream.JsonGenerator generator,
 JsonpMapper mapper)

Serialize this object to JSON.

Specified by:

serialize in interface JsonpSerializable

serializeInternal

protected void serializeInternal(jakarta.json.stream.JsonGenerator generator,
 JsonpMapper mapper)

toBuilder

@Nonnull
public ShardPath.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Create a new builder ToCopyableBuilder that is initialised with the current state of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<ShardPath.Builder,ShardPath>

Returns:

a new builder instance.

builder

@Nonnull
public static ShardPath.Builder builder()

setupShardPathDeserializer

protected static void setupShardPathDeserializer(ObjectDeserializer<ShardPath.Builder> op)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object