Package co.elastic.clients.elasticsearch.shutdown

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 Details

    • Builder

      public Builder()

  • Method Details

    • allocationDelay

      public final PutNodeRequest.Builder allocationDelay(@Nullable String value)
      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

      public final PutNodeRequest.Builder masterTimeout(@Nullable Time value)
      The 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

      public final PutNodeRequest.Builder masterTimeout(Function<Time.Builder,ObjectBuilder<Time>> fn)
      The 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

      public final PutNodeRequest.Builder nodeId(String value)
      Required - The node identifier. This parameter is not validated against the cluster's active nodes. This enables you to register a node for shut down while it is offline. No error is thrown if you specify an invalid node ID.

      API name: node_id

    • reason

      public final PutNodeRequest.Builder reason(String value)
      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

      public final PutNodeRequest.Builder targetNodeName(@Nullable String value)
      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

      public final PutNodeRequest.Builder timeout(@Nullable Time value)
      The 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

      public final PutNodeRequest.Builder timeout(Function<Time.Builder,ObjectBuilder<Time>> fn)
      The 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

      public final PutNodeRequest.Builder type(Type value)
      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

      protected PutNodeRequest.Builder self()
      Specified by:
      self in class RequestBase.AbstractBuilder<PutNodeRequest.Builder>

    • build

      public PutNodeRequest build()
      Builds a PutNodeRequest.
      Specified by:
      build in interface ObjectBuilder<PutNodeRequest>
      Throws:
      NullPointerException - if some of the required fields are null.