Class CloneIndexRequest.Builder
java.lang.Object
co.elastic.clients.util.ObjectBuilderBase
co.elastic.clients.util.WithJsonObjectBuilderBase<BuilderT>
co.elastic.clients.elasticsearch._types.RequestBase.AbstractBuilder<CloneIndexRequest.Builder>
co.elastic.clients.elasticsearch.indices.CloneIndexRequest.Builder
- All Implemented Interfaces:
WithJson<CloneIndexRequest.Builder>
,ObjectBuilder<CloneIndexRequest>
- Enclosing class:
- CloneIndexRequest
public static class CloneIndexRequest.Builder
extends RequestBase.AbstractBuilder<CloneIndexRequest.Builder>
implements ObjectBuilder<CloneIndexRequest>
Builder for
CloneIndexRequest
.-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionAPI name:aliases
aliases
(String key, Function<Alias.Builder, ObjectBuilder<Alias>> fn) API name:aliases
API name:aliases
build()
Builds aCloneIndexRequest
.Required - The name of the source index to clonemasterTimeout
(Time value) Specify timeout for connection to masterSpecify timeout for connection to masterprotected CloneIndexRequest.Builder
self()
API name:settings
API name:settings
Required - The name of the target index to clone intoExplicit operation timeoutExplicit operation timeoutSet the number of active shards to wait for on the cloned index before the operation returns.Set the number of active shards to wait for on the cloned index before the operation returns.Methods inherited from class co.elastic.clients.util.WithJsonObjectBuilderBase
withJson
Methods inherited from class co.elastic.clients.util.ObjectBuilderBase
_checkSingleUse, _listAdd, _listAddAll, _mapPut, _mapPutAll
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
aliases
API name:aliases
Adds all entries of
map
toaliases
. -
aliases
API name:aliases
Adds an entry to
aliases
. -
aliases
public final CloneIndexRequest.Builder aliases(String key, Function<Alias.Builder, ObjectBuilder<Alias>> fn) API name:aliases
Adds an entry to
aliases
using a builder lambda. -
index
Required - The name of the source index to cloneAPI name:
index
-
masterTimeout
Specify timeout for connection to masterAPI name:
master_timeout
-
masterTimeout
Specify timeout for connection to masterAPI name:
master_timeout
-
settings
API name:settings
Adds all entries of
map
tosettings
. -
settings
API name:settings
Adds an entry to
settings
. -
target
Required - The name of the target index to clone intoAPI name:
target
-
timeout
Explicit operation timeoutAPI name:
timeout
-
timeout
Explicit operation timeoutAPI name:
timeout
-
waitForActiveShards
Set the number of active shards to wait for on the cloned index before the operation returns.API name:
wait_for_active_shards
-
waitForActiveShards
public final CloneIndexRequest.Builder waitForActiveShards(Function<WaitForActiveShards.Builder, ObjectBuilder<WaitForActiveShards>> fn) Set the number of active shards to wait for on the cloned index before the operation returns.API name:
wait_for_active_shards
-
self
- Specified by:
self
in classRequestBase.AbstractBuilder<CloneIndexRequest.Builder>
-
build
Builds aCloneIndexRequest
.- Specified by:
build
in interfaceObjectBuilder<CloneIndexRequest>
- Throws:
NullPointerException
- if some of the required fields are null.
-