Package org.elasticsearch.client.indices

Class GetIndexResponse

java.lang.Object

org.elasticsearch.client.indices.GetIndexResponse

public class GetIndexResponse
extends Object

A client side response for a get index action.

Method Summary

Modifier and Type	Method	Description
static GetIndexResponse	fromXContent(org.elasticsearch.xcontent.XContentParser parser)
Map<String,List<AliasMetadata>>	getAliases()
Map<String,String>	getDataStreams()
Map<String,Settings>	getDefaultSettings()	If the originating GetIndexRequest object was configured to include defaults, this will contain a mapping of index name to Settings objects.
String[]	getIndices()
Map<String,MappingMetadata>	getMappings()
String	getSetting(String index, String setting)	Returns the string value for the specified index and setting.
Map<String,Settings>	getSettings()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

getIndices

public String[] getIndices()

getMappings

public Map<String,MappingMetadata> getMappings()

getAliases

public Map<String,List<AliasMetadata>> getAliases()

getDefaultSettings

public Map<String,Settings> getDefaultSettings()

If the originating GetIndexRequest object was configured to include defaults, this will contain a mapping of index name to Settings objects. The returned Settings objects will contain only those settings taking effect as defaults. Any settings explicitly set on the index will be available via getSettings(). See also GetIndexRequest.includeDefaults(boolean)

getSettings

public Map<String,Settings> getSettings()

getDataStreams

public Map<String,String> getDataStreams()

getSetting

public String getSetting(String index,
 String setting)

Returns the string value for the specified index and setting. If the includeDefaults flag was not set or set to false on the GetIndexRequest, 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 the GetIndexRequest, this method will fall back to return the default value if the setting was not explicitly set.

fromXContent

public static GetIndexResponse fromXContent(org.elasticsearch.xcontent.XContentParser parser)
                                     throws IOException

Throws:

IOException