Package org.opensearch.client.opensearch.snapshot.restore

Class SnapshotRestore

java.lang.Object

org.opensearch.client.opensearch.snapshot.restore.SnapshotRestore

All Implemented Interfaces:

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

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

Nested Class Summary

Nested Classes

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

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
static SnapshotRestore.Builder	builder()
boolean	equals(Object o)
int	hashCode()
final List<String>	indices()	Required - The list of indexes that were restored.
static SnapshotRestore	of(Function<SnapshotRestore.Builder,ObjectBuilder<SnapshotRestore>> 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	setupSnapshotRestoreDeserializer(ObjectDeserializer<SnapshotRestore.Builder> op)
final ShardStatistics	shards()	Required - Any statistics about the restored shards.
final String	snapshot()	Required - The name of the snapshot that was restored.
SnapshotRestore.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<SnapshotRestore> _DESERIALIZER

Json deserializer for SnapshotRestore

Method Details

of

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

indices

@Nonnull
public final List<String> indices()

Required - The list of indexes that were restored.

API name: indices

shards

@Nonnull
public final ShardStatistics shards()

Required - Any statistics about the restored shards.

API name: shards

snapshot

@Nonnull
public final String snapshot()

Required - The name of the snapshot that was restored.

API name: snapshot

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

Returns:

a new builder instance.

builder

@Nonnull
public static SnapshotRestore.Builder builder()

setupSnapshotRestoreDeserializer

protected static void setupSnapshotRestoreDeserializer(ObjectDeserializer<SnapshotRestore.Builder> op)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object