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) Whether to ignore if a wildcard indices expression resolves into no concrete indices.build()
Builds aGetFieldMappingRequest
.expandWildcards
(ExpandWildcard value, ExpandWildcard... values) Whether to expand wildcard expression to concrete indices that are open, closed or both.expandWildcards
(List<ExpandWildcard> list) Whether to expand wildcard expression to concrete indices that are open, closed or both.Required - A comma-separated list of fieldsRequired - A comma-separated list of fieldsignoreUnavailable
(Boolean value) Whether specified concrete indices should be ignored when unavailable (missing or closed)includeDefaults
(Boolean value) Whether the default mapping values should be returned as wellA comma-separated list of index namesA comma-separated list of index namesReturn local information, do not retrieve the state from master node (default: false)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
Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes_all
string or when no indices have been specified)API name:
allow_no_indices
-
expandWildcards
Whether to expand wildcard expression to concrete indices that are open, closed or both.API name:
expand_wildcards
Adds all elements of
list
toexpandWildcards
. -
expandWildcards
public final GetFieldMappingRequest.Builder expandWildcards(ExpandWildcard value, ExpandWildcard... values) Whether to expand wildcard expression to concrete indices that are open, closed or both.API name:
expand_wildcards
Adds one or more values to
expandWildcards
. -
fields
Required - A comma-separated list of fieldsAPI name:
fields
Adds all elements of
list
tofields
. -
fields
Required - A comma-separated list of fieldsAPI name:
fields
Adds one or more values to
fields
. -
includeDefaults
Whether the default mapping values should be returned as wellAPI name:
include_defaults
-
index
A comma-separated list of index namesAPI name:
index
Adds all elements of
list
toindex
. -
index
A comma-separated list of index namesAPI name:
index
Adds one or more values to
index
. -
local
Return local information, do not retrieve the state from master node (default: false)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.
-