Class ShrinkRequest.Builder
java.lang.Object
co.elastic.clients.util.ObjectBuilderBase
co.elastic.clients.util.WithJsonObjectBuilderBase<BuilderT>
co.elastic.clients.elasticsearch._types.RequestBase.AbstractBuilder<ShrinkRequest.Builder>
co.elastic.clients.elasticsearch.indices.ShrinkRequest.Builder
- All Implemented Interfaces:
WithJson<ShrinkRequest.Builder>
,ObjectBuilder<ShrinkRequest>
- Enclosing class:
- ShrinkRequest
public static class ShrinkRequest.Builder
extends RequestBase.AbstractBuilder<ShrinkRequest.Builder>
implements ObjectBuilder<ShrinkRequest>
Builder for
ShrinkRequest
.-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal ShrinkRequest.Builder
The key is the alias name.final ShrinkRequest.Builder
aliases
(String key, Function<Alias.Builder, ObjectBuilder<Alias>> fn) The key is the alias name.final ShrinkRequest.Builder
The key is the alias name.build()
Builds aShrinkRequest
.final ShrinkRequest.Builder
Required - Name of the source index to shrink.final ShrinkRequest.Builder
masterTimeout
(Time value) Period to wait for a connection to the master node.final ShrinkRequest.Builder
Period to wait for a connection to the master node.protected ShrinkRequest.Builder
self()
final ShrinkRequest.Builder
Configuration options for the target index.final ShrinkRequest.Builder
Configuration options for the target index.final ShrinkRequest.Builder
Required - Name of the target index to create.final ShrinkRequest.Builder
Period to wait for a response.final ShrinkRequest.Builder
Period to wait for a response.final ShrinkRequest.Builder
The number of shard copies that must be active before proceeding with the operation.final ShrinkRequest.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
The key is the alias name. Index alias names support date math.API name:
aliases
Adds all entries of
map
toaliases
. -
aliases
The key is the alias name. Index alias names support date math.API name:
aliases
Adds an entry to
aliases
. -
aliases
public final ShrinkRequest.Builder aliases(String key, Function<Alias.Builder, ObjectBuilder<Alias>> fn) The key is the alias name. Index alias names support date math.API name:
aliases
Adds an entry to
aliases
using a builder lambda. -
index
Required - Name of the source index to shrink.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 ShrinkRequest.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<ShrinkRequest.Builder>
-
build
Builds aShrinkRequest
.- Specified by:
build
in interfaceObjectBuilder<ShrinkRequest>
- Throws:
NullPointerException
- if some of the required fields are null.
-