Package co.elastic.clients.elasticsearch.cat

Class TasksRequest.Builder

java.lang.Object
co.elastic.clients.util.ObjectBuilderBase
co.elastic.clients.util.WithJsonObjectBuilderBase<BuilderT>
co.elastic.clients.elasticsearch._types.RequestBase.AbstractBuilder<BuilderT>
co.elastic.clients.elasticsearch.cat.CatRequestBase.AbstractBuilder<TasksRequest.Builder>
co.elastic.clients.elasticsearch.cat.TasksRequest.Builder
All Implemented Interfaces:
WithJson<TasksRequest.Builder>, ObjectBuilder<TasksRequest>
Enclosing class:
TasksRequest
public static class TasksRequest.Builder extends CatRequestBase.AbstractBuilder<TasksRequest.Builder> implements ObjectBuilder<TasksRequest>
Builder for TasksRequest.

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • actions

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

      API name: actions

      Adds all elements of list to actions.

    • actions

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

      API name: actions

      Adds one or more values to actions.

    • detailed

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

      API name: detailed

    • h

      public final TasksRequest.Builder h(List<String> list)
      List of columns to appear in the response. Supports simple wildcards.

      API name: h

      Adds all elements of list to h.

    • h

      public final TasksRequest.Builder h(String value, String... values)
      List of columns to appear in the response. Supports simple wildcards.

      API name: h

      Adds one or more values to h.

    • nodes

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

      API name: nodes

      Adds all elements of list to nodes.

    • nodes

      public final TasksRequest.Builder nodes(String value, String... values)
      Unique node identifiers, which are used to limit the response.

      API name: nodes

      Adds one or more values to nodes.

    • parentTaskId

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

      API name: parent_task_id

    • s

      public final TasksRequest.Builder s(List<String> list)
      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

      Adds all elements of list to s.

    • s

      public final TasksRequest.Builder s(String value, String... values)
      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

      Adds one or more values to s.

    • time

      public final TasksRequest.Builder time(@Nullable TimeUnit value)
      Unit used to display time values.

      API name: time

    • timeout

      public final TasksRequest.Builder timeout(@Nullable Time value)
      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

    • timeout

      public final TasksRequest.Builder timeout(Function<Time.Builder,ObjectBuilder<Time>> fn)
      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

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

      API name: wait_for_completion

    • self

      protected TasksRequest.Builder self()
      Specified by:
      self in class CatRequestBase.AbstractBuilder<TasksRequest.Builder>

    • build

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