Class SplitRequest.Builder
java.lang.Object
co.elastic.clients.util.ObjectBuilderBase
co.elastic.clients.util.WithJsonObjectBuilderBase<BuilderT>
co.elastic.clients.elasticsearch._types.RequestBase.AbstractBuilder<SplitRequest.Builder>
co.elastic.clients.elasticsearch.indices.SplitRequest.Builder
- All Implemented Interfaces:
WithJson<SplitRequest.Builder>
,ObjectBuilder<SplitRequest>
- Enclosing class:
- SplitRequest
public static class SplitRequest.Builder
extends RequestBase.AbstractBuilder<SplitRequest.Builder>
implements ObjectBuilder<SplitRequest>
Builder for
SplitRequest
.-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionfinal SplitRequest.Builder
Aliases for the resulting index.final SplitRequest.Builder
aliases
(String key, Function<Alias.Builder, ObjectBuilder<Alias>> fn) Aliases for the resulting index.final SplitRequest.Builder
Aliases for the resulting index.build()
Builds aSplitRequest
.final SplitRequest.Builder
Required - Name of the source index to split.final SplitRequest.Builder
masterTimeout
(Time value) Period to wait for a connection to the master node.final SplitRequest.Builder
Period to wait for a connection to the master node.protected SplitRequest.Builder
self()
final SplitRequest.Builder
Configuration options for the target index.final SplitRequest.Builder
Configuration options for the target index.final SplitRequest.Builder
Required - Name of the target index to create.final SplitRequest.Builder
Period to wait for a response.final SplitRequest.Builder
Period to wait for a response.final SplitRequest.Builder
The number of shard copies that must be active before proceeding with the operation.final SplitRequest.Builder
The number of shard copies that must be active before proceeding with the operation.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
Aliases for the resulting index.API name:
aliases
Adds all entries of
map
toaliases
. -
aliases
Aliases for the resulting index.API name:
aliases
Adds an entry to
aliases
. -
aliases
public final SplitRequest.Builder aliases(String key, Function<Alias.Builder, ObjectBuilder<Alias>> fn) Aliases for the resulting index.API name:
aliases
Adds an entry to
aliases
using a builder lambda. -
index
Required - Name of the source index to split.API name:
index
-
masterTimeout
Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.API name:
master_timeout
-
masterTimeout
Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.API name:
master_timeout
-
settings
Configuration options for the target index.API name:
settings
Adds all entries of
map
tosettings
. -
settings
Configuration options for the target index.API name:
settings
Adds an entry to
settings
. -
target
Required - Name of the target index to create.API name:
target
-
timeout
Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.API name:
timeout
-
timeout
Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.API name:
timeout
-
waitForActiveShards
The number of shard copies that must be active before proceeding with the operation. Set toall
or any positive integer up to the total number of shards in the index (number_of_replicas+1
).API name:
wait_for_active_shards
-
waitForActiveShards
public final SplitRequest.Builder waitForActiveShards(Function<WaitForActiveShards.Builder, ObjectBuilder<WaitForActiveShards>> fn) The number of shard copies that must be active before proceeding with the operation. Set toall
or any positive integer up to the total number of shards in the index (number_of_replicas+1
).API name:
wait_for_active_shards
-
self
- Specified by:
self
in classRequestBase.AbstractBuilder<SplitRequest.Builder>
-
build
Builds aSplitRequest
.- Specified by:
build
in interfaceObjectBuilder<SplitRequest>
- Throws:
NullPointerException
- if some of the required fields are null.
-