Package co.elastic.clients.elasticsearch.snapshot

Class CloneSnapshotRequest.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

co.elastic.clients.util.WithJsonObjectBuilderBase<BuilderT>

co.elastic.clients.elasticsearch._types.RequestBase.AbstractBuilder<CloneSnapshotRequest.Builder>

co.elastic.clients.elasticsearch.snapshot.CloneSnapshotRequest.Builder

All Implemented Interfaces:

WithJson<CloneSnapshotRequest.Builder>, ObjectBuilder<CloneSnapshotRequest>

Enclosing class:

CloneSnapshotRequest

public static class CloneSnapshotRequest.Builder
extends RequestBase.AbstractBuilder<CloneSnapshotRequest.Builder>
implements ObjectBuilder<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	indices(String value)	Required - A comma-separated list of indices to include in the snapshot.
final CloneSnapshotRequest.Builder	masterTimeout(Time value)	The period to wait for the master node.
final CloneSnapshotRequest.Builder	masterTimeout(Function<Time.Builder,ObjectBuilder<Time>> fn)	The period to wait for the master node.
final CloneSnapshotRequest.Builder	repository(String value)	Required - The name of the snapshot repository that both source and target snapshot belong to.
protected CloneSnapshotRequest.Builder	self()
final CloneSnapshotRequest.Builder	snapshot(String value)	Required - The source snapshot name.
final CloneSnapshotRequest.Builder	targetSnapshot(String value)	Required - The target snapshot name.

Methods inherited from class co.elastic.clients.util.WithJsonObjectBuilderBase

withJson

Methods inherited from class co.elastic.clients.util.ObjectBuilderBase

_checkSingleUse, _listAdd, _listAddAll, _mapPut, _mapPutAll

Methods inherited from class java.lang.Object

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

Methods inherited from interface co.elastic.clients.json.WithJson

withJson, withJson

Constructor Details

Builder

public Builder()

Method Details

indices

public final CloneSnapshotRequest.Builder indices(String value)

Required - A comma-separated list of indices to include in the snapshot. Multi-target syntax is supported.

API name: indices

masterTimeout

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

The period to wait for the master node. If the master node is not available before the timeout expires, the request fails and returns an error. To indicate that the request should never timeout, set it to -1.

API name: master_timeout

masterTimeout

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

The period to wait for the master node. If the master node is not available before the timeout expires, the request fails and returns an error. To indicate that the request should never timeout, set it to -1.

API name: master_timeout

repository

public final CloneSnapshotRequest.Builder repository(String value)

Required - The name of the snapshot repository that both source and target snapshot belong to.

API name: repository

snapshot

public final CloneSnapshotRequest.Builder snapshot(String value)

Required - The source snapshot name.

API name: snapshot

targetSnapshot

public final CloneSnapshotRequest.Builder targetSnapshot(String value)

Required - The target snapshot name.

API name: target_snapshot

self

protected CloneSnapshotRequest.Builder self()

Specified by:

self in class RequestBase.AbstractBuilder<CloneSnapshotRequest.Builder>

build

public CloneSnapshotRequest build()

Builds a CloneSnapshotRequest.

Specified by:

build in interface ObjectBuilder<CloneSnapshotRequest>

Throws:

NullPointerException - if some of the required fields are null.