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​(XContentParser parser)  
    java.util.Map<java.lang.String,​java.util.List<AliasMetaData>> getAliases()  
    java.util.Map<java.lang.String,​Settings> getDefaultSettings()
    If the originating GetIndexRequest object was configured to include defaults, this will contain a mapping of index name to Settings objects.
    java.lang.String[] getIndices()  
    java.util.Map<java.lang.String,​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,​Settings> getSettings()  

    Methods inherited from class java.lang.Object

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

  • Method Details

    • getIndices

      public java.lang.String[] getIndices()

    • getMappings

      public java.util.Map<java.lang.String,​MappingMetaData> getMappings()

    • getAliases

      public java.util.Map<java.lang.String,​java.util.List<AliasMetaData>> getAliases()

    • getDefaultSettings

      public java.util.Map<java.lang.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 java.util.Map<java.lang.String,​Settings> getSettings()

    • 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 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​(XContentParser parser) throws java.io.IOException
      Throws:
      java.io.IOException