Package co.elastic.clients.elasticsearch.snapshot

Class GetSnapshotResponse

java.lang.Object

co.elastic.clients.elasticsearch.snapshot.GetSnapshotResponse

All Implemented Interfaces:

JsonpSerializable

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

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

Constructor Summary

Constructors

Constructor	Description
GetSnapshotResponse(GetSnapshotResponse.Builder builder)
GetSnapshotResponse(java.util.function.Function<GetSnapshotResponse.Builder,GetSnapshotResponse.Builder> fn)

Method Summary

Modifier and Type	Method	Description
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(DelegatingDeserializer<GetSnapshotResponse.Builder> op)
java.util.List<SnapshotInfo>	snapshots()	API name: snapshots
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, toString, wait, wait, wait

Field Details

_DESERIALIZER

public static final JsonpDeserializer<GetSnapshotResponse> _DESERIALIZER

Json deserializer for GetSnapshotResponse

Constructor Details

GetSnapshotResponse

public GetSnapshotResponse(GetSnapshotResponse.Builder builder)

GetSnapshotResponse

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

Method Details

responses

@Nullable
public java.util.List<SnapshotResponseItem> responses()

API name: responses

snapshots

@Nullable
public java.util.List<SnapshotInfo> snapshots()

API name: snapshots

total

public 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 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)

setupGetSnapshotResponseDeserializer

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