Package org.opensearch.client.opensearch.indices

Class GetMappingRequest

java.lang.Object

org.opensearch.client.opensearch._types.RequestBase

org.opensearch.client.opensearch.indices.GetMappingRequest

public final class GetMappingRequest
extends RequestBase

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field	Description
static Endpoint<GetMappingRequest,GetMappingResponse,OpenSearchError>	ENDPOINT	Endpoint "indices.get_mapping".

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	GetMappingRequest(GetMappingRequest.Builder builder)

Method Summary

Modifier and Type	Method	Description
java.lang.Boolean	allowNoIndices()	API name: allow_no_indices
jakarta.json.JsonValue	expandWildcards()	API name: expand_wildcards
java.lang.Boolean	ignoreUnavailable()	API name: ignore_unavailable
java.lang.Boolean	includeTypeName()	API name: include_type_name
java.util.List<java.lang.String>	index()	API name: index
java.lang.Boolean	local()	API name: local
jakarta.json.JsonValue	masterTimeout()	API name: master_timeout
java.util.List<java.lang.String>	type()	API name: type

Methods inherited from class java.lang.Object

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

Field Details

ENDPOINT

public static final Endpoint<GetMappingRequest,GetMappingResponse,OpenSearchError> ENDPOINT

Endpoint "indices.get_mapping".

Constructor Details

GetMappingRequest

protected GetMappingRequest(GetMappingRequest.Builder builder)

Method Details

index

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

API name: index

type

@Nullable public java.util.List<java.lang.String> type()

API name: type

allowNoIndices

@Nullable public java.lang.Boolean allowNoIndices()

API name: allow_no_indices

expandWildcards

@Nullable public jakarta.json.JsonValue expandWildcards()

API name: expand_wildcards

ignoreUnavailable

@Nullable public java.lang.Boolean ignoreUnavailable()

API name: ignore_unavailable

includeTypeName

@Nullable public java.lang.Boolean includeTypeName()

API name: include_type_name

local

@Nullable public java.lang.Boolean local()

API name: local

masterTimeout

@Nullable public jakarta.json.JsonValue masterTimeout()

API name: master_timeout