Package org.opensearch.client.opensearch.snapshot

Class SnapshotShardFailure

java.lang.Object

org.opensearch.client.opensearch.snapshot.SnapshotShardFailure

All Implemented Interfaces:

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

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

Nested Class Summary

Nested Classes

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

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
static SnapshotShardFailure.Builder	builder()
boolean	equals(Object o)
int	hashCode()
final String	index()	The name of the index containing the failed shard.
final String	nodeId()	The ID of the node where the shard failure occurred.
static SnapshotShardFailure	of(Function<SnapshotShardFailure.Builder,ObjectBuilder<SnapshotShardFailure>> fn)
final String	reason()	The reason for the shard failure.
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	setupSnapshotShardFailureDeserializer(ObjectDeserializer<SnapshotShardFailure.Builder> op)
final String	shardId()	The ID of the failed shard.
final String	status()	The status of the failed shard.
SnapshotShardFailure.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<SnapshotShardFailure> _DESERIALIZER

Json deserializer for SnapshotShardFailure

Method Details

of

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

index

@Nullable
public final String index()

The name of the index containing the failed shard.

API name: index

nodeId

@Nullable
public final String nodeId()

The ID of the node where the shard failure occurred.

API name: node_id

reason

@Nullable
public final String reason()

The reason for the shard failure.

API name: reason

shardId

@Nullable
public final String shardId()

The ID of the failed shard.

API name: shard_id

status

@Nullable
public final String status()

The status of the failed shard.

API name: status

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

Returns:

a new builder instance.

builder

@Nonnull
public static SnapshotShardFailure.Builder builder()

setupSnapshotShardFailureDeserializer

protected static void setupSnapshotShardFailureDeserializer(ObjectDeserializer<SnapshotShardFailure.Builder> op)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object