Package org.opensearch.client.opensearch.snapshot

Class SnapshotInfo

java.lang.Object

org.opensearch.client.opensearch.snapshot.SnapshotInfo

All Implemented Interfaces:

JsonpSerializable

@JsonpDeserializable
public class SnapshotInfo
extends java.lang.Object
implements JsonpSerializable

Nested Class Summary

Nested Classes

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

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
java.util.List<java.lang.String>	dataStreams()	Required - API name: data_streams
Time	duration()	API name: duration
java.lang.String	durationInMillis()	API name: duration_in_millis
Time	endTime()	API name: end_time
java.lang.String	endTimeInMillis()	API name: end_time_in_millis
java.util.List<SnapshotShardFailure>	failures()	API name: failures
java.util.List<InfoFeatureState>	featureStates()	API name: feature_states
java.lang.Boolean	includeGlobalState()	API name: include_global_state
java.util.Map<java.lang.String,IndexDetails>	indexDetails()	API name: index_details
java.util.List<java.lang.String>	indices()	Required - API name: indices
java.util.Map<java.lang.String,JsonData>	metadata()	API name: metadata
static SnapshotInfo	of(java.util.function.Function<SnapshotInfo.Builder,ObjectBuilder<SnapshotInfo>> fn)
java.lang.String	reason()	API name: reason
java.lang.String	repository()	API name: repository
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	setupSnapshotInfoDeserializer(ObjectDeserializer<SnapshotInfo.Builder> op)
ShardStatistics	shards()	API name: shards
java.lang.String	snapshot()	Required - API name: snapshot
Time	startTime()	API name: start_time
java.lang.String	startTimeInMillis()	API name: start_time_in_millis
java.lang.String	state()	API name: state
java.lang.String	uuid()	Required - API name: uuid
java.lang.String	version()	API name: version
java.lang.Long	versionId()	API name: version_id

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

_DESERIALIZER

public static final JsonpDeserializer<SnapshotInfo> _DESERIALIZER

Json deserializer for SnapshotInfo

Method Detail

of

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

dataStreams

public final java.util.List<java.lang.String> dataStreams()

Required - API name: data_streams

duration

@Nullable
public final Time duration()

API name: duration

durationInMillis

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

API name: duration_in_millis

endTime

@Nullable
public final Time endTime()

API name: end_time

endTimeInMillis

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

API name: end_time_in_millis

failures

public final java.util.List<SnapshotShardFailure> failures()

API name: failures

includeGlobalState

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

API name: include_global_state

indices

public final java.util.List<java.lang.String> indices()

Required - API name: indices

indexDetails

public final java.util.Map<java.lang.String,IndexDetails> indexDetails()

API name: index_details

metadata

public final java.util.Map<java.lang.String,JsonData> metadata()

API name: metadata

reason

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

API name: reason

repository

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

API name: repository

snapshot

public final java.lang.String snapshot()

Required - API name: snapshot

shards

@Nullable
public final ShardStatistics shards()

API name: shards

startTime

@Nullable
public final Time startTime()

API name: start_time

startTimeInMillis

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

API name: start_time_in_millis

state

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

API name: state

uuid

public final java.lang.String uuid()

Required - API name: uuid

version

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

API name: version

versionId

@Nullable
public final java.lang.Long versionId()

API name: version_id

featureStates

public final java.util.List<InfoFeatureState> featureStates()

API name: feature_states

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)

setupSnapshotInfoDeserializer

protected static void setupSnapshotInfoDeserializer(ObjectDeserializer<SnapshotInfo.Builder> op)