Package org.opensearch.client.opensearch.snapshot

Class RepositorySettings

java.lang.Object

org.opensearch.client.opensearch.snapshot.RepositorySettings

All Implemented Interfaces:

JsonpSerializable, PlainJsonSerializable, ToCopyableBuilder<RepositorySettings.Builder,RepositorySettings>

@JsonpDeserializable
@Generated("org.opensearch.client.codegen.CodeGenerator")
public class RepositorySettings
extends Object
implements PlainJsonSerializable, ToCopyableBuilder<RepositorySettings.Builder,RepositorySettings>

The settings for the snapshot repository.

Nested Class Summary

Nested Classes

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

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
static RepositorySettings.Builder	builder()
final String	chunkSize()	The chunk size for the repository.
final Boolean	compress()	Whether compression is enabled for the repository.
final Integer	concurrentStreams()	The number of concurrent streams for the repository.
boolean	equals(Object o)
int	hashCode()
final String	location()	The location where snapshots are stored.
static RepositorySettings	of(Function<RepositorySettings.Builder,ObjectBuilder<RepositorySettings>> fn)
final Boolean	readOnly()	Whether the repository is read-only.
void	serialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)	Serialize this object to JSON.
protected void	serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
protected static void	setupRepositorySettingsDeserializer(ObjectDeserializer<RepositorySettings.Builder> op)
RepositorySettings.Builder	toBuilder()	Create a new builder ToCopyableBuilder that is initialised with the current state of this object.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opensearch.client.json.PlainJsonSerializable

toJsonString

Methods inherited from interface org.opensearch.client.util.ToCopyableBuilder

copy

Field Details

_DESERIALIZER

public static final JsonpDeserializer<RepositorySettings> _DESERIALIZER

Json deserializer for RepositorySettings

Method Details

of

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

chunkSize

@Nullable
public final String chunkSize()

The chunk size for the repository.

API name: chunk_size

compress

@Nullable
public final Boolean compress()

Whether compression is enabled for the repository.

API name: compress

concurrentStreams

@Nullable
public final Integer concurrentStreams()

The number of concurrent streams for the repository.

API name: concurrent_streams

location

@Nullable
public final String location()

The location where snapshots are stored.

API name: location

readOnly

@Nullable
public final Boolean readOnly()

Whether the repository is read-only.

API name: read_only

serialize

public void serialize(jakarta.json.stream.JsonGenerator generator,
 JsonpMapper mapper)

Serialize this object to JSON.

Specified by:

serialize in interface JsonpSerializable

serializeInternal

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

toBuilder

@Nonnull
public RepositorySettings.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Create a new builder ToCopyableBuilder that is initialised with the current state of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<RepositorySettings.Builder,RepositorySettings>

Returns:

a new builder instance.

builder

@Nonnull
public static RepositorySettings.Builder builder()

setupRepositorySettingsDeserializer

protected static void setupRepositorySettingsDeserializer(ObjectDeserializer<RepositorySettings.Builder> op)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object