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

All Implemented Interfaces:

ToCopyableBuilder<SegmentsRequest.Builder,SegmentsRequest>

@Generated("org.opensearch.client.codegen.CodeGenerator")
public final class SegmentsRequest
extends CatRequestBase
implements ToCopyableBuilder<SegmentsRequest.Builder,SegmentsRequest>

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.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
protected void	applyQueryParameters(Map<String,String> params)
static SegmentsRequest.Builder	builder()
final Bytes	bytes()	The units used to display byte values.
final Time	clusterManagerTimeout()	The amount of time allowed to establish a connection to the cluster manager node.
boolean	equals(Object o)
int	hashCode()
final List<String>	index()	A comma-separated list of data streams, indexes, and aliases used to limit the request.
final Time	masterTimeout()	Deprecated.
static SegmentsRequest	of(Function<SegmentsRequest.Builder,ObjectBuilder<SegmentsRequest>> fn)
SegmentsRequest.Builder	toBuilder()	Create a new builder ToCopyableBuilder that is initialised with the current state of this object.

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

headers, sort

Methods inherited from class org.opensearch.client.opensearch._types.RequestBase

errorTrace, human

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opensearch.client.util.ToCopyableBuilder

copy

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 units used to display byte values.

API name: bytes

clusterManagerTimeout

@Nullable
public final Time clusterManagerTimeout()

The amount of time allowed to establish a connection to the cluster manager node.

API name: cluster_manager_timeout

index

@Nonnull
public final List<String> index()

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

API name: index

masterTimeout

@Deprecated
@Nullable
public final Time masterTimeout()

Deprecated.

The amount of time allowed to establish a connection to the cluster manager node.

API name: master_timeout

toBuilder

@Nonnull
public SegmentsRequest.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Create a new builder ToCopyableBuilder that is initialised with the current state of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<SegmentsRequest.Builder,SegmentsRequest>

Returns:

a new builder instance.

builder

@Nonnull
public static SegmentsRequest.Builder builder()

applyQueryParameters

protected void applyQueryParameters(@Nonnull
 Map<String,String> params)

Overrides:

applyQueryParameters in class CatRequestBase

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object