Class SegmentsRequest.Builder
java.lang.Object
co.elastic.clients.util.ObjectBuilderBase
co.elastic.clients.util.WithJsonObjectBuilderBase<BuilderT>
co.elastic.clients.elasticsearch._types.RequestBase.AbstractBuilder<SegmentsRequest.Builder>
co.elastic.clients.elasticsearch.indices.SegmentsRequest.Builder
- All Implemented Interfaces:
WithJson<SegmentsRequest.Builder>
,ObjectBuilder<SegmentsRequest>
- Enclosing class:
- SegmentsRequest
public static class SegmentsRequest.Builder
extends RequestBase.AbstractBuilder<SegmentsRequest.Builder>
implements ObjectBuilder<SegmentsRequest>
Builder for
SegmentsRequest
.-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal SegmentsRequest.Builder
allowNoIndices
(Boolean value) Iffalse
, the request returns an error if any wildcard expression, index alias, or_all
value targets only missing or closed indices.build()
Builds aSegmentsRequest
.final SegmentsRequest.Builder
expandWildcards
(ExpandWildcard value, ExpandWildcard... values) Type of index that wildcard patterns can match.final SegmentsRequest.Builder
expandWildcards
(List<ExpandWildcard> list) Type of index that wildcard patterns can match.final SegmentsRequest.Builder
ignoreUnavailable
(Boolean value) Iffalse
, the request returns an error if it targets a missing or closed index.final SegmentsRequest.Builder
Comma-separated list of data streams, indices, and aliases used to limit the request.final SegmentsRequest.Builder
Comma-separated list of data streams, indices, and aliases used to limit the request.protected SegmentsRequest.Builder
self()
final SegmentsRequest.Builder
Iftrue
, the request returns a verbose response.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
-
allowNoIndices
Iffalse
, the request returns an error if any wildcard expression, index alias, or_all
value targets only missing or closed indices. This behavior applies even if the request targets other open indices.API name:
allow_no_indices
-
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 asopen,hidden
. Valid values are:all
,open
,closed
,hidden
,none
.API name:
expand_wildcards
Adds all elements of
list
toexpandWildcards
. -
expandWildcards
public final SegmentsRequest.Builder expandWildcards(ExpandWildcard value, ExpandWildcard... values) 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 asopen,hidden
. Valid values are:all
,open
,closed
,hidden
,none
.API name:
expand_wildcards
Adds one or more values to
expandWildcards
. -
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
. -
verbose
Iftrue
, the request returns a verbose response.API name:
verbose
-
self
- Specified by:
self
in classRequestBase.AbstractBuilder<SegmentsRequest.Builder>
-
build
Builds aSegmentsRequest
.- Specified by:
build
in interfaceObjectBuilder<SegmentsRequest>
- Throws:
NullPointerException
- if some of the required fields are null.
-