Class GetFieldMappingRequest
java.lang.Object
co.elastic.clients.elasticsearch._types.RequestBase
co.elastic.clients.elasticsearch.indices.GetFieldMappingRequest
public class GetFieldMappingRequest extends RequestBase
Returns mapping for one or more fields.
- See Also:
- API specification
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
GetFieldMappingRequest.Builder
Builder forGetFieldMappingRequest
.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<GetFieldMappingRequest,GetFieldMappingResponse,ErrorResponse>
_ENDPOINT
Endpoint "indices.get_field_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.util.List<java.lang.String>
fields()
Required - A comma-separated list of fieldsjava.lang.Boolean
ignoreUnavailable()
Whether specified concrete indices should be ignored when unavailable (missing or closed)java.lang.Boolean
includeDefaults()
Whether the default mapping values should be returned as welljava.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)static GetFieldMappingRequest
of(java.util.function.Function<GetFieldMappingRequest.Builder,ObjectBuilder<GetFieldMappingRequest>> fn)
Methods inherited from class co.elastic.clients.elasticsearch._types.RequestBase
toString
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
-
Field Details
-
_ENDPOINT
public static final Endpoint<GetFieldMappingRequest,GetFieldMappingResponse,ErrorResponse> _ENDPOINTEndpoint "indices.get_field_mapping
".
-
-
Method Details
-
of
public static GetFieldMappingRequest of(java.util.function.Function<GetFieldMappingRequest.Builder,ObjectBuilder<GetFieldMappingRequest>> 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
-
fields
public final java.util.List<java.lang.String> fields()Required - A comma-separated list of fieldsAPI name:
fields
-
includeDefaults
@Nullable public final java.lang.Boolean includeDefaults()Whether the default mapping values should be returned as wellAPI name:
include_defaults
-
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
-