Class GetIndexResponse

All Implemented Interfaces:
Writeable, org.elasticsearch.common.util.concurrent.RefCounted, org.elasticsearch.common.xcontent.ToXContent, org.elasticsearch.common.xcontent.ToXContentObject

public class GetIndexResponse
extends ActionResponse
implements org.elasticsearch.common.xcontent.ToXContentObject
A response for a get index action.
  • Constructor Details

  • Method Details

    • indices

      public java.lang.String[] indices()
    • getIndices

      public java.lang.String[] getIndices()
    • mappings

      public ImmutableOpenMap<java.lang.String,​ImmutableOpenMap<java.lang.String,​MappingMetadata>> mappings()
    • getMappings

      public ImmutableOpenMap<java.lang.String,​ImmutableOpenMap<java.lang.String,​MappingMetadata>> getMappings()
    • aliases

      public ImmutableOpenMap<java.lang.String,​java.util.List<AliasMetadata>> aliases()
    • getAliases

      public ImmutableOpenMap<java.lang.String,​java.util.List<AliasMetadata>> getAliases()
    • settings

      public ImmutableOpenMap<java.lang.String,​Settings> settings()
    • dataStreams

      public ImmutableOpenMap<java.lang.String,​java.lang.String> dataStreams()
    • getDataStreams

      public ImmutableOpenMap<java.lang.String,​java.lang.String> getDataStreams()
    • defaultSettings

      public ImmutableOpenMap<java.lang.String,​Settings> defaultSettings()
      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 settings(). See also GetIndexRequest.includeDefaults(boolean)
    • getSettings

      public ImmutableOpenMap<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.
    • writeTo

      public void writeTo​(StreamOutput out) throws java.io.IOException
      Description copied from interface: Writeable
      Write this into the StreamOutput.
      Specified by:
      writeTo in interface Writeable
      Throws:
      java.io.IOException
    • toXContent

      public org.elasticsearch.common.xcontent.XContentBuilder toXContent​(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params) throws java.io.IOException
      Specified by:
      toXContent in interface org.elasticsearch.common.xcontent.ToXContent
      Throws:
      java.io.IOException
    • fromXContent

      public static GetIndexResponse fromXContent​(org.elasticsearch.common.xcontent.XContentParser parser) throws java.io.IOException
      Throws:
      java.io.IOException
    • toString

      public java.lang.String toString()
      Overrides:
      toString in class java.lang.Object
    • equals

      public boolean equals​(java.lang.Object o)
      Overrides:
      equals in class java.lang.Object
    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class java.lang.Object