Class GetFieldMappingRequest
java.lang.Object
co.elastic.clients.elasticsearch._types.RequestBase
co.elastic.clients.elasticsearch.indices.GetFieldMappingRequest
Returns mapping for one or more fields.
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from class co.elastic.clients.elasticsearch._types.RequestBase
RequestBase.AbstractBuilder<BuilderT extends RequestBase.AbstractBuilder<BuilderT>>
-
Field Summary
Modifier and TypeFieldDescriptionstatic final Endpoint<GetFieldMappingRequest,
GetFieldMappingResponse, ErrorResponse> Endpoint "indices.get_field_mapping
". -
Method Summary
Modifier and TypeMethodDescriptionfinal Boolean
Whether to ignore if a wildcard indices expression resolves into no concrete indices.final List<ExpandWildcard>
Whether to expand wildcard expression to concrete indices that are open, closed or both.fields()
Required - A comma-separated list of fieldsfinal Boolean
Whether specified concrete indices should be ignored when unavailable (missing or closed)final Boolean
Whether the default mapping values should be returned as wellfinal Boolean
Whether a type should be returned in the body of the mappings.index()
A comma-separated list of index namesfinal Boolean
local()
Return local information, do not retrieve the state from master node (default: false)static GetFieldMappingRequest
type()
A comma-separated list of document typesMethods inherited from class co.elastic.clients.elasticsearch._types.RequestBase
toString
-
Field Details
-
_ENDPOINT
public static final Endpoint<GetFieldMappingRequest,GetFieldMappingResponse, _ENDPOINTErrorResponse> Endpoint "indices.get_field_mapping
".
-
-
Method Details
-
of
public static GetFieldMappingRequest of(Function<GetFieldMappingRequest.Builder, ObjectBuilder<GetFieldMappingRequest>> fn) -
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
-
fields
Required - A comma-separated list of fieldsAPI name:
fields
-
includeDefaults
Whether the default mapping values should be returned as wellAPI name:
include_defaults
-
includeTypeName
Whether a type should be returned in the body of the mappings.API name:
include_type_name
-
index
A comma-separated list of index namesAPI name:
index
-
local
Return local information, do not retrieve the state from master node (default: false)API name:
local
-
type
A comma-separated list of document typesAPI name:
type
-