Package org.opensearch.client.opensearch.indices

Class GetMappingRequest

java.lang.Object

org.opensearch.client.opensearch._types.RequestBase

org.opensearch.client.opensearch.indices.GetMappingRequest

public class GetMappingRequest
extends RequestBase

Returns mappings for one or more indices.

Nested Class Summary

Nested Classes

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

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<GetMappingRequest,GetMappingResponse,ErrorResponse>	_ENDPOINT	Endpoint "indices.get_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.
Time	clusterManagerTimeout()	Specify timeout for connection to cluster-manager
java.util.List<ExpandWildcard>	expandWildcards()	Whether to expand wildcard expression to concrete indices that are open, closed or both.
java.lang.Boolean	ignoreUnavailable()	Whether specified concrete indices should be ignored when unavailable (missing or closed)
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)
Time	masterTimeout()	Deprecated.
static GetMappingRequest	of(java.util.function.Function<GetMappingRequest.Builder,ObjectBuilder<GetMappingRequest>> 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<GetMappingRequest,GetMappingResponse,ErrorResponse> _ENDPOINT

Endpoint "indices.get_mapping".

Method Detail

of

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

ignoreUnavailable

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

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

API name: ignore_unavailable

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

masterTimeout

@Deprecated
@Nullable
public final Time masterTimeout()

Deprecated.

Specify timeout for connection to master

API name: master_timeout

clusterManagerTimeout

@Nullable
public final Time clusterManagerTimeout()

Specify timeout for connection to cluster-manager

API name: cluster_manager_timeout