Package co.elastic.clients.elasticsearch.snapshot

Class SourceOnlyRepositorySettingsForGcs.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

co.elastic.clients.util.WithJsonObjectBuilderBase<SourceOnlyRepositorySettingsForGcs.Builder>

co.elastic.clients.elasticsearch.snapshot.SourceOnlyRepositorySettingsForGcs.Builder

All Implemented Interfaces:

WithJson<SourceOnlyRepositorySettingsForGcs.Builder>, ObjectBuilder<SourceOnlyRepositorySettingsForGcs>

Enclosing class:

SourceOnlyRepositorySettingsForGcs

public static class SourceOnlyRepositorySettingsForGcs.Builder
extends WithJsonObjectBuilderBase<SourceOnlyRepositorySettingsForGcs.Builder>
implements ObjectBuilder<SourceOnlyRepositorySettingsForGcs>

Builder for SourceOnlyRepositorySettingsForGcs.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
final SourceOnlyRepositorySettingsForGcs.Builder	applicationName(String value)	Deprecated. 6.3.0
final SourceOnlyRepositorySettingsForGcs.Builder	basePath(String value)	The path to the repository data within the bucket.
final SourceOnlyRepositorySettingsForGcs.Builder	bucket(String value)	Required - The name of the bucket to be used for snapshots.
SourceOnlyRepositorySettingsForGcs	build()	Builds a SourceOnlyRepositorySettingsForGcs.
final SourceOnlyRepositorySettingsForGcs.Builder	client(String value)	The name of the client to use to connect to Google Cloud Storage.
final SourceOnlyRepositorySettingsForGcs.Builder	readonly(Boolean value)	If true, the repository is read-only.
protected SourceOnlyRepositorySettingsForGcs.Builder	self()

Methods inherited from class co.elastic.clients.util.WithJsonObjectBuilderBase

withJson

Methods inherited from class co.elastic.clients.util.ObjectBuilderBase

_checkSingleUse, _listAdd, _listAddAll, _mapPut, _mapPutAll

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface co.elastic.clients.json.WithJson

withJson, withJson

Constructor Details

Builder

public Builder()

Method Details

bucket

public final SourceOnlyRepositorySettingsForGcs.Builder bucket(String value)

Required - The name of the bucket to be used for snapshots.

API name: bucket

applicationName

@Deprecated
public final SourceOnlyRepositorySettingsForGcs.Builder applicationName(@Nullable
 String value)

Deprecated.

6.3.0

The name used by the client when it uses the Google Cloud Storage service.

API name: application_name

basePath

public final SourceOnlyRepositorySettingsForGcs.Builder basePath(@Nullable
 String value)

The path to the repository data within the bucket. It defaults to the root of the bucket.

NOTE: Don't set base_path when configuring a snapshot repository for Elastic Cloud Enterprise. Elastic Cloud Enterprise automatically generates the base_path for each deployment so that multiple deployments can share the same bucket.

API name: base_path

client

public final SourceOnlyRepositorySettingsForGcs.Builder client(@Nullable
 String value)

The name of the client to use to connect to Google Cloud Storage.

API name: client

readonly

public final SourceOnlyRepositorySettingsForGcs.Builder readonly(@Nullable
 Boolean value)

If true, the repository is read-only. The cluster can retrieve and restore snapshots from the repository but not write to the repository or create snapshots in it.

Only a cluster with write access can create snapshots in the repository. All other clusters connected to the repository should have the readonly parameter set to true.

If false, the cluster can write to the repository and create snapshots in it.

IMPORTANT: If you register the same snapshot repository with multiple clusters, only one cluster should have write access to the repository. Having multiple clusters write to the repository at the same time risks corrupting the contents of the repository.

API name: readonly

self

protected SourceOnlyRepositorySettingsForGcs.Builder self()

Specified by:

self in class WithJsonObjectBuilderBase<SourceOnlyRepositorySettingsForGcs.Builder>

build

public SourceOnlyRepositorySettingsForGcs build()

Builds a SourceOnlyRepositorySettingsForGcs.

Specified by:

build in interface ObjectBuilder<SourceOnlyRepositorySettingsForGcs>

Throws:

NullPointerException - if some of the required fields are null.