Package co.elastic.clients.elasticsearch.indices

Class GetFieldMappingRequest

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.indices.GetFieldMappingRequest

public class GetFieldMappingRequest
extends RequestBase

Get mapping definitions. Retrieves mapping definitions for one or more fields. For data streams, the API retrieves field mappings for the stream’s backing indices.

This API is useful if you don't need a complete mapping or if an index mapping contains a large number of fields.

See Also:

• API specification

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	GetFieldMappingRequest.Builder	Builder for GetFieldMappingRequest.

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 final Endpoint<GetFieldMappingRequest,GetFieldMappingResponse,ErrorResponse>	_ENDPOINT	Endpoint "indices.get_field_mapping".

Method Summary

Modifier and Type	Method	Description
final Boolean	allowNoIndices()	If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indices.
final List<ExpandWildcard>	expandWildcards()	Type of index that wildcard patterns can match.
final List<String>	fields()	Required - Comma-separated list or wildcard expression of fields used to limit returned information.
final Boolean	ignoreUnavailable()	If false, the request returns an error if it targets a missing or closed index.
final Boolean	includeDefaults()	If true, return all default settings in the response.
final List<String>	index()	Comma-separated list of data streams, indices, and aliases used to limit the request.
final Boolean	local()	If true, the request retrieves information from the local node only.
static GetFieldMappingRequest	of(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> _ENDPOINT

Endpoint "indices.get_field_mapping".

Method Details

of

public static GetFieldMappingRequest of(Function<GetFieldMappingRequest.Builder,ObjectBuilder<GetFieldMappingRequest>> fn)

allowNoIndices

@Nullable
public final Boolean allowNoIndices()

If false, 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

public final List<ExpandWildcard> 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 as open,hidden.

API name: expand_wildcards

fields

public final List<String> fields()

Required - Comma-separated list or wildcard expression of fields used to limit returned information. Supports wildcards (*).

API name: fields

ignoreUnavailable

@Nullable
public final Boolean ignoreUnavailable()

If false, the request returns an error if it targets a missing or closed index.

API name: ignore_unavailable

includeDefaults

@Nullable
public final Boolean includeDefaults()

If true, return all default settings in the response.

API name: include_defaults

index

public final List<String> 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

@Nullable
public final Boolean local()

If true, the request retrieves information from the local node only.

API name: local