GetResponse (java-client 7.15.1 API)

java.lang.Object

co.elastic.clients.elasticsearch.snapshot.GetResponse

All Implemented Interfaces:: JsonpSerializable

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

Nested Class Summary

Nested Classes

Modifier and Type Class Description

static class GetResponse.Builder
Builder for GetResponse.
Field Summary

Fields

Modifier and Type Field Description

static JsonpDeserializer<GetResponse> _DESERIALIZER
Json deserializer for GetResponse
Constructor Summary

Constructors

Constructor Description

GetResponse(GetResponse.Builder builder)

GetResponse(java.util.function.Function<GetResponse.Builder,GetResponse.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`	`setupGetResponseDeserializer(DelegatingDeserializer<GetResponse.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<GetResponse> _DESERIALIZER
  
  Json deserializer for GetResponse
Constructor Details
- GetResponse
  
  public GetResponse(GetResponse.Builder builder)
- GetResponse
  
  public GetResponse(java.util.function.Function<GetResponse.Builder,GetResponse.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)
- setupGetResponseDeserializer
  
  protected static void setupGetResponseDeserializer(DelegatingDeserializer<GetResponse.Builder> op)