Class IndicesRequest
java.lang.Object
co.elastic.clients.elasticsearch._types.RequestBase
co.elastic.clients.elasticsearch.cat.CatRequestBase
co.elastic.clients.elasticsearch.cat.IndicesRequest
- All Implemented Interfaces:
ElasticsearchCatRequest
,ElasticsearchCommonRequest
public final class IndicesRequest extends CatRequestBase
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
IndicesRequest.Builder
Builder forIndicesRequest
.Nested classes/interfaces inherited from class co.elastic.clients.elasticsearch.cat.CatRequestBase
CatRequestBase.AbstractBuilder<BuilderT extends CatRequestBase.AbstractBuilder<BuilderT>>
-
Field Summary
Fields Modifier and Type Field Description static Endpoint<IndicesRequest,IndicesResponse,ElasticsearchError>
ENDPOINT
Endpoint "cat.indices
". -
Constructor Summary
Constructors Constructor Description IndicesRequest(IndicesRequest.Builder builder)
IndicesRequest(java.util.function.Function<IndicesRequest.Builder,IndicesRequest.Builder> fn)
-
Method Summary
Modifier and Type Method Description Bytes
bytes()
The unit in which to display byte valuesjava.util.List<ExpandWildcardOptions>
expandWildcards()
Whether to expand wildcard expression to concrete indices that are open, closed or both.Health
health()
A health status ("green", "yellow", or "red" to filter only indices matching the specified health statusjava.lang.Boolean
includeUnloadedSegments()
If set to true segment stats will include stats for segments that are not currently loaded into memoryjava.util.List<java.lang.String>
index()
A comma-separated list of index names to limit the returned informationjava.lang.Boolean
pri()
Set to true to return stats only for primary shardsMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Field Details
-
ENDPOINT
Endpoint "cat.indices
".
-
-
Constructor Details
-
IndicesRequest
-
IndicesRequest
public IndicesRequest(java.util.function.Function<IndicesRequest.Builder,IndicesRequest.Builder> fn)
-
-
Method Details
-
index
@Nullable public java.util.List<java.lang.String> index()A comma-separated list of index names to limit the returned informationAPI name:
index
-
bytes
The unit in which to display byte valuesAPI name:
bytes
-
expandWildcards
Whether to expand wildcard expression to concrete indices that are open, closed or both.API name:
expand_wildcards
-
health
A health status ("green", "yellow", or "red" to filter only indices matching the specified health statusAPI name:
health
-
includeUnloadedSegments
@Nullable public java.lang.Boolean includeUnloadedSegments()If set to true segment stats will include stats for segments that are not currently loaded into memoryAPI name:
include_unloaded_segments
-
pri
@Nullable public java.lang.Boolean pri()Set to true to return stats only for primary shardsAPI name:
pri
-