Package org.opensearch.client.opensearch.snapshot

Class RepositorySettings.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch.snapshot.RepositorySettings.Builder

All Implemented Interfaces:

CopyableBuilder<RepositorySettings.Builder,RepositorySettings>, MutableBuilder<RepositorySettings.Builder,RepositorySettings>, ObjectBuilder<RepositorySettings>

Enclosing class:

RepositorySettings

public static class RepositorySettings.Builder
extends ObjectBuilderBase
implements CopyableBuilder<RepositorySettings.Builder,RepositorySettings>

Builder for RepositorySettings.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
RepositorySettings	build()	Builds a RepositorySettings.
final RepositorySettings.Builder	chunkSize(String value)	The chunk size for the repository.
final RepositorySettings.Builder	compress(Boolean value)	Whether compression is enabled for the repository.
final RepositorySettings.Builder	concurrentStreams(Integer value)	The number of concurrent streams for the repository.
RepositorySettings.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final RepositorySettings.Builder	location(String value)	The location where snapshots are stored.
final RepositorySettings.Builder	readOnly(Boolean value)	Whether the repository is read-only.

Methods inherited from class org.opensearch.client.util.ObjectBuilderBase

_checkSingleUse, _listAdd, _listAddAll, _listCopy, _mapCopy, _mapPut, _mapPutAll

Methods inherited from class java.lang.Object

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

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

applyMutation

Constructor Details

Builder

public Builder()

Method Details

copy

@Nonnull
public RepositorySettings.Builder copy()

Description copied from interface: CopyableBuilder

Create a new builder CopyableBuilder that is a copy of this one.

Specified by:

copy in interface CopyableBuilder<RepositorySettings.Builder,RepositorySettings>

Returns:

a new builder instance.

chunkSize

@Nonnull
public final RepositorySettings.Builder chunkSize(@Nullable
 String value)

The chunk size for the repository.

API name: chunk_size

compress

@Nonnull
public final RepositorySettings.Builder compress(@Nullable
 Boolean value)

Whether compression is enabled for the repository.

API name: compress

concurrentStreams

@Nonnull
public final RepositorySettings.Builder concurrentStreams(@Nullable
 Integer value)

The number of concurrent streams for the repository.

API name: concurrent_streams

location

@Nonnull
public final RepositorySettings.Builder location(@Nullable
 String value)

The location where snapshots are stored.

API name: location

readOnly

@Nonnull
public final RepositorySettings.Builder readOnly(@Nullable
 Boolean value)

Whether the repository is read-only.

API name: read_only

build

@Nonnull
public RepositorySettings build()

Builds a RepositorySettings.

Specified by:

build in interface ObjectBuilder<RepositorySettings>

Throws:

NullPointerException - if some of the required fields are null.