Package org.elasticsearch.client.indices
Class GetIndexResponse
java.lang.Object
org.elasticsearch.client.indices.GetIndexResponse
public class GetIndexResponse
extends java.lang.Object
A client side response for a get index action.
-
Method Summary
Modifier and Type Method Description static GetIndexResponse
fromXContent(org.elasticsearch.common.xcontent.XContentParser parser)
java.util.Map<java.lang.String,java.util.List<org.elasticsearch.cluster.metadata.AliasMetadata>>
getAliases()
java.util.Map<java.lang.String,java.lang.String>
getDataStreams()
java.util.Map<java.lang.String,org.elasticsearch.common.settings.Settings>
getDefaultSettings()
If the originatingGetIndexRequest
object was configured to include defaults, this will contain a mapping of index name toSettings
objects.java.lang.String[]
getIndices()
java.util.Map<java.lang.String,org.elasticsearch.cluster.metadata.MappingMetadata>
getMappings()
java.lang.String
getSetting(java.lang.String index, java.lang.String setting)
Returns the string value for the specified index and setting.java.util.Map<java.lang.String,org.elasticsearch.common.settings.Settings>
getSettings()
-
Method Details
-
getIndices
public java.lang.String[] getIndices() -
getMappings
public java.util.Map<java.lang.String,org.elasticsearch.cluster.metadata.MappingMetadata> getMappings() -
getAliases
public java.util.Map<java.lang.String,java.util.List<org.elasticsearch.cluster.metadata.AliasMetadata>> getAliases() -
getDefaultSettings
public java.util.Map<java.lang.String,org.elasticsearch.common.settings.Settings> getDefaultSettings()If the originatingGetIndexRequest
object was configured to include defaults, this will contain a mapping of index name toSettings
objects. The returnedSettings
objects will contain only those settings taking effect as defaults. Any settings explicitly set on the index will be available viagetSettings()
. See alsoGetIndexRequest.includeDefaults(boolean)
-
getSettings
public java.util.Map<java.lang.String,org.elasticsearch.common.settings.Settings> getSettings() -
getDataStreams
public java.util.Map<java.lang.String,java.lang.String> getDataStreams() -
getSetting
public java.lang.String getSetting(java.lang.String index, java.lang.String setting)Returns the string value for the specified index and setting. If the includeDefaults flag was not set or set to false on theGetIndexRequest
, this method will only return a value where the setting was explicitly set on the index. If the includeDefaults flag was set to true on theGetIndexRequest
, this method will fall back to return the default value if the setting was not explicitly set. -
fromXContent
public static GetIndexResponse fromXContent(org.elasticsearch.common.xcontent.XContentParser parser) throws java.io.IOException- Throws:
java.io.IOException
-