Package co.elastic.clients.elasticsearch.indices

Class CloneIndexRequest.Builder

java.lang.Object

co.elastic.clients.elasticsearch.indices.CloneIndexRequest.Builder

All Implemented Interfaces:

ObjectBuilder<CloneIndexRequest>

Enclosing class:

CloneIndexRequest

public static class CloneIndexRequest.Builder
extends java.lang.Object
implements ObjectBuilder<CloneIndexRequest>

Builder for CloneIndexRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CloneIndexRequest.Builder	aliases(java.lang.String key, java.util.function.Function<Alias.Builder,ObjectBuilder<Alias>> fn)	Set aliases(Map) to a singleton map.
CloneIndexRequest.Builder	aliases(java.util.Map<java.lang.String,Alias> value)	API name: aliases
CloneIndexRequest	build()	Builds a CloneIndexRequest.
CloneIndexRequest.Builder	index(java.lang.String value)	Required - The name of the source index to clone
CloneIndexRequest.Builder	masterTimeout(java.lang.String value)	Specify timeout for connection to master
CloneIndexRequest.Builder	putAliases(java.lang.String key, Alias value)	Add a key/value to aliases(Map), creating the map if needed.
CloneIndexRequest.Builder	putAliases(java.lang.String key, java.util.function.Function<Alias.Builder,ObjectBuilder<Alias>> fn)	Add a key/value to aliases(Map), creating the map if needed.
CloneIndexRequest.Builder	putSettings(java.lang.String key, JsonData value)	Add a key/value to settings(Map), creating the map if needed.
CloneIndexRequest.Builder	settings(java.util.Map<java.lang.String,JsonData> value)	API name: settings
CloneIndexRequest.Builder	target(java.lang.String value)	Required - The name of the target index to clone into
CloneIndexRequest.Builder	timeout(java.lang.String value)	Explicit operation timeout
CloneIndexRequest.Builder	waitForActiveShards(jakarta.json.JsonValue value)	Set the number of active shards to wait for on the cloned index before the operation returns.

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

index

public CloneIndexRequest.Builder index(java.lang.String value)

Required - The name of the source index to clone

API name: index

target

public CloneIndexRequest.Builder target(java.lang.String value)

Required - The name of the target index to clone into

API name: target

masterTimeout

public CloneIndexRequest.Builder masterTimeout(@Nullable
java.lang.String value)

Specify timeout for connection to master

API name: master_timeout

timeout

public CloneIndexRequest.Builder timeout(@Nullable
java.lang.String value)

Explicit operation timeout

API name: timeout

waitForActiveShards

public CloneIndexRequest.Builder waitForActiveShards(@Nullable
jakarta.json.JsonValue value)

Set the number of active shards to wait for on the cloned index before the operation returns.

API name: wait_for_active_shards

aliases

public CloneIndexRequest.Builder aliases(@Nullable
java.util.Map<java.lang.String,Alias> value)

API name: aliases

putAliases

public CloneIndexRequest.Builder putAliases(java.lang.String key,
Alias value)

Add a key/value to aliases(Map), creating the map if needed.

aliases

public CloneIndexRequest.Builder aliases(java.lang.String key,
java.util.function.Function<Alias.Builder,ObjectBuilder<Alias>> fn)

Set aliases(Map) to a singleton map.

putAliases

public CloneIndexRequest.Builder putAliases(java.lang.String key,
java.util.function.Function<Alias.Builder,ObjectBuilder<Alias>> fn)

Add a key/value to aliases(Map), creating the map if needed.

settings

public CloneIndexRequest.Builder settings(@Nullable
java.util.Map<java.lang.String,JsonData> value)

API name: settings

putSettings

public CloneIndexRequest.Builder putSettings(java.lang.String key,
JsonData value)

Add a key/value to settings(Map), creating the map if needed.

build

public CloneIndexRequest build()

Builds a CloneIndexRequest.

Specified by:

build in interface ObjectBuilder<CloneIndexRequest>

Throws:

java.lang.NullPointerException - if some of the required fields are null.