Package org.opensearch.client.opensearch.indices

Class GetFieldMappingRequest

java.lang.Object

org.opensearch.client.opensearch._types.RequestBase

org.opensearch.client.opensearch.indices.GetFieldMappingRequest

public final class GetFieldMappingRequest
extends RequestBase

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field	Description
static Endpoint<GetFieldMappingRequest,GetFieldMappingResponse,OpenSearchError>	ENDPOINT	Endpoint "indices.get_field_mapping".

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	GetFieldMappingRequest(GetFieldMappingRequest.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.util.List<java.lang.String>	fields()	API name: fields
java.lang.Boolean	ignoreUnavailable()	API name: ignore_unavailable
java.lang.Boolean	includeDefaults()	API name: include_defaults
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
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<GetFieldMappingRequest,GetFieldMappingResponse,OpenSearchError> ENDPOINT

Endpoint "indices.get_field_mapping".

Constructor Details

GetFieldMappingRequest

protected GetFieldMappingRequest(GetFieldMappingRequest.Builder builder)

Method Details

fields

public java.util.List<java.lang.String> fields()

API name: fields

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

includeDefaults

@Nullable public java.lang.Boolean includeDefaults()

API name: include_defaults

includeTypeName

@Nullable public java.lang.Boolean includeTypeName()

API name: include_type_name

local

@Nullable public java.lang.Boolean local()

API name: local