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

Provides low-level information about segments in a Lucene index.

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()	Whether to ignore if a wildcard indices expression resolves into no concrete indices.
final List<ExpandWildcard>	expandWildcards()	Whether to expand wildcard expression to concrete indices that are open, closed or both.
final Boolean	ignoreUnavailable()	Whether specified concrete indices should be ignored when unavailable (missing or closed)
final List<String>	index()	A comma-separated list of index names; use _all or empty string to perform the operation on all indices
static SegmentsRequest	of(Function<SegmentsRequest.Builder,ObjectBuilder<SegmentsRequest>> fn)
final Boolean	verbose()	Includes detailed memory usage by Lucene.

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()

Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes _all string or when no indices have been specified)

API name: allow_no_indices

expandWildcards

public final List<ExpandWildcard> expandWildcards()

Whether to expand wildcard expression to concrete indices that are open, closed or both.

API name: expand_wildcards

ignoreUnavailable

@Nullable
public final Boolean ignoreUnavailable()

Whether specified concrete indices should be ignored when unavailable (missing or closed)

API name: ignore_unavailable

index

public final List<String> index()

A comma-separated list of index names; use _all or empty string to perform the operation on all indices

API name: index

verbose

@Nullable
public final Boolean verbose()

Includes detailed memory usage by Lucene.

API name: verbose