co.elastic.clients.elasticsearch.snapshot.SnapshotInfo 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._types.ShardStatistics;
import co.elastic.clients.elasticsearch._types.Time;
import co.elastic.clients.json.JsonData;
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.DateTime;
import co.elastic.clients.util.ObjectBuilder;
import co.elastic.clients.util.WithJsonObjectBuilderBase;
import jakarta.json.stream.JsonGenerator;
import java.lang.Boolean;
import java.lang.Long;
import java.lang.String;
import java.util.List;
import java.util.Map;
import java.util.Objects;
import java.util.function.Function;
import javax.annotation.Nullable;
// typedef: snapshot._types.SnapshotInfo
/**
*
* @see API
* specification
*/
@JsonpDeserializable
public class SnapshotInfo implements JsonpSerializable {
private final List dataStreams;
@Nullable
private final Time duration;
@Nullable
private final DateTime durationInMillis;
@Nullable
private final Time endTime;
@Nullable
private final DateTime endTimeInMillis;
private final List failures;
@Nullable
private final Boolean includeGlobalState;
private final List indices;
private final Map indexDetails;
private final Map metadata;
@Nullable
private final String reason;
@Nullable
private final String repository;
private final String snapshot;
@Nullable
private final ShardStatistics shards;
@Nullable
private final Time startTime;
@Nullable
private final DateTime startTimeInMillis;
@Nullable
private final String state;
private final String uuid;
@Nullable
private final String version;
@Nullable
private final Long versionId;
private final List featureStates;
// ---------------------------------------------------------------------------------------------
private SnapshotInfo(Builder builder) {
this.dataStreams = ApiTypeHelper.unmodifiableRequired(builder.dataStreams, this, "dataStreams");
this.duration = builder.duration;
this.durationInMillis = builder.durationInMillis;
this.endTime = builder.endTime;
this.endTimeInMillis = builder.endTimeInMillis;
this.failures = ApiTypeHelper.unmodifiable(builder.failures);
this.includeGlobalState = builder.includeGlobalState;
this.indices = ApiTypeHelper.unmodifiableRequired(builder.indices, this, "indices");
this.indexDetails = ApiTypeHelper.unmodifiable(builder.indexDetails);
this.metadata = ApiTypeHelper.unmodifiable(builder.metadata);
this.reason = builder.reason;
this.repository = builder.repository;
this.snapshot = ApiTypeHelper.requireNonNull(builder.snapshot, this, "snapshot");
this.shards = builder.shards;
this.startTime = builder.startTime;
this.startTimeInMillis = builder.startTimeInMillis;
this.state = builder.state;
this.uuid = ApiTypeHelper.requireNonNull(builder.uuid, this, "uuid");
this.version = builder.version;
this.versionId = builder.versionId;
this.featureStates = ApiTypeHelper.unmodifiable(builder.featureStates);
}
public static SnapshotInfo of(Function> fn) {
return fn.apply(new Builder()).build();
}
/**
* Required - API name: {@code data_streams}
*/
public final List dataStreams() {
return this.dataStreams;
}
/**
* API name: {@code duration}
*/
@Nullable
public final Time duration() {
return this.duration;
}
/**
* API name: {@code duration_in_millis}
*/
@Nullable
public final DateTime durationInMillis() {
return this.durationInMillis;
}
/**
* API name: {@code end_time}
*/
@Nullable
public final Time endTime() {
return this.endTime;
}
/**
* API name: {@code end_time_in_millis}
*/
@Nullable
public final DateTime endTimeInMillis() {
return this.endTimeInMillis;
}
/**
* API name: {@code failures}
*/
public final List failures() {
return this.failures;
}
/**
* API name: {@code include_global_state}
*/
@Nullable
public final Boolean includeGlobalState() {
return this.includeGlobalState;
}
/**
* Required - API name: {@code indices}
*/
public final List indices() {
return this.indices;
}
/**
* API name: {@code index_details}
*/
public final Map indexDetails() {
return this.indexDetails;
}
/**
* API name: {@code metadata}
*/
public final Map metadata() {
return this.metadata;
}
/**
* API name: {@code reason}
*/
@Nullable
public final String reason() {
return this.reason;
}
/**
* API name: {@code repository}
*/
@Nullable
public final String repository() {
return this.repository;
}
/**
* Required - API name: {@code snapshot}
*/
public final String snapshot() {
return this.snapshot;
}
/**
* API name: {@code shards}
*/
@Nullable
public final ShardStatistics shards() {
return this.shards;
}
/**
* API name: {@code start_time}
*/
@Nullable
public final Time startTime() {
return this.startTime;
}
/**
* API name: {@code start_time_in_millis}
*/
@Nullable
public final DateTime startTimeInMillis() {
return this.startTimeInMillis;
}
/**
* API name: {@code state}
*/
@Nullable
public final String state() {
return this.state;
}
/**
* Required - API name: {@code uuid}
*/
public final String uuid() {
return this.uuid;
}
/**
* API name: {@code version}
*/
@Nullable
public final String version() {
return this.version;
}
/**
* API name: {@code version_id}
*/
@Nullable
public final Long versionId() {
return this.versionId;
}
/**
* API name: {@code feature_states}
*/
public final List featureStates() {
return this.featureStates;
}
/**
* 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.dataStreams)) {
generator.writeKey("data_streams");
generator.writeStartArray();
for (String item0 : this.dataStreams) {
generator.write(item0);
}
generator.writeEnd();
}
if (this.duration != null) {
generator.writeKey("duration");
this.duration.serialize(generator, mapper);
}
if (this.durationInMillis != null) {
generator.writeKey("duration_in_millis");
this.durationInMillis.serialize(generator, mapper);
}
if (this.endTime != null) {
generator.writeKey("end_time");
this.endTime.serialize(generator, mapper);
}
if (this.endTimeInMillis != null) {
generator.writeKey("end_time_in_millis");
this.endTimeInMillis.serialize(generator, mapper);
}
if (ApiTypeHelper.isDefined(this.failures)) {
generator.writeKey("failures");
generator.writeStartArray();
for (SnapshotShardFailure item0 : this.failures) {
item0.serialize(generator, mapper);
}
generator.writeEnd();
}
if (this.includeGlobalState != null) {
generator.writeKey("include_global_state");
generator.write(this.includeGlobalState);
}
if (ApiTypeHelper.isDefined(this.indices)) {
generator.writeKey("indices");
generator.writeStartArray();
for (String item0 : this.indices) {
generator.write(item0);
}
generator.writeEnd();
}
if (ApiTypeHelper.isDefined(this.indexDetails)) {
generator.writeKey("index_details");
generator.writeStartObject();
for (Map.Entry item0 : this.indexDetails.entrySet()) {
generator.writeKey(item0.getKey());
item0.getValue().serialize(generator, mapper);
}
generator.writeEnd();
}
if (ApiTypeHelper.isDefined(this.metadata)) {
generator.writeKey("metadata");
generator.writeStartObject();
for (Map.Entry item0 : this.metadata.entrySet()) {
generator.writeKey(item0.getKey());
item0.getValue().serialize(generator, mapper);
}
generator.writeEnd();
}
if (this.reason != null) {
generator.writeKey("reason");
generator.write(this.reason);
}
if (this.repository != null) {
generator.writeKey("repository");
generator.write(this.repository);
}
generator.writeKey("snapshot");
generator.write(this.snapshot);
if (this.shards != null) {
generator.writeKey("shards");
this.shards.serialize(generator, mapper);
}
if (this.startTime != null) {
generator.writeKey("start_time");
this.startTime.serialize(generator, mapper);
}
if (this.startTimeInMillis != null) {
generator.writeKey("start_time_in_millis");
this.startTimeInMillis.serialize(generator, mapper);
}
if (this.state != null) {
generator.writeKey("state");
generator.write(this.state);
}
generator.writeKey("uuid");
generator.write(this.uuid);
if (this.version != null) {
generator.writeKey("version");
generator.write(this.version);
}
if (this.versionId != null) {
generator.writeKey("version_id");
generator.write(this.versionId);
}
if (ApiTypeHelper.isDefined(this.featureStates)) {
generator.writeKey("feature_states");
generator.writeStartArray();
for (InfoFeatureState item0 : this.featureStates) {
item0.serialize(generator, mapper);
}
generator.writeEnd();
}
}
// ---------------------------------------------------------------------------------------------
/**
* Builder for {@link SnapshotInfo}.
*/
public static class Builder extends WithJsonObjectBuilderBase implements ObjectBuilder {
private List dataStreams;
@Nullable
private Time duration;
@Nullable
private DateTime durationInMillis;
@Nullable
private Time endTime;
@Nullable
private DateTime endTimeInMillis;
@Nullable
private List failures;
@Nullable
private Boolean includeGlobalState;
private List indices;
@Nullable
private Map indexDetails;
@Nullable
private Map metadata;
@Nullable
private String reason;
@Nullable
private String repository;
private String snapshot;
@Nullable
private ShardStatistics shards;
@Nullable
private Time startTime;
@Nullable
private DateTime startTimeInMillis;
@Nullable
private String state;
private String uuid;
@Nullable
private String version;
@Nullable
private Long versionId;
@Nullable
private List featureStates;
/**
* Required - API name: {@code data_streams}
*
* Adds all elements of list to dataStreams.
*/
public final Builder dataStreams(List list) {
this.dataStreams = _listAddAll(this.dataStreams, list);
return this;
}
/**
* Required - API name: {@code data_streams}
*
* Adds one or more values to dataStreams.
*/
public final Builder dataStreams(String value, String... values) {
this.dataStreams = _listAdd(this.dataStreams, value, values);
return this;
}
/**
* API name: {@code duration}
*/
public final Builder duration(@Nullable Time value) {
this.duration = value;
return this;
}
/**
* API name: {@code duration}
*/
public final Builder duration(Function> fn) {
return this.duration(fn.apply(new Time.Builder()).build());
}
/**
* API name: {@code duration_in_millis}
*/
public final Builder durationInMillis(@Nullable DateTime value) {
this.durationInMillis = value;
return this;
}
/**
* API name: {@code end_time}
*/
public final Builder endTime(@Nullable Time value) {
this.endTime = value;
return this;
}
/**
* API name: {@code end_time}
*/
public final Builder endTime(Function> fn) {
return this.endTime(fn.apply(new Time.Builder()).build());
}
/**
* API name: {@code end_time_in_millis}
*/
public final Builder endTimeInMillis(@Nullable DateTime value) {
this.endTimeInMillis = value;
return this;
}
/**
* API name: {@code failures}
*
* Adds all elements of list to failures.
*/
public final Builder failures(List list) {
this.failures = _listAddAll(this.failures, list);
return this;
}
/**
* API name: {@code failures}
*
* Adds one or more values to failures.
*/
public final Builder failures(SnapshotShardFailure value, SnapshotShardFailure... values) {
this.failures = _listAdd(this.failures, value, values);
return this;
}
/**
* API name: {@code failures}
*
* Adds a value to failures using a builder lambda.
*/
public final Builder failures(Function> fn) {
return failures(fn.apply(new SnapshotShardFailure.Builder()).build());
}
/**
* API name: {@code include_global_state}
*/
public final Builder includeGlobalState(@Nullable Boolean value) {
this.includeGlobalState = value;
return this;
}
/**
* Required - API name: {@code indices}
*
* Adds all elements of list to indices.
*/
public final Builder indices(List list) {
this.indices = _listAddAll(this.indices, list);
return this;
}
/**
* Required - API name: {@code indices}
*
* Adds one or more values to indices.
*/
public final Builder indices(String value, String... values) {
this.indices = _listAdd(this.indices, value, values);
return this;
}
/**
* API name: {@code index_details}
*
* Adds all entries of map to indexDetails.
*/
public final Builder indexDetails(Map map) {
this.indexDetails = _mapPutAll(this.indexDetails, map);
return this;
}
/**
* API name: {@code index_details}
*
* Adds an entry to indexDetails.
*/
public final Builder indexDetails(String key, IndexDetails value) {
this.indexDetails = _mapPut(this.indexDetails, key, value);
return this;
}
/**
* API name: {@code index_details}
*
* Adds an entry to indexDetails using a builder lambda.
*/
public final Builder indexDetails(String key, Function> fn) {
return indexDetails(key, fn.apply(new IndexDetails.Builder()).build());
}
/**
* API name: {@code metadata}
*
* Adds all entries of map to metadata.
*/
public final Builder metadata(Map map) {
this.metadata = _mapPutAll(this.metadata, map);
return this;
}
/**
* API name: {@code metadata}
*
* Adds an entry to metadata.
*/
public final Builder metadata(String key, JsonData value) {
this.metadata = _mapPut(this.metadata, key, value);
return this;
}
/**
* API name: {@code reason}
*/
public final Builder reason(@Nullable String value) {
this.reason = value;
return this;
}
/**
* API name: {@code repository}
*/
public final Builder repository(@Nullable String value) {
this.repository = value;
return this;
}
/**
* Required - API name: {@code snapshot}
*/
public final Builder snapshot(String value) {
this.snapshot = value;
return this;
}
/**
* API name: {@code shards}
*/
public final Builder shards(@Nullable ShardStatistics value) {
this.shards = value;
return this;
}
/**
* API name: {@code shards}
*/
public final Builder shards(Function> fn) {
return this.shards(fn.apply(new ShardStatistics.Builder()).build());
}
/**
* API name: {@code start_time}
*/
public final Builder startTime(@Nullable Time value) {
this.startTime = value;
return this;
}
/**
* API name: {@code start_time}
*/
public final Builder startTime(Function> fn) {
return this.startTime(fn.apply(new Time.Builder()).build());
}
/**
* API name: {@code start_time_in_millis}
*/
public final Builder startTimeInMillis(@Nullable DateTime value) {
this.startTimeInMillis = value;
return this;
}
/**
* API name: {@code state}
*/
public final Builder state(@Nullable String value) {
this.state = value;
return this;
}
/**
* Required - API name: {@code uuid}
*/
public final Builder uuid(String value) {
this.uuid = value;
return this;
}
/**
* API name: {@code version}
*/
public final Builder version(@Nullable String value) {
this.version = value;
return this;
}
/**
* API name: {@code version_id}
*/
public final Builder versionId(@Nullable Long value) {
this.versionId = value;
return this;
}
/**
* API name: {@code feature_states}
*
* Adds all elements of list to featureStates.
*/
public final Builder featureStates(List list) {
this.featureStates = _listAddAll(this.featureStates, list);
return this;
}
/**
* API name: {@code feature_states}
*
* Adds one or more values to featureStates.
*/
public final Builder featureStates(InfoFeatureState value, InfoFeatureState... values) {
this.featureStates = _listAdd(this.featureStates, value, values);
return this;
}
/**
* API name: {@code feature_states}
*
* Adds a value to featureStates using a builder lambda.
*/
public final Builder featureStates(Function> fn) {
return featureStates(fn.apply(new InfoFeatureState.Builder()).build());
}
@Override
protected Builder self() {
return this;
}
/**
* Builds a {@link SnapshotInfo}.
*
* @throws NullPointerException
* if some of the required fields are null.
*/
public SnapshotInfo build() {
_checkSingleUse();
return new SnapshotInfo(this);
}
}
// ---------------------------------------------------------------------------------------------
/**
* Json deserializer for {@link SnapshotInfo}
*/
public static final JsonpDeserializer _DESERIALIZER = ObjectBuilderDeserializer.lazy(Builder::new,
SnapshotInfo::setupSnapshotInfoDeserializer);
protected static void setupSnapshotInfoDeserializer(ObjectDeserializer op) {
op.add(Builder::dataStreams, JsonpDeserializer.arrayDeserializer(JsonpDeserializer.stringDeserializer()),
"data_streams");
op.add(Builder::duration, Time._DESERIALIZER, "duration");
op.add(Builder::durationInMillis, DateTime._DESERIALIZER, "duration_in_millis");
op.add(Builder::endTime, Time._DESERIALIZER, "end_time");
op.add(Builder::endTimeInMillis, DateTime._DESERIALIZER, "end_time_in_millis");
op.add(Builder::failures, JsonpDeserializer.arrayDeserializer(SnapshotShardFailure._DESERIALIZER), "failures");
op.add(Builder::includeGlobalState, JsonpDeserializer.booleanDeserializer(), "include_global_state");
op.add(Builder::indices, JsonpDeserializer.arrayDeserializer(JsonpDeserializer.stringDeserializer()),
"indices");
op.add(Builder::indexDetails, JsonpDeserializer.stringMapDeserializer(IndexDetails._DESERIALIZER),
"index_details");
op.add(Builder::metadata, JsonpDeserializer.stringMapDeserializer(JsonData._DESERIALIZER), "metadata");
op.add(Builder::reason, JsonpDeserializer.stringDeserializer(), "reason");
op.add(Builder::repository, JsonpDeserializer.stringDeserializer(), "repository");
op.add(Builder::snapshot, JsonpDeserializer.stringDeserializer(), "snapshot");
op.add(Builder::shards, ShardStatistics._DESERIALIZER, "shards");
op.add(Builder::startTime, Time._DESERIALIZER, "start_time");
op.add(Builder::startTimeInMillis, DateTime._DESERIALIZER, "start_time_in_millis");
op.add(Builder::state, JsonpDeserializer.stringDeserializer(), "state");
op.add(Builder::uuid, JsonpDeserializer.stringDeserializer(), "uuid");
op.add(Builder::version, JsonpDeserializer.stringDeserializer(), "version");
op.add(Builder::versionId, JsonpDeserializer.longDeserializer(), "version_id");
op.add(Builder::featureStates, JsonpDeserializer.arrayDeserializer(InfoFeatureState._DESERIALIZER),
"feature_states");
}
}