Package co.elastic.clients.elasticsearch.snapshot

Class SharedFileSystemRepositorySettings.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

co.elastic.clients.util.WithJsonObjectBuilderBase<BuilderT>

co.elastic.clients.elasticsearch.snapshot.RepositorySettingsBase.AbstractBuilder<SharedFileSystemRepositorySettings.Builder>

co.elastic.clients.elasticsearch.snapshot.SharedFileSystemRepositorySettings.Builder

All Implemented Interfaces:

WithJson<SharedFileSystemRepositorySettings.Builder>, ObjectBuilder<SharedFileSystemRepositorySettings>

Enclosing class:

SharedFileSystemRepositorySettings

public static class SharedFileSystemRepositorySettings.Builder
extends RepositorySettingsBase.AbstractBuilder<SharedFileSystemRepositorySettings.Builder>
implements ObjectBuilder<SharedFileSystemRepositorySettings>

Builder for SharedFileSystemRepositorySettings.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
SharedFileSystemRepositorySettings	build()	Builds a SharedFileSystemRepositorySettings.
final SharedFileSystemRepositorySettings.Builder	location(String value)	Required - The location of the shared filesystem used to store and retrieve snapshots.
final SharedFileSystemRepositorySettings.Builder	maxNumberOfSnapshots(Integer value)	The maximum number of snapshots the repository can contain.
final SharedFileSystemRepositorySettings.Builder	readonly(Boolean value)	If true, the repository is read-only.
protected SharedFileSystemRepositorySettings.Builder	self()

Methods inherited from class co.elastic.clients.elasticsearch.snapshot.RepositorySettingsBase.AbstractBuilder

chunkSize, compress, maxRestoreBytesPerSec, maxSnapshotBytesPerSec

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

location

public final SharedFileSystemRepositorySettings.Builder location(String value)

Required - The location of the shared filesystem used to store and retrieve snapshots. This location must be registered in the path.repo setting on all master and data nodes in the cluster. Unlike path.repo, this setting supports only a single file path.

API name: location

maxNumberOfSnapshots

public final SharedFileSystemRepositorySettings.Builder maxNumberOfSnapshots(@Nullable
 Integer value)

The maximum number of snapshots the repository can contain. The default is Integer.MAX_VALUE, which is 2^31-1 or 2147483647.

API name: max_number_of_snapshots

readonly

public final SharedFileSystemRepositorySettings.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 SharedFileSystemRepositorySettings.Builder self()

Specified by:

self in class RepositorySettingsBase.AbstractBuilder<SharedFileSystemRepositorySettings.Builder>

build

public SharedFileSystemRepositorySettings build()

Builds a SharedFileSystemRepositorySettings.

Specified by:

build in interface ObjectBuilder<SharedFileSystemRepositorySettings>

Throws:

NullPointerException - if some of the required fields are null.