Package org.elasticsearch.client.indices
Class GetIndexRequest
java.lang.Object
org.elasticsearch.client.TimedRequest
org.elasticsearch.client.indices.GetIndexRequest
- All Implemented Interfaces:
Validatable
public class GetIndexRequest extends TimedRequest
A request to retrieve information about an index.
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
GetIndexRequest.Feature
-
Field Summary
Fields inherited from class org.elasticsearch.client.TimedRequest
DEFAULT_ACK_TIMEOUT, DEFAULT_MASTER_NODE_TIMEOUT
-
Constructor Summary
Constructors Constructor Description GetIndexRequest(java.lang.String... indices)
-
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".java.lang.String[]
indices()
The indices into which the mappings will be put.IndicesOptions
indicesOptions()
GetIndexRequest
indicesOptions(IndicesOptions indicesOptions)
boolean
local()
Return local information, do not retrieve the state from master node (default: false).GetIndexRequest
local(boolean local)
Methods inherited from class org.elasticsearch.client.TimedRequest
masterNodeTimeout, setMasterTimeout, setTimeout, timeout
-
Constructor Details
-
GetIndexRequest
public GetIndexRequest(java.lang.String... indices)
-
-
Method Details
-
indices
public java.lang.String[] 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.
-