Class GetMappingRequest
java.lang.Object
co.elastic.clients.elasticsearch._types.RequestBase
co.elastic.clients.elasticsearch.indices.GetMappingRequest
public class GetMappingRequest extends RequestBase
Returns mappings for one or more indices.
- See Also:
- API specification
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
GetMappingRequest.Builder
Builder forGetMappingRequest
.Nested classes/interfaces inherited from class co.elastic.clients.elasticsearch._types.RequestBase
RequestBase.AbstractBuilder<BuilderT extends RequestBase.AbstractBuilder<BuilderT>>
-
Field Summary
Fields Modifier and Type Field Description static Endpoint<GetMappingRequest,GetMappingResponse,ErrorResponse>
_ENDPOINT
Endpoint "indices.get_mapping
". -
Method Summary
Modifier and Type Method Description java.lang.Boolean
allowNoIndices()
Whether to ignore if a wildcard indices expression resolves into no concrete indices.java.util.List<ExpandWildcard>
expandWildcards()
Whether to expand wildcard expression to concrete indices that are open, closed or both.java.lang.Boolean
ignoreUnavailable()
Whether specified concrete indices should be ignored when unavailable (missing or closed)java.lang.Boolean
includeTypeName()
Whether to add the type name to the response (default: false)java.util.List<java.lang.String>
index()
A comma-separated list of index namesjava.lang.Boolean
local()
Return local information, do not retrieve the state from master node (default: false)Time
masterTimeout()
Specify timeout for connection to masterstatic GetMappingRequest
of(java.util.function.Function<GetMappingRequest.Builder,ObjectBuilder<GetMappingRequest>> fn)
java.util.List<java.lang.String>
type()
A comma-separated list of document typesMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Field Details
-
_ENDPOINT
Endpoint "indices.get_mapping
".
-
-
Method Details
-
of
public static GetMappingRequest of(java.util.function.Function<GetMappingRequest.Builder,ObjectBuilder<GetMappingRequest>> fn) -
allowNoIndices
@Nullable public final java.lang.Boolean 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
-
includeTypeName
@Nullable public final java.lang.Boolean includeTypeName()Whether to add the type name to the response (default: false)API name:
include_type_name
-
index
public final java.util.List<java.lang.String> index()A comma-separated list of index namesAPI name:
index
-
local
@Nullable public final java.lang.Boolean 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
-
type
public final java.util.List<java.lang.String> type()A comma-separated list of document typesAPI name:
type
-