Class IndicesRequest.Builder
java.lang.Object
co.elastic.clients.util.ObjectBuilderBase
co.elastic.clients.util.WithJsonObjectBuilderBase<BuilderT>
co.elastic.clients.elasticsearch._types.RequestBase.AbstractBuilder<BuilderT>
co.elastic.clients.elasticsearch.cat.CatRequestBase.AbstractBuilder<IndicesRequest.Builder>
co.elastic.clients.elasticsearch.cat.IndicesRequest.Builder
- All Implemented Interfaces:
WithJson<IndicesRequest.Builder>
,ObjectBuilder<IndicesRequest>
- Enclosing class:
- IndicesRequest
public static class IndicesRequest.Builder
extends CatRequestBase.AbstractBuilder<IndicesRequest.Builder>
implements ObjectBuilder<IndicesRequest>
Builder for
IndicesRequest
.-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuild()
Builds aIndicesRequest
.final IndicesRequest.Builder
The unit in which to display byte valuesfinal IndicesRequest.Builder
expandWildcards
(ExpandWildcard value, ExpandWildcard... values) Whether to expand wildcard expression to concrete indices that are open, closed or both.final IndicesRequest.Builder
expandWildcards
(List<ExpandWildcard> list) Whether to expand wildcard expression to concrete indices that are open, closed or both.final IndicesRequest.Builder
health
(HealthStatus value) A health status ("green", "yellow", or "red" to filter only indices matching the specified health statusfinal IndicesRequest.Builder
includeUnloadedSegments
(Boolean value) If set to true segment stats will include stats for segments that are not currently loaded into memoryfinal IndicesRequest.Builder
A comma-separated list of index names to limit the returned informationfinal IndicesRequest.Builder
A comma-separated list of index names to limit the returned informationfinal IndicesRequest.Builder
Set to true to return stats only for primary shardsprotected IndicesRequest.Builder
self()
final IndicesRequest.Builder
The unit in which to display time valuesMethods inherited from class co.elastic.clients.util.WithJsonObjectBuilderBase
withJson
Methods inherited from class co.elastic.clients.util.ObjectBuilderBase
_checkSingleUse, _listAdd, _listAddAll, _mapPut, _mapPutAll
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
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
Adds all elements of
list
toexpandWildcards
. -
expandWildcards
Whether to expand wildcard expression to concrete indices that are open, closed or both.API name:
expand_wildcards
Adds one or more values to
expandWildcards
. -
health
A health status ("green", "yellow", or "red" to filter only indices matching the specified health statusAPI name:
health
-
includeUnloadedSegments
If set to true segment stats will include stats for segments that are not currently loaded into memoryAPI name:
include_unloaded_segments
-
index
A comma-separated list of index names to limit the returned informationAPI name:
index
Adds all elements of
list
toindex
. -
index
A comma-separated list of index names to limit the returned informationAPI name:
index
Adds one or more values to
index
. -
pri
Set to true to return stats only for primary shardsAPI name:
pri
-
time
The unit in which to display time valuesAPI name:
time
-
self
- Specified by:
self
in classCatRequestBase.AbstractBuilder<IndicesRequest.Builder>
-
build
Builds aIndicesRequest
.- Specified by:
build
in interfaceObjectBuilder<IndicesRequest>
- Throws:
NullPointerException
- if some of the required fields are null.
-