Class PutNodeRequest.Builder
java.lang.Object
co.elastic.clients.util.ObjectBuilderBase
co.elastic.clients.util.WithJsonObjectBuilderBase<BuilderT>
co.elastic.clients.elasticsearch._types.RequestBase.AbstractBuilder<PutNodeRequest.Builder>
co.elastic.clients.elasticsearch.shutdown.PutNodeRequest.Builder
- All Implemented Interfaces:
WithJson<PutNodeRequest.Builder>
,ObjectBuilder<PutNodeRequest>
- Enclosing class:
- PutNodeRequest
public static class PutNodeRequest.Builder extends RequestBase.AbstractBuilder<PutNodeRequest.Builder> implements ObjectBuilder<PutNodeRequest>
Builder for
PutNodeRequest
.-
Constructor Summary
Constructors Constructor Description Builder()
-
Method Summary
Modifier and Type Method Description PutNodeRequest.Builder
allocationDelay(java.lang.String value)
Only valid if type is restart.PutNodeRequest
build()
Builds aPutNodeRequest
.PutNodeRequest.Builder
masterTimeout(TimeUnit value)
Period to wait for a connection to the master node.PutNodeRequest.Builder
nodeId(java.lang.String value)
Required - The node id of node to be shut downPutNodeRequest.Builder
reason(java.lang.String value)
Required - A human-readable reason that the node is being shut down.protected PutNodeRequest.Builder
self()
PutNodeRequest.Builder
targetNodeName(java.lang.String value)
Only valid if type is replace.PutNodeRequest.Builder
timeout(TimeUnit value)
Period to wait for a response.PutNodeRequest.Builder
type(Type value)
Required - Valid values are restart, remove, or replace.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
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
allocationDelay
Only valid if type is restart. Controls how long Elasticsearch will wait for the node to restart and join the cluster before reassigning its shards to other nodes. This works the same as delaying allocation with the index.unassigned.node_left.delayed_timeout setting. If you specify both a restart allocation delay and an index-level allocation delay, the longer of the two is used.API name:
allocation_delay
-
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
-
nodeId
Required - The node id of node to be shut downAPI name:
node_id
-
reason
Required - A human-readable reason that the node is being shut down. This field provides information for other cluster operators; it does not affect the shut down process.API name:
reason
-
targetNodeName
Only valid if type is replace. Specifies the name of the node that is replacing the node being shut down. Shards from the shut down node are only allowed to be allocated to the target node, and no other data will be allocated to the target node. During relocation of data certain allocation rules are ignored, such as disk watermarks or user attribute filtering rules.API name:
target_node_name
-
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
-
type
Required - Valid values are restart, remove, or replace. Use restart when you need to temporarily shut down a node to perform an upgrade, make configuration changes, or perform other maintenance. Because the node is expected to rejoin the cluster, data is not migrated off of the node. Use remove when you need to permanently remove a node from the cluster. The node is not marked ready for shutdown until data is migrated off of the node Use replace to do a 1:1 replacement of a node with another node. Certain allocation decisions will be ignored (such as disk watermarks) in the interest of true replacement of the source node with the target node. During a replace-type shutdown, rollover and index creation may result in unassigned shards, and shrink may fail until the replacement is complete.API name:
type
-
self
- Specified by:
self
in classRequestBase.AbstractBuilder<PutNodeRequest.Builder>
-
build
Builds aPutNodeRequest
.- Specified by:
build
in interfaceObjectBuilder<PutNodeRequest>
- Throws:
java.lang.NullPointerException
- if some of the required fields are null.
-