Package co.elastic.clients.elasticsearch.cat

Class SegmentsRequest.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

co.elastic.clients.util.WithJsonObjectBuilderBase<BuilderT>

co.elastic.clients.elasticsearch._types.RequestBase.AbstractBuilder<BuilderT>

co.elastic.clients.elasticsearch.cat.CatRequestBase.AbstractBuilder<SegmentsRequest.Builder>

co.elastic.clients.elasticsearch.cat.SegmentsRequest.Builder

All Implemented Interfaces:

WithJson<SegmentsRequest.Builder>, ObjectBuilder<SegmentsRequest>

Enclosing class:

SegmentsRequest

public static class SegmentsRequest.Builder
extends CatRequestBase.AbstractBuilder<SegmentsRequest.Builder>
implements ObjectBuilder<SegmentsRequest>

Builder for SegmentsRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
SegmentsRequest	build()	Builds a SegmentsRequest.
final SegmentsRequest.Builder	bytes(Bytes value)	The unit used to display byte values.
final SegmentsRequest.Builder	index(String value, String... values)	A comma-separated list of data streams, indices, and aliases used to limit the request.
final SegmentsRequest.Builder	index(List<String> list)	A comma-separated list of data streams, indices, and aliases used to limit the request.
final SegmentsRequest.Builder	local(Boolean value)	If true, the request computes the list of selected nodes from the local cluster state.
final SegmentsRequest.Builder	masterTimeout(Time value)	Period to wait for a connection to the master node.
final SegmentsRequest.Builder	masterTimeout(Function<Time.Builder,ObjectBuilder<Time>> fn)	Period to wait for a connection to the master node.
protected SegmentsRequest.Builder	self()

Methods inherited from class co.elastic.clients.util.WithJsonObjectBuilderBase

withJson

Methods inherited from class co.elastic.clients.util.ObjectBuilderBase

_checkSingleUse, _listAdd, _listAddAll, _mapPut, _mapPutAll

Methods inherited from class java.lang.Object

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

Methods inherited from interface co.elastic.clients.json.WithJson

withJson, withJson

Constructor Details

Builder

public Builder()

Method Details

bytes

public final SegmentsRequest.Builder bytes(@Nullable
 Bytes value)

The unit used to display byte values.

API name: bytes

index

public final SegmentsRequest.Builder index(List<String> list)

A comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (*). To target all data streams and indices, omit this parameter or use * or _all.

API name: index

Adds all elements of list to index.

index

public final SegmentsRequest.Builder index(String value,
 String... values)

A comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (*). To target all data streams and indices, omit this parameter or use * or _all.

API name: index

Adds one or more values to index.

local

public final SegmentsRequest.Builder local(@Nullable
 Boolean value)

If true, the request computes the list of selected nodes from the local cluster state. If false the list of selected nodes are computed from the cluster state of the master node. In both cases the coordinating node will send requests for further information to each selected node.

API name: local

masterTimeout

public final SegmentsRequest.Builder masterTimeout(@Nullable
 Time value)

Period to wait for a connection to the master node.

API name: master_timeout

masterTimeout

public final SegmentsRequest.Builder masterTimeout(Function<Time.Builder,ObjectBuilder<Time>> fn)

Period to wait for a connection to the master node.

API name: master_timeout

self

protected SegmentsRequest.Builder self()

Specified by:

self in class CatRequestBase.AbstractBuilder<SegmentsRequest.Builder>

build

public SegmentsRequest build()

Builds a SegmentsRequest.

Specified by:

build in interface ObjectBuilder<SegmentsRequest>

Throws:

NullPointerException - if some of the required fields are null.