Package org.opensearch.client.opensearch.snapshot

Class CloneSnapshotRequest.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

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

org.opensearch.client.opensearch.snapshot.CloneSnapshotRequest.Builder

All Implemented Interfaces:

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

Enclosing class:

CloneSnapshotRequest

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

Builder for CloneSnapshotRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CloneSnapshotRequest	build()	Builds a CloneSnapshotRequest.
final CloneSnapshotRequest.Builder	clusterManagerTimeout(Function<Time.Builder,ObjectBuilder<Time>> fn)	The amount of time to wait for a response from the cluster manager node.
final CloneSnapshotRequest.Builder	clusterManagerTimeout(Time value)	The amount of time to wait for a response from the cluster manager node.
CloneSnapshotRequest.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final CloneSnapshotRequest.Builder	indices(String value)	Required - API name: indices
final CloneSnapshotRequest.Builder	masterTimeout(Function<Time.Builder,ObjectBuilder<Time>> fn)	Deprecated.
final CloneSnapshotRequest.Builder	masterTimeout(Time value)	Deprecated.
final CloneSnapshotRequest.Builder	repository(String value)	Required - The name of repository which will contain the snapshots clone.
protected CloneSnapshotRequest.Builder	self()
final CloneSnapshotRequest.Builder	snapshot(String value)	Required - The name of the original snapshot.
final CloneSnapshotRequest.Builder	targetSnapshot(String value)	Required - The name of the cloned snapshot.

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

Returns:

a new builder instance.

self

@Nonnull
protected CloneSnapshotRequest.Builder self()

Specified by:

self in class RequestBase.AbstractBuilder<CloneSnapshotRequest.Builder>

clusterManagerTimeout

@Nonnull
public final CloneSnapshotRequest.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 CloneSnapshotRequest.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

indices

@Nonnull
public final CloneSnapshotRequest.Builder indices(String value)

Required - API name: indices

masterTimeout

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

Deprecated.

Explicit operation timeout for connection to cluster-manager node

API name: master_timeout

masterTimeout

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

Deprecated.

Explicit operation timeout for connection to cluster-manager node

API name: master_timeout

repository

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

Required - The name of repository which will contain the snapshots clone.

API name: repository

snapshot

@Nonnull
public final CloneSnapshotRequest.Builder snapshot(String value)

Required - The name of the original snapshot.

API name: snapshot

targetSnapshot

@Nonnull
public final CloneSnapshotRequest.Builder targetSnapshot(String value)

Required - The name of the cloned snapshot.

API name: target_snapshot

build

@Nonnull
public CloneSnapshotRequest build()

Builds a CloneSnapshotRequest.

Specified by:

build in interface ObjectBuilder<CloneSnapshotRequest>

Throws:

NullPointerException - if some of the required fields are null.