Package co.elastic.clients.elasticsearch.cat

Class TasksRequest

java.lang.Object
co.elastic.clients.elasticsearch._types.RequestBase
co.elastic.clients.elasticsearch.cat.CatRequestBase
co.elastic.clients.elasticsearch.cat.TasksRequest
public class TasksRequest extends CatRequestBase
Get task information.

Get information about tasks currently running in the cluster. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the task management API.

See Also:

  • Field Details

  • Method Details

    • of

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

    • actions

      public final List<String> actions()
      The task action names, which are used to limit the response.

      API name: actions

    • bytes

      @Nullable public final Bytes bytes()
      Sets the units for columns that contain a byte-size value. Note that byte-size value units work in terms of powers of 1024. For instance 1kb means 1024 bytes, not 1000 bytes. If omitted, byte-size values are rendered with a suffix such as kb, mb, or gb, chosen such that the numeric value of the column is as small as possible whilst still being at least 1.0. If given, byte-size values are rendered as an integer with no suffix, representing the value of the column in the chosen unit. Values that are not an exact multiple of the chosen unit are rounded down.

      API name: bytes

    • detailed

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

      API name: detailed

    • h

      public final List<String> h()
      A comma-separated list of columns names to display. It supports simple wildcards.

      API name: h

    • nodes

      public final List<String> nodes()
      Unique node identifiers, which are used to limit the response.

      API name: nodes

    • parentTaskId

      @Nullable public final String parentTaskId()
      The parent task identifier, which is used to limit the response.

      API name: parent_task_id

    • s

      public final List<String> s()
      List of columns that determine how the table should be sorted. Sorting defaults to ascending and can be changed by setting :asc or :desc as a suffix to the column name.

      API name: s

    • time

      @Nullable public final TimeUnit time()
      Sets the units for columns that contain a time duration. If omitted, time duration values are rendered with a suffix such as ms, s, m or h, chosen such that the numeric value of the column is as small as possible whilst still being at least 1.0. If given, time duration values are rendered as an integer with no suffix. Values that are not an exact multiple of the chosen unit are rounded down.

      API name: time

    • timeout

      @Nullable public final Time timeout()
      Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.

      API name: timeout

    • waitForCompletion

      @Nullable public final Boolean waitForCompletion()
      If true, the request blocks until the task has completed.

      API name: wait_for_completion