Package co.elastic.clients.elasticsearch.tasks

Class CancelRequest.Builder

java.lang.Object
co.elastic.clients.elasticsearch.tasks.CancelRequest.Builder
All Implemented Interfaces:
ObjectBuilder<CancelRequest>
Enclosing class:
CancelRequest
public static class CancelRequest.Builder
extends java.lang.Object
implements ObjectBuilder<CancelRequest>
Builder for CancelRequest.

  • Constructor Summary

    Constructors
    Constructor Description
    Builder()  

  • Method Summary

    Modifier and Type Method Description
    CancelRequest.Builder actions​(java.lang.String... value)
    A comma-separated list of actions that should be cancelled.
    CancelRequest.Builder actions​(java.util.List<java.lang.String> value)
    A comma-separated list of actions that should be cancelled.
    CancelRequest.Builder addActions​(java.lang.String value)
    Add a value to actions(List), creating the list if needed.
    CancelRequest.Builder addNodes​(java.lang.String value)
    Add a value to nodes(List), creating the list if needed.
    CancelRequest build()
    Builds a CancelRequest.
    CancelRequest.Builder nodes​(java.lang.String... value)
    A comma-separated list of node IDs or names to limit the returned information; use _local to return information from the node you're connecting to, leave empty to get information from all nodes
    CancelRequest.Builder nodes​(java.util.List<java.lang.String> value)
    A comma-separated list of node IDs or names to limit the returned information; use _local to return information from the node you're connecting to, leave empty to get information from all nodes
    CancelRequest.Builder parentTaskId​(java.lang.String value)
    Cancel tasks with specified parent task id (node_id:task_number).
    CancelRequest.Builder taskId​(java.lang.String value)
    Cancel the task with specified task id (node_id:task_number)
    CancelRequest.Builder waitForCompletion​(java.lang.Boolean value)
    Should the request block until the cancellation of the task and its descendant tasks is completed.

    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

    • taskId

      public CancelRequest.Builder taskId​(@Nullable java.lang.String value)
      Cancel the task with specified task id (node_id:task_number)

      API name: task_id

    • actions

      public CancelRequest.Builder actions​(@Nullable java.util.List<java.lang.String> value)
      A comma-separated list of actions that should be cancelled. Leave empty to cancel all.

      API name: actions

    • actions

      public CancelRequest.Builder actions​(java.lang.String... value)
      A comma-separated list of actions that should be cancelled. Leave empty to cancel all.

      API name: actions

    • addActions

      public CancelRequest.Builder addActions​(java.lang.String value)
      Add a value to actions(List), creating the list if needed.

    • nodes

      public CancelRequest.Builder nodes​(@Nullable java.util.List<java.lang.String> value)
      A comma-separated list of node IDs or names to limit the returned information; use _local to return information from the node you're connecting to, leave empty to get information from all nodes

      API name: nodes

    • nodes

      public CancelRequest.Builder nodes​(java.lang.String... value)
      A comma-separated list of node IDs or names to limit the returned information; use _local to return information from the node you're connecting to, leave empty to get information from all nodes

      API name: nodes

    • addNodes

      public CancelRequest.Builder addNodes​(java.lang.String value)
      Add a value to nodes(List), creating the list if needed.

    • parentTaskId

      public CancelRequest.Builder parentTaskId​(@Nullable java.lang.String value)
      Cancel tasks with specified parent task id (node_id:task_number). Set to -1 to cancel all.

      API name: parent_task_id

    • waitForCompletion

      public CancelRequest.Builder waitForCompletion​(@Nullable java.lang.Boolean value)
      Should the request block until the cancellation of the task and its descendant tasks is completed. Defaults to false

      API name: wait_for_completion

    • build

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