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)
      Comma-separated list or wildcard expression of actions used to limit the request.

      API name: actions

      Adds all elements of list to actions.

    • actions

      public final ListRequest.Builder actions(String value, String... values)
      Comma-separated list or wildcard expression of actions used to limit the request.

      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 shard recoveries. 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)
      Key used to group tasks in the response.

      API name: group_by

    • masterTimeout

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

      API name: master_timeout

    • masterTimeout

      public final ListRequest.Builder masterTimeout(Function<Time.Builder,ObjectBuilder<Time>> fn)
      Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.

      API name: master_timeout

    • nodes

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

      API name: nodes

      Adds all elements of list to nodes.

    • nodes

      public final ListRequest.Builder nodes(String value, String... values)
      Comma-separated list of node IDs or names used to limit returned information.

      API name: nodes

      Adds one or more values to nodes.

    • parentTaskId

      public final ListRequest.Builder parentTaskId(@Nullable String value)
      Parent task ID used to limit returned information. To return all tasks, omit this parameter or use a value of -1.

      API name: parent_task_id

    • timeout

      public final ListRequest.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 ListRequest.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 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.