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

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 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()	Whether to ignore if a wildcard indices expression resolves into no concrete indices.
final List<ExpandWildcard>	expandWildcards()	Whether to expand wildcard expression to concrete indices that are open, closed or both.
final List<String>	fields()	Required - A comma-separated list of fields
final Boolean	ignoreUnavailable()	Whether specified concrete indices should be ignored when unavailable (missing or closed)
final Boolean	includeDefaults()	Whether the default mapping values should be returned as well
final Boolean	includeTypeName()	Whether a type should be returned in the body of the mappings.
final List<String>	index()	A comma-separated list of index names
final Boolean	local()	Return local information, do not retrieve the state from master node (default: false)
static GetFieldMappingRequest	of(Function<GetFieldMappingRequest.Builder,ObjectBuilder<GetFieldMappingRequest>> fn)
final List<String>	type()	A comma-separated list of document types

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()

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

public final List<ExpandWildcard> expandWildcards()

Whether to expand wildcard expression to concrete indices that are open, closed or both.

API name: expand_wildcards

fields

public final List<String> fields()

Required - A comma-separated list of fields

API name: fields

ignoreUnavailable

@Nullable
public final Boolean ignoreUnavailable()

Whether specified concrete indices should be ignored when unavailable (missing or closed)

API name: ignore_unavailable

includeDefaults

@Nullable
public final Boolean includeDefaults()

Whether the default mapping values should be returned as well

API name: include_defaults

includeTypeName

@Nullable
public final Boolean includeTypeName()

Whether a type should be returned in the body of the mappings.

API name: include_type_name

index

public final List<String> index()

A comma-separated list of index names

API name: index

local

@Nullable
public final Boolean local()

Return local information, do not retrieve the state from master node (default: false)

API name: local

type

public final List<String> type()

A comma-separated list of document types

API name: type