Class GetSnapshotResponse
- java.lang.Object
-
- org.opensearch.client.opensearch.snapshot.GetSnapshotResponse
-
- All Implemented Interfaces:
JsonpSerializable
@JsonpDeserializable public class GetSnapshotResponse extends java.lang.Object implements JsonpSerializable
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classGetSnapshotResponse.BuilderBuilder forGetSnapshotResponse.
-
Field Summary
Fields Modifier and Type Field Description static JsonpDeserializer<GetSnapshotResponse>_DESERIALIZERJson deserializer forGetSnapshotResponse
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static GetSnapshotResponseof(java.util.function.Function<GetSnapshotResponse.Builder,ObjectBuilder<GetSnapshotResponse>> fn)intremaining()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:responsesvoidserialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)Serialize this object to JSON.protected voidserializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)protected static voidsetupGetSnapshotResponseDeserializer(ObjectDeserializer<GetSnapshotResponse.Builder> op)java.util.List<SnapshotInfo>snapshots()API name:snapshotsinttotal()Required - The total number of snapshots that match the request when ignoring size limit or after query parameter.
-
-
-
Field Detail
-
_DESERIALIZER
public static final JsonpDeserializer<GetSnapshotResponse> _DESERIALIZER
Json deserializer forGetSnapshotResponse
-
-
Method Detail
-
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:
serializein interfaceJsonpSerializable
-
serializeInternal
protected void serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
-
setupGetSnapshotResponseDeserializer
protected static void setupGetSnapshotResponseDeserializer(ObjectDeserializer<GetSnapshotResponse.Builder> op)
-
-