Package co.elastic.clients.elasticsearch.indices

Class SegmentsRequest

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.indices.SegmentsRequest

public class SegmentsRequest
extends RequestBase

Get index segments.

Get low-level information about the Lucene segments in index shards. For data streams, the API returns information about the stream's backing indices.

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._types.RequestBase

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

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
final Boolean	allowNoIndices()	A setting that does two separate checks on the index expression.
final List<ExpandWildcard>	expandWildcards()	Type of index that wildcard patterns can match.
final Boolean	ignoreUnavailable()	If false, the request returns an error if it targets a concrete (non-wildcarded) index, alias, or data stream that is missing, closed, or otherwise unavailable.
final List<String>	index()	Comma-separated list of data streams, indices, and aliases used to limit the request.
static SegmentsRequest	of(Function<SegmentsRequest.Builder,ObjectBuilder<SegmentsRequest>> fn)
SegmentsRequest.Builder	rebuild()

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 "indices.segments".

Method Details

of

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

allowNoIndices

@Nullable
public final Boolean allowNoIndices()

A setting that does two separate checks on the index expression. If false, the request returns an error (1) if any wildcard expression (including _all and *) resolves to zero matching indices or (2) if the complete set of resolved indices, aliases or data streams is empty after all expressions are evaluated. If true, index expressions that resolve to no indices are allowed and the request returns an empty result.

API name: allow_no_indices

expandWildcards

public final List<ExpandWildcard> expandWildcards()

Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as open,hidden.

API name: expand_wildcards

ignoreUnavailable

@Nullable
public final Boolean ignoreUnavailable()

If false, the request returns an error if it targets a concrete (non-wildcarded) index, alias, or data stream that is missing, closed, or otherwise unavailable. If true, unavailable concrete targets are silently ignored.

API name: ignore_unavailable

index

public final List<String> index()

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

rebuild

public SegmentsRequest.Builder rebuild()

Returns:

New SegmentsRequest.Builder initialized with field values of this instance