Package org.opensearch.client.opensearch.cat.snapshots

Class SnapshotsRecord

java.lang.Object

org.opensearch.client.opensearch.cat.snapshots.SnapshotsRecord

All Implemented Interfaces:

JsonpSerializable

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

Nested Class Summary

Nested Classes

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

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
Time	duration()	duration
java.lang.String	endEpoch()	end time in seconds since 1970-01-01 00:00:00
java.lang.String	endTime()	end time in HH:MM:SS
java.lang.String	failedShards()	number of failed shards
java.lang.String	id()	unique snapshot
java.lang.String	indices()	number of indices
static SnapshotsRecord	of(java.util.function.Function<SnapshotsRecord.Builder,ObjectBuilder<SnapshotsRecord>> fn)
java.lang.String	reason()	reason for failures
java.lang.String	repository()	repository name
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	setupSnapshotsRecordDeserializer(ObjectDeserializer<SnapshotsRecord.Builder> op)
java.lang.String	startEpoch()	start time in seconds since 1970-01-01 00:00:00
java.lang.String	startTime()	start time in HH:MM:SS
java.lang.String	status()	snapshot name
java.lang.String	successfulShards()	number of successful shards
java.lang.String	totalShards()	number of total shards

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

Json deserializer for SnapshotsRecord

Method Detail

of

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

id

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

unique snapshot

API name: id

repository

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

repository name

API name: repository

status

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

snapshot name

API name: status

startEpoch

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

start time in seconds since 1970-01-01 00:00:00

API name: start_epoch

startTime

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

start time in HH:MM:SS

API name: start_time

endEpoch

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

end time in seconds since 1970-01-01 00:00:00

API name: end_epoch

endTime

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

end time in HH:MM:SS

API name: end_time

duration

@Nullable
public final Time duration()

duration

API name: duration

indices

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

number of indices

API name: indices

successfulShards

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

number of successful shards

API name: successful_shards

failedShards

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

number of failed shards

API name: failed_shards

totalShards

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

number of total shards

API name: total_shards

reason

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

reason for failures

API name: reason

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)

setupSnapshotsRecordDeserializer

protected static void setupSnapshotsRecordDeserializer(ObjectDeserializer<SnapshotsRecord.Builder> op)