Package co.elastic.clients.elasticsearch.tasks

Class ListRequest.Builder

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

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • actions

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

      API name: actions

      Adds all elements of list to actions.

    • actions

      public final ListRequest.Builder actions(String value, String... values)
      A comma-separated list of actions that should be returned. Leave empty to return all.

      API name: actions

      Adds one or more values to actions.

    • detailed

      public final ListRequest.Builder detailed(@Nullable Boolean value)
      Return detailed task information (default: false)

      API name: detailed

    • groupBy

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

      API name: group_by

    • nodes

      public final ListRequest.Builder nodes(List<String> list)
      A comma-separated list of node IDs or names to limit the returned information; use _local to return information from the node you're connecting to, leave empty to get information from all nodes

      API name: nodes

      Adds all elements of list to nodes.

    • nodes

      public final ListRequest.Builder nodes(String value, String... values)
      A comma-separated list of node IDs or names to limit the returned information; use _local to return information from the node you're connecting to, leave empty to get information from all nodes

      API name: nodes

      Adds one or more values to nodes.

    • parentTaskId

      public final ListRequest.Builder parentTaskId(@Nullable String value)
      Return tasks with specified parent task id (node_id:task_number). Set to -1 to return all.

      API name: parent_task_id

    • timeout

      public final ListRequest.Builder timeout(@Nullable Time value)
      Explicit operation timeout

      API name: timeout

    • timeout

      public final ListRequest.Builder timeout(Function<Time.Builder,ObjectBuilder<Time>> fn)
      Explicit operation timeout

      API name: timeout

    • waitForCompletion

      public final ListRequest.Builder waitForCompletion(@Nullable Boolean value)
      Wait for the matching tasks to complete (default: false)

      API name: wait_for_completion

    • self

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

    • build

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