Class GetFieldMappingRequest.Builder
java.lang.Object
co.elastic.clients.util.ObjectBuilderBase
co.elastic.clients.util.WithJsonObjectBuilderBase<BuilderT>
co.elastic.clients.elasticsearch._types.RequestBase.AbstractBuilder<GetFieldMappingRequest.Builder>
co.elastic.clients.elasticsearch.indices.GetFieldMappingRequest.Builder
- All Implemented Interfaces:
WithJson<GetFieldMappingRequest.Builder>
,ObjectBuilder<GetFieldMappingRequest>
- Enclosing class:
- GetFieldMappingRequest
public static class GetFieldMappingRequest.Builder
extends RequestBase.AbstractBuilder<GetFieldMappingRequest.Builder>
implements ObjectBuilder<GetFieldMappingRequest>
Builder for
GetFieldMappingRequest
.-
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 aGetFieldMappingRequest
.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.Required - Comma-separated list or wildcard expression of fields used to limit returned information.Required - Comma-separated list or wildcard expression of fields used to limit returned information.ignoreUnavailable
(Boolean value) Iffalse
, the request returns an error if it targets a missing or closed index.includeDefaults
(Boolean value) Iftrue
, return all default settings in the response.Comma-separated list of data streams, indices, and aliases used to limit the request.Comma-separated list of data streams, indices, and aliases used to limit the request.Iftrue
, the request retrieves information from the local node only.protected GetFieldMappingRequest.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 GetFieldMappingRequest.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
. -
fields
Required - Comma-separated list or wildcard expression of fields used to limit returned information.API name:
fields
Adds all elements of
list
tofields
. -
fields
Required - Comma-separated list or wildcard expression of fields used to limit returned information.API name:
fields
Adds one or more values to
fields
. -
includeDefaults
Iftrue
, return all default settings in the response.API name:
include_defaults
-
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
. -
local
Iftrue
, the request retrieves information from the local node only.API name:
local
-
self
- Specified by:
self
in classRequestBase.AbstractBuilder<GetFieldMappingRequest.Builder>
-
build
Builds aGetFieldMappingRequest
.- Specified by:
build
in interfaceObjectBuilder<GetFieldMappingRequest>
- Throws:
NullPointerException
- if some of the required fields are null.
-