Package org.opensearch.client.opensearch.snapshot

Class SnapshotStatus

java.lang.Object

org.opensearch.client.opensearch.snapshot.SnapshotStatus

All Implemented Interfaces:

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

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

Nested Class Summary

Nested Classes

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

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
static SnapshotStatus.Builder	builder()
boolean	equals(Object o)
int	hashCode()
final Boolean	includeGlobalState()	Whether the snapshot includes the cluster state.
final Map<String,SnapshotIndexStats>	indices()	The status of indexes in the snapshot.
static SnapshotStatus	of(Function<SnapshotStatus.Builder,ObjectBuilder<SnapshotStatus>> fn)
final String	repository()	The name of the repository containing the snapshot.
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	setupSnapshotStatusDeserializer(ObjectDeserializer<SnapshotStatus.Builder> op)
final SnapshotShardsStats	shardsStats()	The statistics about snapshot shards.
final String	snapshot()	The name of the snapshot.
final String	state()	The current state of the snapshot.
final SnapshotStats	stats()	The detailed statistics about the snapshot.
SnapshotStatus.Builder	toBuilder()	Create a new builder ToCopyableBuilder that is initialised with the current state of this object.
final String	uuid()	The unique identifier for the snapshot.

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<SnapshotStatus> _DESERIALIZER

Json deserializer for SnapshotStatus

Method Details

of

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

includeGlobalState

@Nullable
public final Boolean includeGlobalState()

Whether the snapshot includes the cluster state.

API name: include_global_state

indices

@Nonnull
public final Map<String,SnapshotIndexStats> indices()

The status of indexes in the snapshot.

API name: indices

repository

@Nullable
public final String repository()

The name of the repository containing the snapshot.

API name: repository

shardsStats

@Nullable
public final SnapshotShardsStats shardsStats()

The statistics about snapshot shards.

API name: shards_stats

snapshot

@Nullable
public final String snapshot()

The name of the snapshot.

API name: snapshot

state

@Nullable
public final String state()

The current state of the snapshot.

API name: state

stats

@Nullable
public final SnapshotStats stats()

The detailed statistics about the snapshot.

API name: stats

uuid

@Nullable
public final String uuid()

The unique identifier for the snapshot.

API name: uuid

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

Returns:

a new builder instance.

builder

@Nonnull
public static SnapshotStatus.Builder builder()

setupSnapshotStatusDeserializer

protected static void setupSnapshotStatusDeserializer(ObjectDeserializer<SnapshotStatus.Builder> op)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object