Package co.elastic.clients.elasticsearch.tasks

Class CancelRequest.Builder

java.lang.Object
co.elastic.clients.util.ObjectBuilderBase
co.elastic.clients.util.WithJsonObjectBuilderBase<BuilderT>
co.elastic.clients.elasticsearch._types.RequestBase.AbstractBuilder<CancelRequest.Builder>
co.elastic.clients.elasticsearch.tasks.CancelRequest.Builder
All Implemented Interfaces:
WithJson<CancelRequest.Builder>, ObjectBuilder<CancelRequest>
Enclosing class:
CancelRequest
public static class CancelRequest.Builder
extends RequestBase.AbstractBuilder<CancelRequest.Builder>
implements ObjectBuilder<CancelRequest>
Builder for CancelRequest.

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • actions

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

      API name: actions

      Adds all elements of list to actions.

    • actions

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

      API name: actions

      Adds one or more values to actions.

    • nodes

      public final CancelRequest.Builder nodes​(java.util.List<java.lang.String> list)
      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

      Adds all elements of list to nodes.

    • nodes

      public final CancelRequest.Builder nodes​(java.lang.String value, java.lang.String... values)
      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

      Adds one or more values to nodes.

    • parentTaskId

      public final 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

    • taskId

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

      API name: task_id

    • waitForCompletion

      public final 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

    • self

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

    • 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.