Class GetIndexRequest
java.lang.Object
org.elasticsearch.transport.TransportMessage
org.elasticsearch.transport.TransportRequest
org.elasticsearch.action.ActionRequest
org.elasticsearch.action.support.master.MasterNodeRequest<Request>
org.elasticsearch.action.support.master.MasterNodeReadRequest<Request>
org.elasticsearch.action.support.master.info.ClusterInfoRequest<GetIndexRequest>
org.elasticsearch.action.admin.indices.get.GetIndexRequest
- All Implemented Interfaces:
IndicesRequest
,IndicesRequest.Replaceable
,Writeable
,TaskAwareRequest
public class GetIndexRequest extends ClusterInfoRequest<GetIndexRequest>
A request to retrieve information about an index.
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
GetIndexRequest.Feature
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 inherited from class org.elasticsearch.action.support.master.MasterNodeRequest
DEFAULT_MASTER_NODE_TIMEOUT, masterNodeTimeout
-
Constructor Summary
Constructors Constructor Description GetIndexRequest()
GetIndexRequest(StreamInput in)
-
Method Summary
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".ActionRequestValidationException
validate()
void
writeTo(StreamOutput out)
Write this into the StreamOutput.Methods inherited from class org.elasticsearch.action.support.master.info.ClusterInfoRequest
indices, indices, indicesOptions, indicesOptions, types, types
Methods inherited from class org.elasticsearch.action.support.master.MasterNodeReadRequest
local, local
Methods inherited from class org.elasticsearch.action.support.master.MasterNodeRequest
masterNodeTimeout, masterNodeTimeout, masterNodeTimeout
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
-
Constructor Details
-
GetIndexRequest
public GetIndexRequest() -
GetIndexRequest
- Throws:
java.io.IOException
-
-
Method Details
-
features
-
addFeatures
-
features
-
validate
- Specified by:
validate
in classActionRequest
-
humanReadable
-
humanReadable
public boolean humanReadable() -
includeDefaults
Sets the value of "include_defaults".- Parameters:
includeDefaults
- value of "include_defaults" to be set.- Returns:
- this request
-
includeDefaults
public boolean includeDefaults()Whether to return all default settings for each of the indices.- Returns:
true
if defaults settings for each of the indices need to returned;false
otherwise.
-
writeTo
Description copied from interface:Writeable
Write this into the StreamOutput.- Specified by:
writeTo
in interfaceWriteable
- Overrides:
writeTo
in classClusterInfoRequest<GetIndexRequest>
- Throws:
java.io.IOException
-