Package org.opensearch.client.opensearch.tasks

Class CancelRequest.Builder

java.lang.Object
org.opensearch.client.util.ObjectBuilderBase
org.opensearch.client.opensearch._types.RequestBase.AbstractBuilder<CancelRequest.Builder>
org.opensearch.client.opensearch.tasks.CancelRequest.Builder
All Implemented Interfaces:
CopyableBuilder<CancelRequest.Builder,CancelRequest>, MutableBuilder<CancelRequest.Builder,CancelRequest>, ObjectBuilder<CancelRequest>
Enclosing class:
CancelRequest
public static class CancelRequest.Builder extends RequestBase.AbstractBuilder<CancelRequest.Builder> implements CopyableBuilder<CancelRequest.Builder,CancelRequest>
Builder for CancelRequest.

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • copy

      @Nonnull public CancelRequest.Builder copy()
      Description copied from interface: CopyableBuilder
      Create a new builder CopyableBuilder that is a copy of this one.
      Specified by:
      copy in interface CopyableBuilder<CancelRequest.Builder,CancelRequest>
      Returns:
      a new builder instance.

    • self

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

    • actions

      @Nonnull public final CancelRequest.Builder actions(List<String> list)
      A comma-separated list of actions that should be returned. Keep empty to return all.

      API name: actions

      Adds all elements of list to actions.

    • actions

      @Nonnull public final CancelRequest.Builder actions(String value, String... values)
      A comma-separated list of actions that should be returned. Keep empty to return all.

      API name: actions

      Adds one or more values to actions.

    • nodes

      @Nonnull public final CancelRequest.Builder nodes(List<String> list)
      A comma-separated list of node IDs or names used to limit the returned information. Use _local to return information from the node you're connecting to, specify the node name to get information from a specific node, or keep the parameter empty to get information from all nodes.

      API name: nodes

      Adds all elements of list to nodes.

    • nodes

      @Nonnull public final CancelRequest.Builder nodes(String value, String... values)
      A comma-separated list of node IDs or names used to limit the returned information. Use _local to return information from the node you're connecting to, specify the node name to get information from a specific node, or keep the parameter empty to get information from all nodes.

      API name: nodes

      Adds one or more values to nodes.

    • parentTaskId

      @Nonnull public final CancelRequest.Builder parentTaskId(@Nullable String value)
      Returns tasks with a specified parent task ID (node_id:task_number). Keep empty or set to -1 to return all.

      API name: parent_task_id

    • taskId

      @Nonnull public final CancelRequest.Builder taskId(@Nullable String value)
      The task ID.

      API name: task_id

    • waitForCompletion

      @Nonnull public final CancelRequest.Builder waitForCompletion(@Nullable Boolean value)
      Waits for the matching task to complete. When true, the request is blocked until the task has completed.

      API name: wait_for_completion

    • build

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