Package co.elastic.clients.elasticsearch.cat

Class SegmentsRequest

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.cat.CatRequestBase

co.elastic.clients.elasticsearch.cat.SegmentsRequest

public class SegmentsRequest
extends CatRequestBase

Get segment information.

Get low-level information about the Lucene segments in index shards. For data streams, the API returns information about the backing indices. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the index segments API.

See Also:

• API specification

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SegmentsRequest.Builder	Builder for SegmentsRequest.

Nested classes/interfaces inherited from class co.elastic.clients.elasticsearch.cat.CatRequestBase

CatRequestBase.AbstractBuilder<BuilderT extends CatRequestBase.AbstractBuilder<BuilderT>>

Field Summary

Fields

Modifier and Type	Field	Description
static final Endpoint<SegmentsRequest,SegmentsResponse,ErrorResponse>	_ENDPOINT	Endpoint "cat.segments".

Method Summary

Modifier and Type	Method	Description
final Bytes	bytes()	The unit used to display byte values.
final List<String>	h()	List of columns to appear in the response.
final List<String>	index()	A comma-separated list of data streams, indices, and aliases used to limit the request.
final Boolean	local()	If true, the request computes the list of selected nodes from the local cluster state.
final Time	masterTimeout()	Period to wait for a connection to the master node.
static SegmentsRequest	of(Function<SegmentsRequest.Builder,ObjectBuilder<SegmentsRequest>> fn)
final List<String>	s()	List of columns that determine how the table should be sorted.

Methods inherited from class co.elastic.clients.elasticsearch._types.RequestBase

toString

Methods inherited from class java.lang.Object

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

Field Details

_ENDPOINT

public static final Endpoint<SegmentsRequest,SegmentsResponse,ErrorResponse> _ENDPOINT

Endpoint "cat.segments".

Method Details

of

public static SegmentsRequest of(Function<SegmentsRequest.Builder,ObjectBuilder<SegmentsRequest>> fn)

bytes

@Nullable
public final Bytes bytes()

The unit used to display byte values.

API name: bytes

h

public final List<String> h()

List of columns to appear in the response. Supports simple wildcards.

API name: h

index

public final List<String> index()

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

local

@Nullable
public final Boolean local()

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

@Nullable
public final Time masterTimeout()

Period to wait for a connection to the master node.

API name: master_timeout

s

public final List<String> s()

List of columns that determine how the table should be sorted. Sorting defaults to ascending and can be changed by setting :asc or :desc as a suffix to the column name.

API name: s