Package org.opensearch.client.opensearch.cat

Class SegmentsRequest

java.lang.Object

org.opensearch.client.opensearch._types.RequestBase

org.opensearch.client.opensearch.cat.CatRequestBase

org.opensearch.client.opensearch.cat.SegmentsRequest

public class SegmentsRequest
extends CatRequestBase

Provides low-level information about the segments in the shards of an index.

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from class org.opensearch.client.opensearch.cat.CatRequestBase

CatRequestBase.CatRequestBaseBuilder<BuilderT extends CatRequestBase.CatRequestBaseBuilder>

Nested classes/interfaces inherited from class org.opensearch.client.opensearch._types.RequestBase

RequestBase.AbstractBuilder<BuilderT extends RequestBase.AbstractBuilder<BuilderT>>

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
Bytes	bytes()	The unit in which to display byte values
java.util.List<java.lang.String>	index()	A comma-separated list of index names to limit the returned information
static SegmentsRequest	of(java.util.function.Function<SegmentsRequest.Builder,ObjectBuilder<SegmentsRequest>> fn)

Methods inherited from class org.opensearch.client.opensearch.cat.CatRequestBase

headers, queryParameters, sort

Methods inherited from class java.lang.Object

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

Field Detail

_ENDPOINT

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

Endpoint "cat.segments".

Method Detail

of

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

bytes

@Nullable
public final Bytes bytes()

The unit in which to display byte values

API name: bytes

index

public final java.util.List<java.lang.String> index()

A comma-separated list of index names to limit the returned information

API name: index