Package org.elasticsearch.action.admin.indices.settings.get

Class GetSettingsResponse

java.lang.Object
org.elasticsearch.transport.TransportMessage
org.elasticsearch.transport.TransportResponse
org.elasticsearch.action.ActionResponse
org.elasticsearch.action.admin.indices.settings.get.GetSettingsResponse
All Implemented Interfaces:
Writeable, org.elasticsearch.common.util.concurrent.RefCounted, org.elasticsearch.common.xcontent.ToXContent, org.elasticsearch.common.xcontent.ToXContentObject
public class GetSettingsResponse
extends ActionResponse
implements org.elasticsearch.common.xcontent.ToXContentObject

  • Constructor Details

    • GetSettingsResponse

      public GetSettingsResponse​(ImmutableOpenMap<java.lang.String,​Settings> indexToSettings, ImmutableOpenMap<java.lang.String,​Settings> indexToDefaultSettings)

    • GetSettingsResponse

      public GetSettingsResponse​(StreamInput in) throws java.io.IOException
      Throws:
      java.io.IOException

  • Method Details

    • getIndexToSettings

      public ImmutableOpenMap<java.lang.String,​Settings> getIndexToSettings()
      Returns a map of index name to Settings object. The returned Settings objects contain only those settings explicitly set on a given index. Any settings taking effect as defaults must be accessed via getIndexToDefaultSettings().

    • getIndexToDefaultSettings

      public ImmutableOpenMap<java.lang.String,​Settings> getIndexToDefaultSettings()
      If the originating GetSettingsRequest 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 getIndexToSettings(). See also GetSettingsRequest.includeDefaults(boolean)

    • 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 GetSettingsRequest, 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 GetSettingsRequest, 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

    • fromXContent

      public static GetSettingsResponse 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

    • 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

    • 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