Package org.opensearch.client.opensearch._types

Class NodeShard

java.lang.Object

org.opensearch.client.opensearch._types.NodeShard

All Implemented Interfaces:

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

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

The information about a shard on a node.

Nested Class Summary

Nested Classes

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

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
java.util.Map<java.lang.String,java.lang.String>	allocationId()	API name: allocation_id
static NodeShard.Builder	builder()
boolean	equals(java.lang.Object o)
int	hashCode()
java.lang.String	index()	Required - API name: index
java.lang.String	node()	API name: node
static NodeShard	of(java.util.function.Function<NodeShard.Builder,ObjectBuilder<NodeShard>> fn)
boolean	primary()	Required - API name: primary
java.util.Map<java.lang.String,java.lang.String>	recoverySource()	The recovery source information for this shard.
java.lang.String	relocatingNode()	API name: relocating_node
java.lang.Boolean	searchOnly()	Indicates if this shard is configured for search operations only
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	setupNodeShardDeserializer(ObjectDeserializer<NodeShard.Builder> op)
int	shard()	Required - API name: shard
ShardRoutingState	state()	Required - API name: state
NodeShard.Builder	toBuilder()	Create a new builder ToCopyableBuilder that is initialised with the current state of this object.
UnassignedInformation	unassignedInfo()	API name: unassigned_info

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 Detail

_DESERIALIZER

public static final JsonpDeserializer<NodeShard> _DESERIALIZER

Json deserializer for NodeShard

Method Detail

of

public static NodeShard of(java.util.function.Function<NodeShard.Builder,ObjectBuilder<NodeShard>> fn)

allocationId

@Nonnull
public final java.util.Map<java.lang.String,java.lang.String> allocationId()

API name: allocation_id

index

@Nonnull
public final java.lang.String index()

Required - API name: index

node

@Nullable
public final java.lang.String node()

API name: node

primary

public final boolean primary()

Required - API name: primary

recoverySource

@Nonnull
public final java.util.Map<java.lang.String,java.lang.String> recoverySource()

The recovery source information for this shard.

API name: recovery_source

relocatingNode

@Nullable
public final java.lang.String relocatingNode()

API name: relocating_node

searchOnly

@Nullable
public final java.lang.Boolean searchOnly()

Indicates if this shard is configured for search operations only

API name: searchOnly

shard

public final int shard()

Required - API name: shard

state

@Nonnull
public final ShardRoutingState state()

Required - API name: state

unassignedInfo

@Nullable
public final UnassignedInformation unassignedInfo()

API name: unassigned_info

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

Returns:

a new builder instance.

builder

@Nonnull
public static NodeShard.Builder builder()

setupNodeShardDeserializer

protected static void setupNodeShardDeserializer(ObjectDeserializer<NodeShard.Builder> op)

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object