Package org.opensearch.client.opensearch.tasks

Class ListRequest.Builder

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

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • copy

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

    • self

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

    • actions

      @Nonnull public final ListRequest.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 ListRequest.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.

    • detailed

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

      API name: detailed

    • groupBy

      @Nonnull public final ListRequest.Builder groupBy(@Nullable GroupBy value)
      Groups tasks by parent/child relationships or nodes.

      API name: group_by

    • nodes

      @Nonnull public final ListRequest.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 ListRequest.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 ListRequest.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

    • timeout

      @Nonnull public final ListRequest.Builder timeout(@Nullable Time value)
      The amount of time to wait for a response.

      API name: timeout

    • timeout

      @Nonnull public final ListRequest.Builder timeout(Function<Time.Builder,ObjectBuilder<Time>> fn)
      The amount of time to wait for a response.

      API name: timeout

    • waitForCompletion

      @Nonnull public final ListRequest.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 ListRequest build()
      Builds a ListRequest.
      Specified by:
      build in interface ObjectBuilder<ListRequest>
      Throws:
      NullPointerException - if some of the required fields are null.