Class SegmentsRequest
java.lang.Object
co.elastic.clients.elasticsearch._types.RequestBase
co.elastic.clients.elasticsearch.cat.CatRequestBase
co.elastic.clients.elasticsearch.cat.SegmentsRequest
Returns 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:
-
Nested Class Summary
Nested classes/interfaces inherited from class co.elastic.clients.elasticsearch.cat.CatRequestBase
CatRequestBase.AbstractBuilder<BuilderT extends CatRequestBase.AbstractBuilder<BuilderT>>
-
Field Summary
Modifier and TypeFieldDescriptionstatic final Endpoint<SegmentsRequest,
SegmentsResponse, ErrorResponse> Endpoint "cat.segments
". -
Method Summary
Modifier and TypeMethodDescriptionfinal Bytes
bytes()
The unit used to display byte values.index()
A comma-separated list of data streams, indices, and aliases used to limit the request.static SegmentsRequest
Methods inherited from class co.elastic.clients.elasticsearch._types.RequestBase
toString
-
Field Details
-
_ENDPOINT
Endpoint "cat.segments
".
-
-
Method Details
-
of
public static SegmentsRequest of(Function<SegmentsRequest.Builder, ObjectBuilder<SegmentsRequest>> fn) -
bytes
The unit used to display byte values.API name:
bytes
-
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
-