Package org.elasticsearch.client.indices
Class GetIndexRequest
java.lang.Object
org.elasticsearch.client.TimedRequest
org.elasticsearch.client.indices.GetIndexRequest
- All Implemented Interfaces:
Validatable
A request to retrieve information about an index.
-
Nested Class Summary
-
Field Summary
Fields inherited from class org.elasticsearch.client.TimedRequest
DEFAULT_ACK_TIMEOUT, DEFAULT_MASTER_NODE_TIMEOUT
Fields inherited from interface org.elasticsearch.client.Validatable
EMPTY
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionaddFeatures
(GetIndexRequest.Feature... featuresToAdd) features()
features
(GetIndexRequest.Feature... features) boolean
humanReadable
(boolean humanReadable) boolean
Whether to return all default settings for each of the indices.includeDefaults
(boolean includeDefaults) Sets the value of "include_defaults".String[]
indices()
The indices into which the mappings will be put.indicesOptions
(IndicesOptions indicesOptions) final boolean
local()
Return local information, do not retrieve the state from master node (default: false).final GetIndexRequest
local
(boolean local) Methods inherited from class org.elasticsearch.client.TimedRequest
masterNodeTimeout, setMasterTimeout, setTimeout, timeout
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface org.elasticsearch.client.Validatable
validate
-
Field Details
-
DEFAULT_INDICES_OPTIONS
-
-
Constructor Details
-
GetIndexRequest
-
-
Method Details
-
indices
The indices into which the mappings will be put. -
indicesOptions
-
indicesOptions
-
local
-
local
public final boolean local()Return local information, do not retrieve the state from master node (default: false).- Returns:
true
if local information is to be returned;false
if information is to be retrieved from master node (default).
-
features
-
addFeatures
-
features
-
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.
-