Package co.elastic.clients.elasticsearch.snapshot

Class SharedFileSystemRepositorySettings

java.lang.Object

co.elastic.clients.elasticsearch.snapshot.RepositorySettingsBase

co.elastic.clients.elasticsearch.snapshot.SharedFileSystemRepositorySettings

All Implemented Interfaces:

JsonpSerializable

@JsonpDeserializable
public class SharedFileSystemRepositorySettings
extends RepositorySettingsBase

See Also:

• API specification

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SharedFileSystemRepositorySettings.Builder	Builder for SharedFileSystemRepositorySettings.

Nested classes/interfaces inherited from class co.elastic.clients.elasticsearch.snapshot.RepositorySettingsBase

RepositorySettingsBase.AbstractBuilder<BuilderT extends RepositorySettingsBase.AbstractBuilder<BuilderT>>

Field Summary

Fields

Modifier and Type	Field	Description
static final JsonpDeserializer<SharedFileSystemRepositorySettings>	_DESERIALIZER	Json deserializer for SharedFileSystemRepositorySettings

Method Summary

Modifier and Type	Method	Description
final String	location()	Required - The location of the shared filesystem used to store and retrieve snapshots.
final Integer	maxNumberOfSnapshots()	The maximum number of snapshots the repository can contain.
static SharedFileSystemRepositorySettings	of(Function<SharedFileSystemRepositorySettings.Builder,ObjectBuilder<SharedFileSystemRepositorySettings>> fn)
final Boolean	readonly()	If true, the repository is read-only.
protected void	serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
protected static void	setupSharedFileSystemRepositorySettingsDeserializer(ObjectDeserializer<SharedFileSystemRepositorySettings.Builder> op)

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

chunkSize, compress, maxRestoreBytesPerSec, maxSnapshotBytesPerSec, serialize, setupRepositorySettingsBaseDeserializer, toString

Methods inherited from class java.lang.Object

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

Field Details

_DESERIALIZER

public static final JsonpDeserializer<SharedFileSystemRepositorySettings> _DESERIALIZER

Json deserializer for SharedFileSystemRepositorySettings

Method Details

of

public static SharedFileSystemRepositorySettings of(Function<SharedFileSystemRepositorySettings.Builder,ObjectBuilder<SharedFileSystemRepositorySettings>> fn)

location

public final String location()

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

@Nullable
public final Integer maxNumberOfSnapshots()

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

@Nullable
public final Boolean readonly()

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

serializeInternal

protected void serializeInternal(jakarta.json.stream.JsonGenerator generator,
 JsonpMapper mapper)

Overrides:

serializeInternal in class RepositorySettingsBase

setupSharedFileSystemRepositorySettingsDeserializer

protected static void setupSharedFileSystemRepositorySettingsDeserializer(ObjectDeserializer<SharedFileSystemRepositorySettings.Builder> op)