Package co.elastic.clients.elasticsearch.tasks

Class ListRequest.Builder

java.lang.Object
co.elastic.clients.elasticsearch.tasks.ListRequest.Builder
All Implemented Interfaces:
ObjectBuilder<ListRequest>
Enclosing class:
ListRequest
public static class ListRequest.Builder
extends java.lang.Object
implements ObjectBuilder<ListRequest>
Builder for ListRequest.

  • Constructor Summary

    Constructors
    Constructor Description
    Builder()  

  • Method Summary

    Modifier and Type Method Description
    ListRequest.Builder actions​(java.lang.String... value)
    A comma-separated list of actions that should be returned.
    ListRequest.Builder actions​(java.util.List<java.lang.String> value)
    A comma-separated list of actions that should be returned.
    ListRequest.Builder addActions​(java.lang.String value)
    Add a value to actions(List), creating the list if needed.
    ListRequest.Builder addNodes​(java.lang.String value)
    Add a value to nodes(List), creating the list if needed.
    ListRequest build()
    Builds a ListRequest.
    ListRequest.Builder detailed​(java.lang.Boolean value)
    Return detailed task information (default: false)
    ListRequest.Builder groupBy​(GroupBy value)
    Group tasks by nodes or parent/child relationships
    ListRequest.Builder nodes​(java.lang.String... value)
    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
    ListRequest.Builder nodes​(java.util.List<java.lang.String> value)
    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
    ListRequest.Builder parentTaskId​(java.lang.String value)
    Return tasks with specified parent task id (node_id:task_number).
    ListRequest.Builder timeout​(java.lang.String value)
    Explicit operation timeout
    ListRequest.Builder waitForCompletion​(java.lang.Boolean value)
    Wait for the matching tasks to complete (default: false)

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • actions

      public ListRequest.Builder actions​(@Nullable java.util.List<java.lang.String> value)
      A comma-separated list of actions that should be returned. Leave empty to return all.

      API name: actions

    • actions

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

      API name: actions

    • addActions

      public ListRequest.Builder addActions​(java.lang.String value)
      Add a value to actions(List), creating the list if needed.

    • detailed

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

      API name: detailed

    • groupBy

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

      API name: group_by

    • nodes

      public ListRequest.Builder nodes​(@Nullable java.util.List<java.lang.String> value)
      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

    • nodes

      public ListRequest.Builder nodes​(java.lang.String... value)
      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

    • addNodes

      public ListRequest.Builder addNodes​(java.lang.String value)
      Add a value to nodes(List), creating the list if needed.

    • parentTaskId

      public ListRequest.Builder parentTaskId​(@Nullable java.lang.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 ListRequest.Builder timeout​(@Nullable java.lang.String value)
      Explicit operation timeout

      API name: timeout

    • waitForCompletion

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

      API name: wait_for_completion

    • build

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