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 or wildcard expression of actions used to limit the request. For example, you can use cluser:* to retrieve all cluster-related tasks.

      API name: actions

      Adds all elements of list to actions.

    • actions

      public final ListRequest.Builder actions(String value, String... values)
      A comma-separated list or wildcard expression of actions used to limit the request. For example, you can use cluser:* to retrieve all cluster-related tasks.

      API name: actions

      Adds one or more values to actions.

    • detailed

      public final ListRequest.Builder detailed(@Nullable Boolean value)
      If true, the response includes detailed information about the running tasks. This information is useful to distinguish tasks from each other but is more costly to run.

      API name: detailed

    • groupBy

      public final ListRequest.Builder groupBy(@Nullable GroupBy value)
      A key that is used to group tasks in the response. The task lists can be grouped either by nodes or by parent tasks.

      API name: group_by

    • nodes

      public final ListRequest.Builder nodes(List<String> list)
      A comma-separated list of node IDs or names that is used to limit the returned information.

      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 that is used to limit the returned information.

      API name: nodes

      Adds one or more values to nodes.

    • parentTaskId

      public final ListRequest.Builder parentTaskId(@Nullable String value)
      A parent task identifier that is used to limit returned information. To return all tasks, omit this parameter or use a value of -1. If the parent task is not found, the API does not return a 404 response code.

      API name: parent_task_id

    • timeout

      public final ListRequest.Builder timeout(@Nullable Time value)
      The period to wait for each node to respond. If a node does not respond before its timeout expires, the response does not include its information. However, timed out nodes are included in the node_failures property.

      API name: timeout

    • timeout

      public final ListRequest.Builder timeout(Function<Time.Builder,ObjectBuilder<Time>> fn)
      The period to wait for each node to respond. If a node does not respond before its timeout expires, the response does not include its information. However, timed out nodes are included in the node_failures property.

      API name: timeout

    • waitForCompletion

      public final ListRequest.Builder waitForCompletion(@Nullable Boolean value)
      If true, the request blocks until the operation is complete.

      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.