IndicesRequest
, IndicesRequest.Replaceable
, Streamable
, Writeable
, TaskAwareRequest
public class GetFieldMappingsRequest extends ActionRequest implements IndicesRequest.Replaceable
IndicesRequest.Replaceable
TransportRequest.Empty
Writeable.Reader<V>, Writeable.Writer<V>
Modifier and Type | Field | Description |
---|---|---|
protected boolean |
local |
Constructor | Description |
---|---|
GetFieldMappingsRequest() |
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 returned
|
java.lang.String[] |
indices() |
Returns the array of indices that the action relates to
|
GetFieldMappingsRequest |
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.
|
void |
readFrom(StreamInput in) |
Set this object's fields from a StreamInput.
|
java.lang.String[] |
types() |
|
GetFieldMappingsRequest |
types(java.lang.String... types) |
|
ActionRequestValidationException |
validate() |
|
void |
writeTo(StreamOutput out) |
Write this object's fields to a StreamOutput.
|
getShouldStoreResult
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
createTask, getDescription, setParentTask
remoteAddress, remoteAddress
getParentTask, setParentTask
public GetFieldMappingsRequest local(boolean local)
public boolean local()
public GetFieldMappingsRequest indices(java.lang.String... indices)
IndicesRequest.Replaceable
indices
in interface IndicesRequest.Replaceable
public GetFieldMappingsRequest types(java.lang.String... types)
public GetFieldMappingsRequest indicesOptions(IndicesOptions indicesOptions)
public java.lang.String[] indices()
IndicesRequest
indices
in interface IndicesRequest
public java.lang.String[] types()
public IndicesOptions indicesOptions()
IndicesRequest
indicesOptions
in interface IndicesRequest
public GetFieldMappingsRequest fields(java.lang.String... fields)
fields
- a list of fields to retrieve the mapping forpublic java.lang.String[] fields()
public boolean includeDefaults()
public GetFieldMappingsRequest includeDefaults(boolean includeDefaults)
public ActionRequestValidationException validate()
validate
in class ActionRequest
public void writeTo(StreamOutput out) throws java.io.IOException
Streamable
writeTo
in interface Streamable
writeTo
in interface Writeable
writeTo
in class ActionRequest
java.io.IOException
public void readFrom(StreamInput in) throws java.io.IOException
Streamable
readFrom
in interface Streamable
readFrom
in class ActionRequest
java.io.IOException