Package org.opensearch.client.opensearch.snapshot

Class SnapshotShardsStatus

java.lang.Object

org.opensearch.client.opensearch.snapshot.SnapshotShardsStatus

All Implemented Interfaces:

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

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

Nested Class Summary

Nested Classes

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

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
static SnapshotShardsStatus.Builder	builder()
boolean	equals(Object o)
int	hashCode()
final String	node()	The ID of the node containing the shard.
static SnapshotShardsStatus	of(Function<SnapshotShardsStatus.Builder,ObjectBuilder<SnapshotShardsStatus>> fn)
final String	reason()	The reason for the current shard status.
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	setupSnapshotShardsStatusDeserializer(ObjectDeserializer<SnapshotShardsStatus.Builder> op)
final SnapshotShardsStatsStage	stage()	Required - The current stage of the shard snapshot.
final SnapshotShardsStatsSummary	stats()	Required - The statistical summary of the shard snapshot.
SnapshotShardsStatus.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<SnapshotShardsStatus> _DESERIALIZER

Json deserializer for SnapshotShardsStatus

Method Details

of

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

node

@Nullable
public final String node()

The ID of the node containing the shard.

API name: node

reason

@Nullable
public final String reason()

The reason for the current shard status.

API name: reason

stage

@Nonnull
public final SnapshotShardsStatsStage stage()

Required - The current stage of the shard snapshot.

API name: stage

stats

@Nonnull
public final SnapshotShardsStatsSummary stats()

Required - The statistical summary of the shard snapshot.

API name: stats

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

Returns:

a new builder instance.

builder

@Nonnull
public static SnapshotShardsStatus.Builder builder()

setupSnapshotShardsStatusDeserializer

protected static void setupSnapshotShardsStatusDeserializer(ObjectDeserializer<SnapshotShardsStatus.Builder> op)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object