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 Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal ListRequest.Builder
Comma-separated list or wildcard expression of actions used to limit the request.final ListRequest.Builder
Comma-separated list or wildcard expression of actions used to limit the request.build()
Builds aListRequest
.final ListRequest.Builder
Iftrue
, the response includes detailed information about shard recoveries.final ListRequest.Builder
Key used to group tasks in the response.final ListRequest.Builder
masterTimeout
(Time value) Period to wait for a connection to the master node.final ListRequest.Builder
Period to wait for a connection to the master node.final ListRequest.Builder
Comma-separated list of node IDs or names used to limit returned information.final ListRequest.Builder
Comma-separated list of node IDs or names used to limit returned information.final ListRequest.Builder
parentTaskId
(String value) Parent task ID used to limit returned information.protected ListRequest.Builder
self()
final ListRequest.Builder
Period to wait for a response.final ListRequest.Builder
Period to wait for a response.final ListRequest.Builder
waitForCompletion
(Boolean value) Iftrue
, the request blocks until the operation is complete.Methods inherited from class co.elastic.clients.util.WithJsonObjectBuilderBase
withJson
Methods inherited from class co.elastic.clients.util.ObjectBuilderBase
_checkSingleUse, _listAdd, _listAddAll, _mapPut, _mapPutAll
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
actions
Comma-separated list or wildcard expression of actions used to limit the request.API name:
actions
Adds all elements of
list
toactions
. -
actions
Comma-separated list or wildcard expression of actions used to limit the request.API name:
actions
Adds one or more values to
actions
. -
detailed
Iftrue
, the response includes detailed information about shard recoveries.API name:
detailed
-
groupBy
Key used to group tasks in the response.API name:
group_by
-
masterTimeout
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
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
-
nodeId
Comma-separated list of node IDs or names used to limit returned information.API name:
node_id
Adds all elements of
list
tonodeId
. -
nodeId
Comma-separated list of node IDs or names used to limit returned information.API name:
node_id
Adds one or more values to
nodeId
. -
parentTaskId
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
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
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
Iftrue
, the request blocks until the operation is complete.API name:
wait_for_completion
-
self
- Specified by:
self
in classRequestBase.AbstractBuilder<ListRequest.Builder>
-
build
Builds aListRequest
.- Specified by:
build
in interfaceObjectBuilder<ListRequest>
- Throws:
NullPointerException
- if some of the required fields are null.
-