Class GetMappingRequest.Builder
java.lang.Object
co.elastic.clients.util.ObjectBuilderBase
co.elastic.clients.util.WithJsonObjectBuilderBase<BuilderT>
co.elastic.clients.elasticsearch._types.RequestBase.AbstractBuilder<GetMappingRequest.Builder>
co.elastic.clients.elasticsearch.indices.GetMappingRequest.Builder
- All Implemented Interfaces:
WithJson<GetMappingRequest.Builder>
,ObjectBuilder<GetMappingRequest>
- Enclosing class:
- GetMappingRequest
public static class GetMappingRequest.Builder
extends RequestBase.AbstractBuilder<GetMappingRequest.Builder>
implements ObjectBuilder<GetMappingRequest>
Builder for
GetMappingRequest
.-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionallowNoIndices
(Boolean value) Whether to ignore if a wildcard indices expression resolves into no concrete indices.build()
Builds aGetMappingRequest
.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.ignoreUnavailable
(Boolean value) Whether specified concrete indices should be ignored when unavailable (missing or closed)includeTypeName
(Boolean value) Whether to add the type name to the response (default: false)A comma-separated list of index namesA comma-separated list of index namesReturn local information, do not retrieve the state from master node (default: false)masterTimeout
(Time value) Specify timeout for connection to masterSpecify timeout for connection to masterprotected GetMappingRequest.Builder
self()
A comma-separated list of document typesA comma-separated list of document typesMethods 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 GetMappingRequest.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
. -
includeTypeName
Whether to add the type name to the response (default: false)API name:
include_type_name
-
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
-
masterTimeout
Specify timeout for connection to masterAPI name:
master_timeout
-
masterTimeout
Specify timeout for connection to masterAPI name:
master_timeout
-
type
A comma-separated list of document typesAPI name:
type
Adds all elements of
list
totype
. -
type
A comma-separated list of document typesAPI name:
type
Adds one or more values to
type
. -
self
- Specified by:
self
in classRequestBase.AbstractBuilder<GetMappingRequest.Builder>
-
build
Builds aGetMappingRequest
.- Specified by:
build
in interfaceObjectBuilder<GetMappingRequest>
- Throws:
NullPointerException
- if some of the required fields are null.
-