Package org.opensearch.client.opensearch.indices

Class GetFieldMappingRequest

java.lang.Object

org.opensearch.client.opensearch._types.RequestBase

org.opensearch.client.opensearch.indices.GetFieldMappingRequest

public class GetFieldMappingRequest
extends RequestBase

Returns mapping for one or more fields.

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from class org.opensearch.client.opensearch._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 fields
java.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 well
java.util.List<java.lang.String>	index()	A comma-separated list of index names
java.lang.Boolean	local()	Return local information, do not retrieve the state from cluster-manager node (default: false)
static GetFieldMappingRequest	of(java.util.function.Function<GetFieldMappingRequest.Builder,ObjectBuilder<GetFieldMappingRequest>> fn)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

_ENDPOINT

public static final Endpoint<GetFieldMappingRequest,GetFieldMappingResponse,ErrorResponse> _ENDPOINT

Endpoint "indices.get_field_mapping".

Method Detail

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

public final java.util.List<ExpandWildcard> 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 fields

API name: fields

ignoreUnavailable

@Nullable
public final java.lang.Boolean ignoreUnavailable()

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

API name: ignore_unavailable

includeDefaults

@Nullable
public final java.lang.Boolean includeDefaults()

Whether the default mapping values should be returned as well

API name: include_defaults

index

public final java.util.List<java.lang.String> index()

A comma-separated list of index names

API name: index

local

@Nullable
public final java.lang.Boolean local()

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

API name: local