Package org.opensearch.action.admin.indices.mapping.get

Class GetMappingsRequest

java.lang.Object

org.opensearch.core.transport.TransportMessage

org.opensearch.transport.TransportRequest

org.opensearch.action.ActionRequest

org.opensearch.action.support.clustermanager.ClusterManagerNodeRequest<GetMappingsRequest>

org.opensearch.action.support.clustermanager.ClusterManagerNodeReadRequest<GetMappingsRequest>

org.opensearch.action.support.clustermanager.info.ClusterInfoRequest<GetMappingsRequest>

org.opensearch.action.support.master.info.ClusterInfoRequest<GetMappingsRequest>

org.opensearch.action.admin.indices.mapping.get.GetMappingsRequest

All Implemented Interfaces:

IndicesRequest, IndicesRequest.Replaceable, org.opensearch.core.common.io.stream.Writeable, TaskAwareRequest

@PublicApi(since="1.0.0")
public class GetMappingsRequest
extends ClusterInfoRequest<GetMappingsRequest>

Transport request to get field mappings.

Opensearch.api:

Nested Class Summary

Nested classes/interfaces inherited from class org.opensearch.transport.TransportRequest

TransportRequest.Empty

Nested classes/interfaces inherited from interface org.opensearch.action.IndicesRequest

IndicesRequest.Replaceable

Nested classes/interfaces inherited from interface org.opensearch.core.common.io.stream.Writeable

org.opensearch.core.common.io.stream.Writeable.Reader<V>, org.opensearch.core.common.io.stream.Writeable.WriteableRegistry, org.opensearch.core.common.io.stream.Writeable.Writer<V>

Field Summary

Fields inherited from class org.opensearch.action.support.clustermanager.ClusterManagerNodeReadRequest

local

Fields inherited from class org.opensearch.action.support.clustermanager.ClusterManagerNodeRequest

clusterManagerNodeTimeout, DEFAULT_CLUSTER_MANAGER_NODE_TIMEOUT, DEFAULT_MASTER_NODE_TIMEOUT, masterNodeTimeout

Constructor Summary

Constructors

Constructor	Description
GetMappingsRequest()
GetMappingsRequest(org.opensearch.core.common.io.stream.StreamInput in)

Method Summary

Modifier and Type	Method	Description
ActionRequestValidationException	validate()

Methods inherited from class org.opensearch.action.support.clustermanager.info.ClusterInfoRequest

includeDataStreams, indices, indices, indicesOptions, indicesOptions, writeTo

Methods inherited from class org.opensearch.action.support.clustermanager.ClusterManagerNodeReadRequest

local, local

Methods inherited from class org.opensearch.action.support.clustermanager.ClusterManagerNodeRequest

clusterManagerNodeTimeout, clusterManagerNodeTimeout, clusterManagerNodeTimeout, masterNodeTimeout, masterNodeTimeout, masterNodeTimeout

Methods inherited from class org.opensearch.action.ActionRequest

getShouldStoreResult

Methods inherited from class org.opensearch.transport.TransportRequest

getParentTask, setParentTask

Methods inherited from class org.opensearch.core.transport.TransportMessage

remoteAddress, remoteAddress

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opensearch.tasks.TaskAwareRequest

createTask, getDescription, setParentTask

Constructor Details

GetMappingsRequest

public GetMappingsRequest()

GetMappingsRequest

public GetMappingsRequest(org.opensearch.core.common.io.stream.StreamInput in)
                   throws IOException

Throws:

IOException

Method Details

validate

public ActionRequestValidationException validate()

Specified by:

validate in class ActionRequest