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 used to display byte values.final IndicesRequest.Builder
expandWildcards
(ExpandWildcard value, ExpandWildcard... values) The type of index that wildcard patterns can match.final IndicesRequest.Builder
expandWildcards
(List<ExpandWildcard> list) The type of index that wildcard patterns can match.final IndicesRequest.Builder
health
(HealthStatus value) The health status used to limit returned indices.final IndicesRequest.Builder
includeUnloadedSegments
(Boolean value) If true, the response includes information from segments that are not loaded into memory.final IndicesRequest.Builder
Comma-separated list of data streams, indices, and aliases used to limit the request.final IndicesRequest.Builder
Comma-separated list of data streams, indices, and aliases used to limit the request.final IndicesRequest.Builder
If true, the response only includes information from primary shards.protected IndicesRequest.Builder
self()
final IndicesRequest.Builder
The unit used to display time values.Methods 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 used to display byte values.API name:
bytes
-
expandWildcards
The type of index that wildcard patterns can match.API name:
expand_wildcards
Adds all elements of
list
toexpandWildcards
. -
expandWildcards
The type of index that wildcard patterns can match.API name:
expand_wildcards
Adds one or more values to
expandWildcards
. -
health
The health status used to limit returned indices. By default, the response includes indices of any health status.API name:
health
-
includeUnloadedSegments
If true, the response includes information from segments that are not loaded into memory.API name:
include_unloaded_segments
-
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
Adds all elements of
list
toindex
. -
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
Adds one or more values to
index
. -
pri
If true, the response only includes information from primary shards.API name:
pri
-
time
The unit used to display time values.API 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.
-