Module org.elasticsearch.server
Class GetIndexRequest
java.lang.Object
org.elasticsearch.transport.TransportMessage
org.elasticsearch.transport.TransportRequest
org.elasticsearch.action.ActionRequest
org.elasticsearch.action.support.master.MasterNodeRequest<GetIndexRequest>
org.elasticsearch.action.support.master.MasterNodeReadRequest<GetIndexRequest>
org.elasticsearch.action.support.master.info.ClusterInfoRequest<GetIndexRequest>
org.elasticsearch.action.admin.indices.get.GetIndexRequest
- All Implemented Interfaces:
IndicesRequest,IndicesRequest.Replaceable,Writeable,RefCounted,TaskAwareRequest
A request to retrieve information about an index.
-
Nested Class Summary
Nested ClassesNested classes/interfaces inherited from interface org.elasticsearch.action.IndicesRequest
IndicesRequest.RemoteClusterShardRequest, IndicesRequest.Replaceable, IndicesRequest.SingleIndexNoWildcardsNested 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.MasterNodeReadRequest
localFields inherited from class org.elasticsearch.action.support.master.MasterNodeRequest
TRAPPY_IMPLICIT_DEFAULT_MASTER_NODE_TIMEOUTFields inherited from interface org.elasticsearch.core.RefCounted
ALWAYS_REFERENCED -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionaddFeatures(GetIndexRequest.Feature... features) Returns the task object that should be used to keep track of the processing of the request.features()features(GetIndexRequest.Feature... features) booleanhumanReadable(boolean humanReadable) booleanWhether to return all default settings for each of the indices.includeDefaults(boolean includeDefaults) Sets the value of "include_defaults".validate()voidwriteTo(StreamOutput out) Write this into the StreamOutput.Methods inherited from class org.elasticsearch.action.support.master.info.ClusterInfoRequest
includeDataStreams, indices, indices, indicesOptions, indicesOptionsMethods inherited from class org.elasticsearch.action.support.master.MasterNodeReadRequest
local, localMethods inherited from class org.elasticsearch.action.support.master.MasterNodeRequest
infiniteMasterNodeTimeout, masterNodeTimeout, masterNodeTimeout, masterTermMethods inherited from class org.elasticsearch.action.ActionRequest
getShouldStoreResultMethods inherited from class org.elasticsearch.transport.TransportRequest
getParentTask, getRequestId, setParentTask, setRequestId, toStringMethods inherited from class org.elasticsearch.transport.TransportMessage
decRef, hasReferences, incRef, remoteAddress, remoteAddress, tryIncRefMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitMethods inherited from interface org.elasticsearch.action.IndicesRequest.Replaceable
allowsRemoteIndicesMethods inherited from interface org.elasticsearch.core.RefCounted
mustIncRefMethods inherited from interface org.elasticsearch.tasks.TaskAwareRequest
getDescription, setParentTask
-
Constructor Details
-
GetIndexRequest
public GetIndexRequest() -
GetIndexRequest
- Throws:
IOException
-
-
Method Details
-
features
-
addFeatures
-
features
-
validate
- Specified by:
validatein 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:
trueif defaults settings for each of the indices need to returned;falseotherwise.
-
writeTo
Description copied from interface:WriteableWrite this into the StreamOutput.- Specified by:
writeToin interfaceWriteable- Overrides:
writeToin classClusterInfoRequest<GetIndexRequest>- Throws:
IOException
-
createTask
public Task createTask(long id, String type, String action, TaskId parentTaskId, Map<String, String> headers) Description copied from interface:TaskAwareRequestReturns the task object that should be used to keep track of the processing of the request.
-