Package org.opensearch.client.opensearch.snapshot

Class CleanupRepositoryRequest.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

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

org.opensearch.client.opensearch.snapshot.CleanupRepositoryRequest.Builder

All Implemented Interfaces:

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

Enclosing class:

CleanupRepositoryRequest

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

Builder for CleanupRepositoryRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CleanupRepositoryRequest	build()	Builds a CleanupRepositoryRequest.
final CleanupRepositoryRequest.Builder	clusterManagerTimeout(Function<Time.Builder,ObjectBuilder<Time>> fn)	The amount of time to wait for a response from the cluster manager node.
final CleanupRepositoryRequest.Builder	clusterManagerTimeout(Time value)	The amount of time to wait for a response from the cluster manager node.
CleanupRepositoryRequest.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final CleanupRepositoryRequest.Builder	masterTimeout(Function<Time.Builder,ObjectBuilder<Time>> fn)	Deprecated.
final CleanupRepositoryRequest.Builder	masterTimeout(Time value)	Deprecated.
final CleanupRepositoryRequest.Builder	repository(String value)	Required - Snapshot repository to clean up.
protected CleanupRepositoryRequest.Builder	self()
final CleanupRepositoryRequest.Builder	timeout(Function<Time.Builder,ObjectBuilder<Time>> fn)	The amount of time to wait for a response.
final CleanupRepositoryRequest.Builder	timeout(Time value)	The amount of time to wait for a response.

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

Returns:

a new builder instance.

self

@Nonnull
protected CleanupRepositoryRequest.Builder self()

Specified by:

self in class RequestBase.AbstractBuilder<CleanupRepositoryRequest.Builder>

clusterManagerTimeout

@Nonnull
public final CleanupRepositoryRequest.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 CleanupRepositoryRequest.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 CleanupRepositoryRequest.Builder masterTimeout(@Nullable
 Time value)

Deprecated.

Period to wait for a connection to the cluster-manager node.

API name: master_timeout

masterTimeout

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

Deprecated.

Period to wait for a connection to the cluster-manager node.

API name: master_timeout

repository

@Nonnull
public final CleanupRepositoryRequest.Builder repository(String value)

Required - Snapshot repository to clean up.

API name: repository

timeout

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

The amount of time to wait for a response.

API name: timeout

timeout

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

The amount of time to wait for a response.

API name: timeout

build

@Nonnull
public CleanupRepositoryRequest build()

Builds a CleanupRepositoryRequest.

Specified by:

build in interface ObjectBuilder<CleanupRepositoryRequest>

Throws:

NullPointerException - if some of the required fields are null.