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

Class GetSettingsResponse

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.xcontent.ToXContent, org.elasticsearch.common.xcontent.ToXContentObject, org.elasticsearch.core.RefCounted
public class GetSettingsResponse extends ActionResponse implements org.elasticsearch.common.xcontent.ToXContentObject

  • Nested Class Summary

    Nested classes/interfaces inherited from class org.elasticsearch.action.ActionResponse

    ActionResponse.Empty

    Nested classes/interfaces inherited from interface org.elasticsearch.common.xcontent.ToXContent

    org.elasticsearch.common.xcontent.ToXContent.DelegatingMapParams, org.elasticsearch.common.xcontent.ToXContent.MapParams, org.elasticsearch.common.xcontent.ToXContent.Params

    Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable

    Writeable.Reader<V>, Writeable.Writer<V>

  • Field Summary

    Fields inherited from interface org.elasticsearch.common.xcontent.ToXContent

    EMPTY_PARAMS

  • Constructor Summary

    Constructors
    Constructor
    Description
    ,​Settings> indexToSettings, ,​Settings> indexToDefaultSettings)
     
    GetSettingsResponse​(StreamInput in)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
     o)
     
    static GetSettingsResponse
    fromXContent​(org.elasticsearch.common.xcontent.XContentParser parser)
     
    ,​Settings>
    getIndexToDefaultSettings()
    If the originating GetSettingsRequest object was configured to include defaults, this will contain a mapping of index name to Settings objects.
    ,​Settings>
    getIndexToSettings()
    Returns a map of index name to Settings object.
     index,  setting)
    Returns the string value for the specified index and setting.
    int
    hashCode()
     
    toString()
     
    org.elasticsearch.common.xcontent.XContentBuilder
    toXContent​(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params)
     
    void
    writeTo​(StreamOutput out)
    Write this into the StreamOutput.

    Methods inherited from class org.elasticsearch.transport.TransportMessage

    decRef, incRef, remoteAddress, remoteAddress, tryIncRef

    Methods inherited from class java.lang.

    , , , , , , ,

    Methods inherited from interface org.elasticsearch.common.xcontent.ToXContentObject

    isFragment

  • Constructor Details

    • GetSettingsResponse

      public GetSettingsResponse​(,​Settings> indexToSettings, ,​Settings> indexToDefaultSettings)

    • GetSettingsResponse

      public GetSettingsResponse​(StreamInput in) throws
      Throws:

  • Method Details

    • getIndexToSettings

      public ,​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 ,​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  getSetting​( index,  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
      Description copied from interface: Writeable
      Write this into the StreamOutput.
      Specified by:
      writeTo in interface Writeable
      Throws:

    • fromXContent

      public static GetSettingsResponse fromXContent​(org.elasticsearch.common.xcontent.XContentParser parser) throws
      Throws:

    • toString

      public  toString()
      Overrides:
       in class 

    • toXContent

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

    • equals

      public boolean equals​( o)
      Overrides:
       in class 

    • hashCode

      public int hashCode()
      Overrides:
       in class