co.elastic.clients.elasticsearch.snapshot.S3RepositorySettings Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of elasticsearch-java Show documentation
Elasticsearch Java API Client
There is a newer version: 8.17.0
/*
 * 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.
 */

package co.elastic.clients.elasticsearch.snapshot;

import co.elastic.clients.json.JsonpDeserializable;
import co.elastic.clients.json.JsonpDeserializer;
import co.elastic.clients.json.JsonpMapper;
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 jakarta.json.stream.JsonGenerator;
import java.lang.Boolean;
import java.lang.String;
import java.util.Objects;
import java.util.function.Function;
import javax.annotation.Nullable;

//----------------------------------------------------------------
//       THIS CODE IS GENERATED. MANUAL EDITS WILL BE LOST.
//----------------------------------------------------------------
//
// This code is generated from the Elasticsearch API specification
// at https://github.com/elastic/elasticsearch-specification
//
// Manual updates to this file will be lost when the code is
// re-generated.
//
// If you find a property that is missing or wrongly typed, please
// open an issue or a PR on the API specification repository.
//
//----------------------------------------------------------------

// typedef: snapshot._types.S3RepositorySettings

/**
 *
 * @see API
 *      specification
 */
@JsonpDeserializable
public class S3RepositorySettings extends RepositorySettingsBase {
	private final String bucket;

	@Nullable
	private final String client;

	@Nullable
	private final String basePath;

	@Nullable
	private final Boolean readonly;

	@Nullable
	private final Boolean serverSideEncryption;

	@Nullable
	private final String bufferSize;

	@Nullable
	private final String cannedAcl;

	@Nullable
	private final String storageClass;

	// ---------------------------------------------------------------------------------------------

	private S3RepositorySettings(Builder builder) {
		super(builder);

		this.bucket = ApiTypeHelper.requireNonNull(builder.bucket, this, "bucket");
		this.client = builder.client;
		this.basePath = builder.basePath;
		this.readonly = builder.readonly;
		this.serverSideEncryption = builder.serverSideEncryption;
		this.bufferSize = builder.bufferSize;
		this.cannedAcl = builder.cannedAcl;
		this.storageClass = builder.storageClass;

	}

	public static S3RepositorySettings of(Function> fn) {
		return fn.apply(new Builder()).build();
	}

	/**
	 * Required - API name: {@code bucket}
	 */
	public final String bucket() {
		return this.bucket;
	}

	/**
	 * API name: {@code client}
	 */
	@Nullable
	public final String client() {
		return this.client;
	}

	/**
	 * API name: {@code base_path}
	 */
	@Nullable
	public final String basePath() {
		return this.basePath;
	}

	/**
	 * API name: {@code readonly}
	 */
	@Nullable
	public final Boolean readonly() {
		return this.readonly;
	}

	/**
	 * API name: {@code server_side_encryption}
	 */
	@Nullable
	public final Boolean serverSideEncryption() {
		return this.serverSideEncryption;
	}

	/**
	 * API name: {@code buffer_size}
	 */
	@Nullable
	public final String bufferSize() {
		return this.bufferSize;
	}

	/**
	 * API name: {@code canned_acl}
	 */
	@Nullable
	public final String cannedAcl() {
		return this.cannedAcl;
	}

	/**
	 * API name: {@code storage_class}
	 */
	@Nullable
	public final String storageClass() {
		return this.storageClass;
	}

	protected void serializeInternal(JsonGenerator generator, JsonpMapper mapper) {

		super.serializeInternal(generator, mapper);
		generator.writeKey("bucket");
		generator.write(this.bucket);

		if (this.client != null) {
			generator.writeKey("client");
			generator.write(this.client);

		}
		if (this.basePath != null) {
			generator.writeKey("base_path");
			generator.write(this.basePath);

		}
		if (this.readonly != null) {
			generator.writeKey("readonly");
			generator.write(this.readonly);

		}
		if (this.serverSideEncryption != null) {
			generator.writeKey("server_side_encryption");
			generator.write(this.serverSideEncryption);

		}
		if (this.bufferSize != null) {
			generator.writeKey("buffer_size");
			generator.write(this.bufferSize);

		}
		if (this.cannedAcl != null) {
			generator.writeKey("canned_acl");
			generator.write(this.cannedAcl);

		}
		if (this.storageClass != null) {
			generator.writeKey("storage_class");
			generator.write(this.storageClass);

		}

	}

	// ---------------------------------------------------------------------------------------------

	/**
	 * Builder for {@link S3RepositorySettings}.
	 */

	public static class Builder extends RepositorySettingsBase.AbstractBuilder
			implements
				ObjectBuilder {
		private String bucket;

		@Nullable
		private String client;

		@Nullable
		private String basePath;

		@Nullable
		private Boolean readonly;

		@Nullable
		private Boolean serverSideEncryption;

		@Nullable
		private String bufferSize;

		@Nullable
		private String cannedAcl;

		@Nullable
		private String storageClass;

		/**
		 * Required - API name: {@code bucket}
		 */
		public final Builder bucket(String value) {
			this.bucket = value;
			return this;
		}

		/**
		 * API name: {@code client}
		 */
		public final Builder client(@Nullable String value) {
			this.client = value;
			return this;
		}

		/**
		 * API name: {@code base_path}
		 */
		public final Builder basePath(@Nullable String value) {
			this.basePath = value;
			return this;
		}

		/**
		 * API name: {@code readonly}
		 */
		public final Builder readonly(@Nullable Boolean value) {
			this.readonly = value;
			return this;
		}

		/**
		 * API name: {@code server_side_encryption}
		 */
		public final Builder serverSideEncryption(@Nullable Boolean value) {
			this.serverSideEncryption = value;
			return this;
		}

		/**
		 * API name: {@code buffer_size}
		 */
		public final Builder bufferSize(@Nullable String value) {
			this.bufferSize = value;
			return this;
		}

		/**
		 * API name: {@code canned_acl}
		 */
		public final Builder cannedAcl(@Nullable String value) {
			this.cannedAcl = value;
			return this;
		}

		/**
		 * API name: {@code storage_class}
		 */
		public final Builder storageClass(@Nullable String value) {
			this.storageClass = value;
			return this;
		}

		@Override
		protected Builder self() {
			return this;
		}

		/**
		 * Builds a {@link S3RepositorySettings}.
		 *
		 * @throws NullPointerException
		 *             if some of the required fields are null.
		 */
		public S3RepositorySettings build() {
			_checkSingleUse();

			return new S3RepositorySettings(this);
		}
	}

	// ---------------------------------------------------------------------------------------------

	/**
	 * Json deserializer for {@link S3RepositorySettings}
	 */
	public static final JsonpDeserializer _DESERIALIZER = ObjectBuilderDeserializer
			.lazy(Builder::new, S3RepositorySettings::setupS3RepositorySettingsDeserializer);

	protected static void setupS3RepositorySettingsDeserializer(ObjectDeserializer op) {
		RepositorySettingsBase.setupRepositorySettingsBaseDeserializer(op);
		op.add(Builder::bucket, JsonpDeserializer.stringDeserializer(), "bucket");
		op.add(Builder::client, JsonpDeserializer.stringDeserializer(), "client");
		op.add(Builder::basePath, JsonpDeserializer.stringDeserializer(), "base_path");
		op.add(Builder::readonly, JsonpDeserializer.booleanDeserializer(), "readonly");
		op.add(Builder::serverSideEncryption, JsonpDeserializer.booleanDeserializer(), "server_side_encryption");
		op.add(Builder::bufferSize, JsonpDeserializer.stringDeserializer(), "buffer_size");
		op.add(Builder::cannedAcl, JsonpDeserializer.stringDeserializer(), "canned_acl");
		op.add(Builder::storageClass, JsonpDeserializer.stringDeserializer(), "storage_class");

	}

}