Package co.elastic.clients.elasticsearch.indices

Class GetMappingRequest

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.indices.GetMappingRequest

public class GetMappingRequest
extends RequestBase

Get mapping definitions. For data streams, the API retrieves mappings for the stream’s backing indices.

See Also:

• API specification

Nested Class Summary

Nested Classes

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

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<GetMappingRequest,GetMappingResponse,ErrorResponse>	_ENDPOINT	Endpoint "indices.get_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 Boolean	ignoreUnavailable()	If false, the request returns an error if it targets a missing or closed index.
final List<String>	index()	Comma-separated list of data streams, indices, and aliases used to limit the request.
final Boolean	local()	Deprecated. 7.8.0 This parameter is a no-op and field mappings are always retrieved locally.
final Time	masterTimeout()	Period to wait for a connection to the master node.
static GetMappingRequest	of(Function<GetMappingRequest.Builder,ObjectBuilder<GetMappingRequest>> 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<GetMappingRequest,GetMappingResponse,ErrorResponse> _ENDPOINT

Endpoint "indices.get_mapping".

Method Details

of

public static GetMappingRequest of(Function<GetMappingRequest.Builder,ObjectBuilder<GetMappingRequest>> 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

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

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

@Deprecated
@Nullable
public final Boolean local()

Deprecated.

7.8.0 This parameter is a no-op and field mappings are always retrieved locally.

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

API name: local

masterTimeout

@Nullable
public final Time masterTimeout()

Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.

API name: master_timeout