Package co.elastic.clients.elasticsearch.snapshot

Class SourceOnlyRepositorySettings.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

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

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

co.elastic.clients.elasticsearch.snapshot.SourceOnlyRepositorySettings.Builder

All Implemented Interfaces:

WithJson<SourceOnlyRepositorySettings.Builder>, ObjectBuilder<SourceOnlyRepositorySettings>

Enclosing class:

SourceOnlyRepositorySettings

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

Builder for SourceOnlyRepositorySettings.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
SourceOnlyRepositorySettings	build()	Builds a SourceOnlyRepositorySettings.
final SourceOnlyRepositorySettings.Builder	delegateType(String value)	The delegated repository type.
final SourceOnlyRepositorySettings.Builder	maxNumberOfSnapshots(Integer value)	The maximum number of snapshots the repository can contain.
final SourceOnlyRepositorySettings.Builder	readOnly(Boolean value)	If true, the repository is read-only.
protected SourceOnlyRepositorySettings.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

delegateType

public final SourceOnlyRepositorySettings.Builder delegateType(@Nullable
 String value)

The delegated repository type. For valid values, refer to the type parameter. Source repositories can use settings properties for its delegated repository type.

API name: delegate_type

maxNumberOfSnapshots

public final SourceOnlyRepositorySettings.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 SourceOnlyRepositorySettings.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: read_only

self

protected SourceOnlyRepositorySettings.Builder self()

Specified by:

self in class RepositorySettingsBase.AbstractBuilder<SourceOnlyRepositorySettings.Builder>

build

public SourceOnlyRepositorySettings build()

Builds a SourceOnlyRepositorySettings.

Specified by:

build in interface ObjectBuilder<SourceOnlyRepositorySettings>

Throws:

NullPointerException - if some of the required fields are null.