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
Constructors Constructor Description Builder()
-
Method Summary
Modifier and Type Method Description GetFieldMappingRequest.Builder
allowNoIndices(java.lang.Boolean value)
Whether to ignore if a wildcard indices expression resolves into no concrete indices.GetFieldMappingRequest
build()
Builds aGetFieldMappingRequest
.GetFieldMappingRequest.Builder
expandWildcards(ExpandWildcard value, ExpandWildcard... values)
Whether to expand wildcard expression to concrete indices that are open, closed or both.GetFieldMappingRequest.Builder
expandWildcards(java.util.List<ExpandWildcard> list)
Whether to expand wildcard expression to concrete indices that are open, closed or both.GetFieldMappingRequest.Builder
fields(java.lang.String value, java.lang.String... values)
Required - A comma-separated list of fieldsGetFieldMappingRequest.Builder
fields(java.util.List<java.lang.String> list)
Required - A comma-separated list of fieldsGetFieldMappingRequest.Builder
ignoreUnavailable(java.lang.Boolean value)
Whether specified concrete indices should be ignored when unavailable (missing or closed)GetFieldMappingRequest.Builder
includeDefaults(java.lang.Boolean value)
Whether the default mapping values should be returned as wellGetFieldMappingRequest.Builder
index(java.lang.String value, java.lang.String... values)
A comma-separated list of index namesGetFieldMappingRequest.Builder
index(java.util.List<java.lang.String> list)
A comma-separated list of index namesGetFieldMappingRequest.Builder
local(java.lang.Boolean value)
Return 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
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
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
public final GetFieldMappingRequest.Builder fields(java.lang.String value, java.lang.String... values)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
public final GetFieldMappingRequest.Builder index(java.lang.String value, java.lang.String... values)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:
java.lang.NullPointerException
- if some of the required fields are null.
-