Class GetFieldMappingRequest
java.lang.Object
co.elastic.clients.elasticsearch._types.RequestBase
co.elastic.clients.elasticsearch.indices.GetFieldMappingRequest
Retrieves mapping definitions for one or more fields. For data streams, the
API retrieves field mappings for the stream’s backing indices.
- 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
Iffalse
, the request returns an error if any wildcard expression, index alias, or_all
value targets only missing or closed indices.final List<ExpandWildcard>
Type of index that wildcard patterns can match.fields()
Required - Comma-separated list or wildcard expression of fields used to limit returned information.final Boolean
Iffalse
, the request returns an error if it targets a missing or closed index.final Boolean
Iftrue
, return all default settings in the response.index()
Comma-separated list of data streams, indices, and aliases used to limit the request.final Boolean
local()
Iftrue
, the request retrieves information from the local node only.static GetFieldMappingRequest
Methods 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
Iffalse
, the request returns an error if any wildcard expression, index alias, or_all
value targets only missing or closed indices. This behavior applies even if the request targets other open indices.API name:
allow_no_indices
-
expandWildcards
Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such asopen,hidden
. Valid values are:all
,open
,closed
,hidden
,none
.API name:
expand_wildcards
-
fields
Required - Comma-separated list or wildcard expression of fields used to limit returned information.API name:
fields
-
includeDefaults
Iftrue
, return all default settings in the response.API name:
include_defaults
-
index
Comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (*
). To target all data streams and indices, omit this parameter or use*
or_all
.API name:
index
-
local
Iftrue
, the request retrieves information from the local node only.API name:
local
-