Package co.elastic.clients.elasticsearch.snapshot

Class SourceOnlyRepositorySettings

java.lang.Object

co.elastic.clients.elasticsearch.snapshot.RepositorySettingsBase

co.elastic.clients.elasticsearch.snapshot.SourceOnlyRepositorySettings

All Implemented Interfaces:

JsonpSerializable

@JsonpDeserializable
public class SourceOnlyRepositorySettings
extends RepositorySettingsBase

See Also:

• API specification

Nested Class Summary

Nested Classes

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

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<SourceOnlyRepositorySettings>	_DESERIALIZER	Json deserializer for SourceOnlyRepositorySettings

Method Summary

Modifier and Type	Method	Description
final String	delegateType()	The delegated repository type.
final Integer	maxNumberOfSnapshots()	The maximum number of snapshots the repository can contain.
static SourceOnlyRepositorySettings	of(Function<SourceOnlyRepositorySettings.Builder,ObjectBuilder<SourceOnlyRepositorySettings>> fn)
final Boolean	readOnly()	If true, the repository is read-only.
protected void	serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
protected static void	setupSourceOnlyRepositorySettingsDeserializer(ObjectDeserializer<SourceOnlyRepositorySettings.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<SourceOnlyRepositorySettings> _DESERIALIZER

Json deserializer for SourceOnlyRepositorySettings

Method Details

of

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

delegateType

@Nullable
public final String delegateType()

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

@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: read_only

serializeInternal

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

Overrides:

serializeInternal in class RepositorySettingsBase

setupSourceOnlyRepositorySettingsDeserializer

protected static void setupSourceOnlyRepositorySettingsDeserializer(ObjectDeserializer<SourceOnlyRepositorySettings.Builder> op)