Class GetFieldMappingsRequest
java.lang.Object
org.elasticsearch.transport.TransportMessage
org.elasticsearch.transport.TransportRequest
org.elasticsearch.action.ActionRequest
org.elasticsearch.action.admin.indices.mapping.get.GetFieldMappingsRequest
- All Implemented Interfaces:
IndicesRequest
,IndicesRequest.Replaceable
,Writeable
,TaskAwareRequest
public class GetFieldMappingsRequest extends ActionRequest implements IndicesRequest.Replaceable
Request the mappings of specific fields
Note: there is a new class with the same name for the Java HLRC that uses a typeless format.
Any changes done to this class should go to that client class as well.
-
Nested Class Summary
Nested classes/interfaces inherited from class org.elasticsearch.transport.TransportRequest
TransportRequest.Empty
Nested classes/interfaces inherited from interface org.elasticsearch.action.IndicesRequest
IndicesRequest.Replaceable
Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable
Writeable.Reader<V>, Writeable.Writer<V>
-
Field Summary
Fields Modifier and Type Field Description protected boolean
local
-
Constructor Summary
Constructors Constructor Description GetFieldMappingsRequest()
GetFieldMappingsRequest(StreamInput in)
-
Method Summary
Modifier and Type Method Description java.lang.String[]
fields()
GetFieldMappingsRequest
fields(java.lang.String... fields)
boolean
includeDefaults()
GetFieldMappingsRequest
includeDefaults(boolean includeDefaults)
Indicates whether default mapping settings should be returnedjava.lang.String[]
indices()
Returns the array of indices that the action relates toGetFieldMappingsRequest
indices(java.lang.String... indices)
Sets the indices that the action relates to.IndicesOptions
indicesOptions()
Returns the indices options used to resolve indices.GetFieldMappingsRequest
indicesOptions(IndicesOptions indicesOptions)
boolean
local()
GetFieldMappingsRequest
local(boolean local)
Indicate whether the receiving node should operate based on local index information or forward requests, where needed, to other nodes.java.lang.String[]
types()
GetFieldMappingsRequest
types(java.lang.String... types)
ActionRequestValidationException
validate()
void
writeTo(StreamOutput out)
Write this into the StreamOutput.Methods inherited from class org.elasticsearch.transport.TransportRequest
getParentTask, setParentTask
Methods inherited from class org.elasticsearch.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.elasticsearch.tasks.TaskAwareRequest
createTask, getDescription, setParentTask
-
Field Details
-
local
protected boolean local
-
-
Constructor Details
-
GetFieldMappingsRequest
public GetFieldMappingsRequest() -
GetFieldMappingsRequest
- Throws:
java.io.IOException
-
-
Method Details
-
local
Indicate whether the receiving node should operate based on local index information or forward requests, where needed, to other nodes. If running locally, request will not raise errors if running locally & missing indices. -
local
public boolean local() -
indices
Description copied from interface:IndicesRequest.Replaceable
Sets the indices that the action relates to.- Specified by:
indices
in interfaceIndicesRequest.Replaceable
-
types
-
indicesOptions
-
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
-
types
public java.lang.String[] types() -
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
-
fields
- Parameters:
fields
- a list of fields to retrieve the mapping for
-
fields
public java.lang.String[] fields() -
includeDefaults
public boolean includeDefaults() -
includeDefaults
Indicates whether default mapping settings should be returned -
validate
- Specified by:
validate
in classActionRequest
-
writeTo
Description copied from interface:Writeable
Write this into the StreamOutput.- Specified by:
writeTo
in interfaceWriteable
- Overrides:
writeTo
in classActionRequest
- Throws:
java.io.IOException
-