Package org.opensearch.client.opensearch.cat

Class TasksRequest.Builder

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

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • copy

      @Nonnull public TasksRequest.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<TasksRequest.Builder,TasksRequest>
      Returns:
      a new builder instance.

    • self

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

    • actions

      @Nonnull public final TasksRequest.Builder actions(List<String> list)
      The task action names used to limit the response.

      API name: actions

      Adds all elements of list to actions.

    • actions

      @Nonnull public final TasksRequest.Builder actions(String value, String... values)
      The task action names used to limit the response.

      API name: actions

      Adds one or more values to actions.

    • detailed

      @Nonnull public final TasksRequest.Builder detailed(@Nullable Boolean value)
      If true, the response includes detailed information about shard recoveries.

      API name: detailed

    • nodes

      @Nonnull public final TasksRequest.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 to which you're connecting, specify a specific node from which to get information, 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 TasksRequest.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 to which you're connecting, specify a specific node from which to get information, 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 TasksRequest.Builder parentTaskId(@Nullable String value)
      The parent task identifier, which is used to limit the response.

      API name: parent_task_id

    • time

      @Nonnull public final TasksRequest.Builder time(@Nullable TimeUnit value)
      Specifies the time units, for example, 5d or 7h. For more information, see Supported units.

      API name: time

    • build

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