Package co.elastic.clients.elasticsearch.snapshot

Class GetSnapshotResponse

java.lang.Object

co.elastic.clients.elasticsearch.snapshot.GetSnapshotResponse

All Implemented Interfaces:

JsonpSerializable

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

See Also:

API specification

Nested Class Summary

Nested Classes

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

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
static GetSnapshotResponse	of(java.util.function.Function<GetSnapshotResponse.Builder,ObjectBuilder<GetSnapshotResponse>> fn)
int	remaining()	Required - The number of remaining snapshots that were not returned due to size limits and that can be fetched by additional requests using the next field value.
java.util.List<SnapshotResponseItem>	responses()	API name: responses
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	setupGetSnapshotResponseDeserializer(ObjectDeserializer<GetSnapshotResponse.Builder> op)
java.util.List<SnapshotInfo>	snapshots()	API name: snapshots
java.lang.String	toString()
int	total()	Required - The total number of snapshots that match the request when ignoring size limit or after query parameter.

Methods inherited from class java.lang.Object

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

Field Details

_DESERIALIZER

public static final JsonpDeserializer<GetSnapshotResponse> _DESERIALIZER

Json deserializer for GetSnapshotResponse

Method Details

of

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

responses

public final java.util.List<SnapshotResponseItem> responses()

API name: responses

snapshots

public final java.util.List<SnapshotInfo> snapshots()

API name: snapshots

total

public final int total()

Required - The total number of snapshots that match the request when ignoring size limit or after query parameter.

API name: total

remaining

public final int remaining()

Required - The number of remaining snapshots that were not returned due to size limits and that can be fetched by additional requests using the next field value.

API name: remaining

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)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

setupGetSnapshotResponseDeserializer

protected static void setupGetSnapshotResponseDeserializer(ObjectDeserializer<GetSnapshotResponse.Builder> op)