Class ExistsAliasRequest.Builder
java.lang.Object
co.elastic.clients.util.ObjectBuilderBase
co.elastic.clients.util.WithJsonObjectBuilderBase<BuilderT>
co.elastic.clients.elasticsearch._types.RequestBase.AbstractBuilder<ExistsAliasRequest.Builder>
co.elastic.clients.elasticsearch.indices.ExistsAliasRequest.Builder
- All Implemented Interfaces:
WithJson<ExistsAliasRequest.Builder>
,ObjectBuilder<ExistsAliasRequest>
- Enclosing class:
- ExistsAliasRequest
public static class ExistsAliasRequest.Builder
extends RequestBase.AbstractBuilder<ExistsAliasRequest.Builder>
implements ObjectBuilder<ExistsAliasRequest>
Builder for
ExistsAliasRequest
.-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionallowNoIndices
(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 aExistsAliasRequest
.expandWildcards
(ExpandWildcard value, ExpandWildcard... values) Type of index that wildcard patterns can match.expandWildcards
(List<ExpandWildcard> list) Type of index that wildcard patterns can match.ignoreUnavailable
(Boolean value) Iffalse
, requests that include a missing data stream or index in the target indices or data streams return an error.Comma-separated list of data streams or indices used to limit the request.Comma-separated list of data streams or indices used to limit the request.Iftrue
, the request retrieves information from the local node only.Required - Comma-separated list of aliases to check.Required - Comma-separated list of aliases to check.protected ExistsAliasRequest.Builder
self()
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 ExistsAliasRequest.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 or indices 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 or indices 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
. -
local
Iftrue
, the request retrieves information from the local node only.API name:
local
-
name
Required - Comma-separated list of aliases to check. Supports wildcards (*
).API name:
name
Adds all elements of
list
toname
. -
name
Required - Comma-separated list of aliases to check. Supports wildcards (*
).API name:
name
Adds one or more values to
name
. -
self
- Specified by:
self
in classRequestBase.AbstractBuilder<ExistsAliasRequest.Builder>
-
build
Builds aExistsAliasRequest
.- Specified by:
build
in interfaceObjectBuilder<ExistsAliasRequest>
- Throws:
NullPointerException
- if some of the required fields are null.
-