Package org.opensearch.client.opensearch.snapshot

Class CreateRepositoryRequest.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch._types.RequestBase.AbstractBuilder<CreateRepositoryRequest.Builder>

org.opensearch.client.opensearch.snapshot.CreateRepositoryRequest.Builder

All Implemented Interfaces:

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

Enclosing class:

CreateRepositoryRequest

public static class CreateRepositoryRequest.Builder
extends RequestBase.AbstractBuilder<CreateRepositoryRequest.Builder>
implements CopyableBuilder<CreateRepositoryRequest.Builder,CreateRepositoryRequest>

Builder for CreateRepositoryRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CreateRepositoryRequest	build()	Builds a CreateRepositoryRequest.
final CreateRepositoryRequest.Builder	clusterManagerTimeout(Function<Time.Builder,ObjectBuilder<Time>> fn)	The amount of time to wait for a response from the cluster manager node.
final CreateRepositoryRequest.Builder	clusterManagerTimeout(Time value)	The amount of time to wait for a response from the cluster manager node.
CreateRepositoryRequest.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final CreateRepositoryRequest.Builder	masterTimeout(Function<Time.Builder,ObjectBuilder<Time>> fn)	Deprecated.
final CreateRepositoryRequest.Builder	masterTimeout(Time value)	Deprecated.
final CreateRepositoryRequest.Builder	name(String value)	Required - The name for the newly registered repository.
final CreateRepositoryRequest.Builder	repository(Function<Repository.Builder,ObjectBuilder<Repository>> fn)	API name: repository
final CreateRepositoryRequest.Builder	repository(Repository value)	API name: repository
protected CreateRepositoryRequest.Builder	self()
final CreateRepositoryRequest.Builder	settings(Function<RepositorySettings.Builder,ObjectBuilder<RepositorySettings>> fn)	Required - API name: settings
final CreateRepositoryRequest.Builder	settings(RepositorySettings value)	Required - API name: settings
final CreateRepositoryRequest.Builder	timeout(Function<Time.Builder,ObjectBuilder<Time>> fn)	The amount of time to wait for a response.
final CreateRepositoryRequest.Builder	timeout(Time value)	The amount of time to wait for a response.
final CreateRepositoryRequest.Builder	type(String value)	Required - API name: type
final CreateRepositoryRequest.Builder	verify(Boolean value)	When true, verifies the creation of the snapshot repository.

Methods inherited from class org.opensearch.client.opensearch._types.RequestBase.AbstractBuilder

errorTrace, human

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

Returns:

a new builder instance.

self

@Nonnull
protected CreateRepositoryRequest.Builder self()

Specified by:

self in class RequestBase.AbstractBuilder<CreateRepositoryRequest.Builder>

clusterManagerTimeout

@Nonnull
public final CreateRepositoryRequest.Builder clusterManagerTimeout(@Nullable
 Time value)

The amount of time to wait for a response from the cluster manager node. For more information about supported time units, see Common parameters.

API name: cluster_manager_timeout

clusterManagerTimeout

@Nonnull
public final CreateRepositoryRequest.Builder clusterManagerTimeout(Function<Time.Builder,ObjectBuilder<Time>> fn)

The amount of time to wait for a response from the cluster manager node. For more information about supported time units, see Common parameters.

API name: cluster_manager_timeout

masterTimeout

@Deprecated
@Nonnull
public final CreateRepositoryRequest.Builder masterTimeout(@Nullable
 Time value)

Deprecated.

Explicit operation timeout for connection to cluster-manager node

API name: master_timeout

masterTimeout

@Deprecated
@Nonnull
public final CreateRepositoryRequest.Builder masterTimeout(Function<Time.Builder,ObjectBuilder<Time>> fn)

Deprecated.

Explicit operation timeout for connection to cluster-manager node

API name: master_timeout

name

@Nonnull
public final CreateRepositoryRequest.Builder name(String value)

Required - The name for the newly registered repository.

API name: repository

repository

@Nonnull
public final CreateRepositoryRequest.Builder repository(@Nullable
 Repository value)

API name: repository

repository

@Nonnull
public final CreateRepositoryRequest.Builder repository(Function<Repository.Builder,ObjectBuilder<Repository>> fn)

API name: repository

settings

@Nonnull
public final CreateRepositoryRequest.Builder settings(RepositorySettings value)

Required - API name: settings

settings

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

Required - API name: settings

timeout

@Nonnull
public final CreateRepositoryRequest.Builder timeout(@Nullable
 Time value)

The amount of time to wait for a response.

API name: timeout

timeout

@Nonnull
public final CreateRepositoryRequest.Builder timeout(Function<Time.Builder,ObjectBuilder<Time>> fn)

The amount of time to wait for a response.

API name: timeout

type

@Nonnull
public final CreateRepositoryRequest.Builder type(String value)

Required - API name: type

verify

@Nonnull
public final CreateRepositoryRequest.Builder verify(@Nullable
 Boolean value)

When true, verifies the creation of the snapshot repository.

API name: verify

build

@Nonnull
public CreateRepositoryRequest build()

Builds a CreateRepositoryRequest.

Specified by:

build in interface ObjectBuilder<CreateRepositoryRequest>

Throws:

NullPointerException - if some of the required fields are null.