Package org.opensearch.client.opensearch.snapshot

Class Repository.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch.snapshot.Repository.Builder

All Implemented Interfaces:

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

Enclosing class:

Repository

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

Builder for Repository.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
Repository	build()	Builds a Repository.
Repository.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final Repository.Builder	settings(Function<RepositorySettings.Builder,ObjectBuilder<RepositorySettings>> fn)	The configuration settings for the repository.
final Repository.Builder	settings(RepositorySettings value)	The configuration settings for the repository.
final Repository.Builder	type(String value)	The type of the snapshot repository.
final Repository.Builder	uuid(String value)	The unique identifier for the repository.

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 Repository.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<Repository.Builder,Repository>

Returns:

a new builder instance.

settings

@Nonnull
public final Repository.Builder settings(@Nullable
 RepositorySettings value)

The configuration settings for the repository.

API name: settings

settings

@Nonnull
public final Repository.Builder settings(Function<RepositorySettings.Builder,ObjectBuilder<RepositorySettings>> fn)

The configuration settings for the repository.

API name: settings

type

@Nonnull
public final Repository.Builder type(@Nullable
 String value)

The type of the snapshot repository.

API name: type

uuid

@Nonnull
public final Repository.Builder uuid(@Nullable
 String value)

The unique identifier for the repository.

API name: uuid

build

@Nonnull
public Repository build()

Builds a Repository.

Specified by:

build in interface ObjectBuilder<Repository>

Throws:

NullPointerException - if some of the required fields are null.