Class GetMappingRequest.Builder
java.lang.Object
co.elastic.clients.elasticsearch.indices.GetMappingRequest.Builder
- All Implemented Interfaces:
ObjectBuilder<GetMappingRequest>
- Enclosing class:
- GetMappingRequest
public static class GetMappingRequest.Builder extends java.lang.Object implements ObjectBuilder<GetMappingRequest>
Builder for
GetMappingRequest
.-
Constructor Summary
Constructors Constructor Description Builder()
-
Method Summary
Modifier and Type Method Description GetMappingRequest.Builder
addExpandWildcards(ExpandWildcardOptions value)
Add a value toexpandWildcards(List)
, creating the list if needed.GetMappingRequest.Builder
addIndex(java.lang.String value)
Add a value toindex(List)
, creating the list if needed.GetMappingRequest.Builder
addType(java.lang.String value)
Add a value totype(List)
, creating the list if needed.GetMappingRequest.Builder
allowNoIndices(java.lang.Boolean value)
Whether to ignore if a wildcard indices expression resolves into no concrete indices.GetMappingRequest
build()
Builds aGetMappingRequest
.GetMappingRequest.Builder
expandWildcards(ExpandWildcardOptions... value)
Whether to expand wildcard expression to concrete indices that are open, closed or both.GetMappingRequest.Builder
expandWildcards(java.util.List<ExpandWildcardOptions> value)
Whether to expand wildcard expression to concrete indices that are open, closed or both.GetMappingRequest.Builder
ignoreUnavailable(java.lang.Boolean value)
Whether specified concrete indices should be ignored when unavailable (missing or closed)GetMappingRequest.Builder
includeTypeName(java.lang.Boolean value)
Whether to add the type name to the response (default: false)GetMappingRequest.Builder
index(java.lang.String... value)
A comma-separated list of index namesGetMappingRequest.Builder
index(java.util.List<java.lang.String> value)
A comma-separated list of index namesGetMappingRequest.Builder
local(java.lang.Boolean value)
Return local information, do not retrieve the state from master node (default: false)GetMappingRequest.Builder
masterTimeout(java.lang.String value)
Specify timeout for connection to masterGetMappingRequest.Builder
type(java.lang.String... value)
A comma-separated list of document typesGetMappingRequest.Builder
type(java.util.List<java.lang.String> value)
A comma-separated list of document typesMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
index
A comma-separated list of index namesAPI name:
index
-
index
A comma-separated list of index namesAPI name:
index
-
addIndex
Add a value toindex(List)
, creating the list if needed. -
type
A comma-separated list of document typesAPI name:
type
-
type
A comma-separated list of document typesAPI name:
type
-
addType
Add a value totype(List)
, creating the list if needed. -
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
public GetMappingRequest.Builder expandWildcards(@Nullable java.util.List<ExpandWildcardOptions> value)Whether to expand wildcard expression to concrete indices that are open, closed or both.API name:
expand_wildcards
-
expandWildcards
Whether to expand wildcard expression to concrete indices that are open, closed or both.API name:
expand_wildcards
-
addExpandWildcards
Add a value toexpandWildcards(List)
, creating the list if needed. -
includeTypeName
Whether to add the type name to the response (default: false)API name:
include_type_name
-
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
-
build
Builds aGetMappingRequest
.- Specified by:
build
in interfaceObjectBuilder<GetMappingRequest>
- Throws:
java.lang.NullPointerException
- if some of the required fields are null.
-