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>
-
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 java.lang.String[]
fields()
boolean
includeDefaults()
java.lang.String[]
indices()
Returns the array of indices that the action relates toIndicesOptions
indicesOptions()
Returns the indices options used to resolve indices.boolean
probablySingleFieldRequest()
java.lang.String[]
types()
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 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
-
Method Details
-
validate
- Specified by:
validate
in classActionRequest
-
types
public java.lang.String[] types() -
fields
public java.lang.String[] fields() -
probablySingleFieldRequest
public boolean probablySingleFieldRequest() -
includeDefaults
public boolean includeDefaults() -
indices
public java.lang.String[] indices()Description copied from interface:IndicesRequest
Returns the array of indices that the action relates to- Specified by:
indices
in interfaceIndicesRequest
- Overrides:
indices
in classSingleShardRequest<GetFieldMappingsIndexRequest>
-
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 interfaceIndicesRequest
- Overrides:
indicesOptions
in classSingleShardRequest<GetFieldMappingsIndexRequest>
-
writeTo
Description copied from interface:Writeable
Write this into the StreamOutput.- Specified by:
writeTo
in interfaceWriteable
- Overrides:
writeTo
in classSingleShardRequest<GetFieldMappingsIndexRequest>
- Throws:
java.io.IOException
-