Package org.opensearch.client.opensearch.tasks

Class ListRequest

java.lang.Object
org.opensearch.client.opensearch._types.RequestBase
org.opensearch.client.opensearch.tasks.ListRequest
All Implemented Interfaces:
ToCopyableBuilder<ListRequest.Builder,ListRequest>
@Generated("org.opensearch.client.codegen.CodeGenerator") public final class ListRequest extends RequestBase implements ToCopyableBuilder<ListRequest.Builder,ListRequest>
Returns a list of tasks.

  • Field Details

  • Method Details

    • of

      public static ListRequest of(Function<ListRequest.Builder,ObjectBuilder<ListRequest>> fn)

    • actions

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

      API name: actions

    • detailed

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

      API name: detailed

    • groupBy

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

      API name: group_by

    • nodes

      @Nonnull public final List<String> nodes()
      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

    • parentTaskId

      @Nullable public final String parentTaskId()
      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

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

      API name: timeout

    • waitForCompletion

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

      API name: wait_for_completion

    • toBuilder

      @Nonnull public ListRequest.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Create a new builder ToCopyableBuilder that is initialised with the current state of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<ListRequest.Builder,ListRequest>
      Returns:
      a new builder instance.

    • builder

      @Nonnull public static ListRequest.Builder builder()

    • applyQueryParameters

      protected void applyQueryParameters(@Nonnull Map<String,String> params)
      Overrides:
      applyQueryParameters in class RequestBase

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object