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

Class GetFieldMappingsIndexRequest

java.lang.Object

org.opensearch.transport.TransportMessage

org.opensearch.transport.TransportRequest

org.opensearch.action.ActionRequest

org.opensearch.action.support.single.shard.SingleShardRequest<GetFieldMappingsIndexRequest>

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

All Implemented Interfaces:

IndicesRequest, Writeable, TaskAwareRequest

public class GetFieldMappingsIndexRequest
extends SingleShardRequest<GetFieldMappingsIndexRequest>

Transport action to get field mappings.

Opensearch.internal:

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.common.io.stream.Writeable

Writeable.Reader<V>, Writeable.Writer<V>

Field Summary

Fields inherited from class org.opensearch.action.support.single.shard.SingleShardRequest

index, INDICES_OPTIONS

Method Summary

Modifier and Type	Method	Description
String[]	fields()
boolean	includeDefaults()
String[]	indices()	Returns the array of indices that the action relates to
IndicesOptions	indicesOptions()	Returns the indices options used to resolve indices.
ActionRequestValidationException	validate()
void	writeTo(StreamOutput out)	Write this into the StreamOutput.

Methods inherited from class org.opensearch.action.support.single.shard.SingleShardRequest

index, index, validateNonNullIndex

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.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.action.IndicesRequest

includeDataStreams

Methods inherited from interface org.opensearch.tasks.TaskAwareRequest

createTask, getDescription, setParentTask

Method Details

validate

public ActionRequestValidationException validate()

Specified by:

validate in class ActionRequest

fields

public String[] fields()

includeDefaults

public boolean includeDefaults()

indices

public String[] indices()

Description copied from interface: IndicesRequest

Returns the array of indices that the action relates to

Specified by:

indices in interface IndicesRequest

Overrides:

indices in class SingleShardRequest<GetFieldMappingsIndexRequest>

indicesOptions

public IndicesOptions indicesOptions()

Description copied from interface: IndicesRequest

Returns the indices options used to resolve indices. They tell for instance whether a single index is accepted, whether an empty array will be converted to _all, and how wildcards will be expanded if needed.

Specified by:

indicesOptions in interface IndicesRequest

Overrides:

indicesOptions in class SingleShardRequest<GetFieldMappingsIndexRequest>

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Description copied from interface: Writeable

Write this into the StreamOutput.

Specified by:

writeTo in interface Writeable

Overrides:

writeTo in class SingleShardRequest<GetFieldMappingsIndexRequest>

Throws:

IOException