co.elastic.clients.elasticsearch.snapshot.GetSnapshotResponse Maven / Gradle / Ivy
Show all versions of elasticsearch-java Show documentation
/*
* Licensed to Elasticsearch B.V. under one or more contributor
* license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright
* ownership. Elasticsearch B.V. licenses this file to you under
* the Apache License, Version 2.0 (the "License"); you may
* not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
//----------------------------------------------------
// THIS CODE IS GENERATED. MANUAL EDITS WILL BE LOST.
//----------------------------------------------------
package co.elastic.clients.elasticsearch.snapshot;
import co.elastic.clients.elasticsearch.snapshot.get.SnapshotResponseItem;
import co.elastic.clients.json.JsonpDeserializable;
import co.elastic.clients.json.JsonpDeserializer;
import co.elastic.clients.json.JsonpMapper;
import co.elastic.clients.json.JsonpSerializable;
import co.elastic.clients.json.ObjectBuilderDeserializer;
import co.elastic.clients.json.ObjectDeserializer;
import co.elastic.clients.util.ApiTypeHelper;
import co.elastic.clients.util.ObjectBuilder;
import co.elastic.clients.util.WithJsonObjectBuilderBase;
import jakarta.json.stream.JsonGenerator;
import java.lang.Integer;
import java.util.List;
import java.util.Objects;
import java.util.function.Function;
import javax.annotation.Nullable;
// typedef: snapshot.get.Response
/**
*
* @see API
* specification
*/
@JsonpDeserializable
public class GetSnapshotResponse implements JsonpSerializable {
private final List responses;
private final List snapshots;
private final int total;
private final int remaining;
// ---------------------------------------------------------------------------------------------
private GetSnapshotResponse(Builder builder) {
this.responses = ApiTypeHelper.unmodifiable(builder.responses);
this.snapshots = ApiTypeHelper.unmodifiable(builder.snapshots);
this.total = ApiTypeHelper.requireNonNull(builder.total, this, "total");
this.remaining = ApiTypeHelper.requireNonNull(builder.remaining, this, "remaining");
}
public static GetSnapshotResponse of(Function> fn) {
return fn.apply(new Builder()).build();
}
/**
* API name: {@code responses}
*/
public final List responses() {
return this.responses;
}
/**
* API name: {@code snapshots}
*/
public final List snapshots() {
return this.snapshots;
}
/**
* Required - The total number of snapshots that match the request when ignoring
* size limit or after query parameter.
*
* API name: {@code total}
*/
public final int total() {
return this.total;
}
/**
* 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: {@code remaining}
*/
public final int remaining() {
return this.remaining;
}
/**
* Serialize this object to JSON.
*/
public void serialize(JsonGenerator generator, JsonpMapper mapper) {
generator.writeStartObject();
serializeInternal(generator, mapper);
generator.writeEnd();
}
protected void serializeInternal(JsonGenerator generator, JsonpMapper mapper) {
if (ApiTypeHelper.isDefined(this.responses)) {
generator.writeKey("responses");
generator.writeStartArray();
for (SnapshotResponseItem item0 : this.responses) {
item0.serialize(generator, mapper);
}
generator.writeEnd();
}
if (ApiTypeHelper.isDefined(this.snapshots)) {
generator.writeKey("snapshots");
generator.writeStartArray();
for (SnapshotInfo item0 : this.snapshots) {
item0.serialize(generator, mapper);
}
generator.writeEnd();
}
generator.writeKey("total");
generator.write(this.total);
generator.writeKey("remaining");
generator.write(this.remaining);
}
// ---------------------------------------------------------------------------------------------
/**
* Builder for {@link GetSnapshotResponse}.
*/
public static class Builder extends WithJsonObjectBuilderBase
implements
ObjectBuilder {
@Nullable
private List responses;
@Nullable
private List snapshots;
private Integer total;
private Integer remaining;
/**
* API name: {@code responses}
*
* Adds all elements of list to responses.
*/
public final Builder responses(List list) {
this.responses = _listAddAll(this.responses, list);
return this;
}
/**
* API name: {@code responses}
*
* Adds one or more values to responses.
*/
public final Builder responses(SnapshotResponseItem value, SnapshotResponseItem... values) {
this.responses = _listAdd(this.responses, value, values);
return this;
}
/**
* API name: {@code responses}
*
* Adds a value to responses using a builder lambda.
*/
public final Builder responses(Function> fn) {
return responses(fn.apply(new SnapshotResponseItem.Builder()).build());
}
/**
* API name: {@code snapshots}
*
* Adds all elements of list to snapshots.
*/
public final Builder snapshots(List list) {
this.snapshots = _listAddAll(this.snapshots, list);
return this;
}
/**
* API name: {@code snapshots}
*
* Adds one or more values to snapshots.
*/
public final Builder snapshots(SnapshotInfo value, SnapshotInfo... values) {
this.snapshots = _listAdd(this.snapshots, value, values);
return this;
}
/**
* API name: {@code snapshots}
*
* Adds a value to snapshots using a builder lambda.
*/
public final Builder snapshots(Function> fn) {
return snapshots(fn.apply(new SnapshotInfo.Builder()).build());
}
/**
* Required - The total number of snapshots that match the request when ignoring
* size limit or after query parameter.
*
* API name: {@code total}
*/
public final Builder total(int value) {
this.total = value;
return this;
}
/**
* 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: {@code remaining}
*/
public final Builder remaining(int value) {
this.remaining = value;
return this;
}
@Override
protected Builder self() {
return this;
}
/**
* Builds a {@link GetSnapshotResponse}.
*
* @throws NullPointerException
* if some of the required fields are null.
*/
public GetSnapshotResponse build() {
_checkSingleUse();
return new GetSnapshotResponse(this);
}
}
// ---------------------------------------------------------------------------------------------
/**
* Json deserializer for {@link GetSnapshotResponse}
*/
public static final JsonpDeserializer _DESERIALIZER = ObjectBuilderDeserializer
.lazy(Builder::new, GetSnapshotResponse::setupGetSnapshotResponseDeserializer);
protected static void setupGetSnapshotResponseDeserializer(ObjectDeserializer op) {
op.add(Builder::responses, JsonpDeserializer.arrayDeserializer(SnapshotResponseItem._DESERIALIZER),
"responses");
op.add(Builder::snapshots, JsonpDeserializer.arrayDeserializer(SnapshotInfo._DESERIALIZER), "snapshots");
op.add(Builder::total, JsonpDeserializer.integerDeserializer(), "total");
op.add(Builder::remaining, JsonpDeserializer.integerDeserializer(), "remaining");
}
}