IndicesRequest
, IndicesRequest.Replaceable
, Streamable
, Writeable
, TaskAwareRequest
public class GetIndexRequest extends ClusterInfoRequest<GetIndexRequest>
Modifier and Type | Class | Description |
---|---|---|
static class |
GetIndexRequest.Feature |
IndicesRequest.Replaceable
TransportRequest.Empty
Writeable.Reader<V>, Writeable.Writer<V>
local
DEFAULT_MASTER_NODE_TIMEOUT, masterNodeTimeout
Constructor | Description |
---|---|
GetIndexRequest() |
Modifier and Type | Method | Description |
---|---|---|
GetIndexRequest |
addFeatures(GetIndexRequest.Feature... features) |
|
GetIndexRequest.Feature[] |
features() |
|
GetIndexRequest |
features(GetIndexRequest.Feature... features) |
|
boolean |
humanReadable() |
|
GetIndexRequest |
humanReadable(boolean humanReadable) |
|
boolean |
includeDefaults() |
Whether to return all default settings for each of the indices.
|
GetIndexRequest |
includeDefaults(boolean includeDefaults) |
Sets the value of "include_defaults".
|
void |
readFrom(StreamInput in) |
Set this object's fields from a StreamInput.
|
ActionRequestValidationException |
validate() |
|
void |
writeTo(StreamOutput out) |
Write this object's fields to a StreamOutput.
|
getShouldStoreResult
indices, indices, indicesOptions, indicesOptions, types, types
local, local
masterNodeTimeout, masterNodeTimeout, masterNodeTimeout
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
createTask, getDescription, setParentTask
remoteAddress, remoteAddress
getParentTask, setParentTask
public GetIndexRequest features(GetIndexRequest.Feature... features)
public GetIndexRequest addFeatures(GetIndexRequest.Feature... features)
public GetIndexRequest.Feature[] features()
public ActionRequestValidationException validate()
validate
in class ActionRequest
public GetIndexRequest humanReadable(boolean humanReadable)
public boolean humanReadable()
public GetIndexRequest includeDefaults(boolean includeDefaults)
includeDefaults
- value of "include_defaults" to be set.public boolean includeDefaults()
true
if defaults settings for each of the indices need to returned;
false
otherwise.public void readFrom(StreamInput in) throws java.io.IOException
Streamable
readFrom
in interface Streamable
readFrom
in class ClusterInfoRequest<GetIndexRequest>
java.io.IOException
public void writeTo(StreamOutput out) throws java.io.IOException
Streamable
writeTo
in interface Streamable
writeTo
in interface Writeable
writeTo
in class ClusterInfoRequest<GetIndexRequest>
java.io.IOException