Class ExistsRequest.Builder
java.lang.Object
co.elastic.clients.util.ObjectBuilderBase
co.elastic.clients.util.WithJsonObjectBuilderBase<BuilderT>
co.elastic.clients.elasticsearch._types.RequestBase.AbstractBuilder<ExistsRequest.Builder>
co.elastic.clients.elasticsearch.indices.ExistsRequest.Builder
- All Implemented Interfaces:
WithJson<ExistsRequest.Builder>
,ObjectBuilder<ExistsRequest>
- Enclosing class:
- ExistsRequest
public static class ExistsRequest.Builder
extends RequestBase.AbstractBuilder<ExistsRequest.Builder>
implements ObjectBuilder<ExistsRequest>
Builder for
ExistsRequest
.-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal ExistsRequest.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 aExistsRequest
.final ExistsRequest.Builder
expandWildcards
(ExpandWildcard value, ExpandWildcard... values) Type of index that wildcard patterns can match.final ExistsRequest.Builder
expandWildcards
(List<ExpandWildcard> list) Type of index that wildcard patterns can match.final ExistsRequest.Builder
flatSettings
(Boolean value) Iftrue
, returns settings in flat format.final ExistsRequest.Builder
ignoreUnavailable
(Boolean value) Iffalse
, the request returns an error if it targets a missing or closed index.final ExistsRequest.Builder
includeDefaults
(Boolean value) Iftrue
, return all default settings in the response.final ExistsRequest.Builder
Required - Comma-separated list of data streams, indices, and aliases.final ExistsRequest.Builder
Required - Comma-separated list of data streams, indices, and aliases.final ExistsRequest.Builder
Iftrue
, the request retrieves information from the local node only.protected ExistsRequest.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
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
. -
flatSettings
Iftrue
, returns settings in flat format.API name:
flat_settings
-
includeDefaults
Iftrue
, return all default settings in the response.API name:
include_defaults
-
index
Required - Comma-separated list of data streams, indices, and aliases. Supports wildcards (*
).API name:
index
Adds all elements of
list
toindex
. -
index
Required - Comma-separated list of data streams, indices, and aliases. Supports wildcards (*
).API name:
index
Adds one or more values to
index
. -
local
Iftrue
, the request retrieves information from the local node only.API name:
local
-
self
- Specified by:
self
in classRequestBase.AbstractBuilder<ExistsRequest.Builder>
-
build
Builds aExistsRequest
.- Specified by:
build
in interfaceObjectBuilder<ExistsRequest>
- Throws:
NullPointerException
- if some of the required fields are null.
-