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

Class GetSettingsResponse

java.lang.Object
org.opensearch.core.transport.TransportMessage
org.opensearch.core.transport.TransportResponse
org.opensearch.core.action.ActionResponse
org.opensearch.action.admin.indices.settings.get.GetSettingsResponse
All Implemented Interfaces:
org.opensearch.core.common.io.stream.Writeable, org.opensearch.core.xcontent.ToXContent, org.opensearch.core.xcontent.ToXContentObject
@PublicApi(since="1.0.0") public class GetSettingsResponse extends org.opensearch.core.action.ActionResponse implements org.opensearch.core.xcontent.ToXContentObject
Transport response for getting index segments
Opensearch.api:

  • Nested Class Summary

    Nested classes/interfaces inherited from class org.opensearch.core.transport.TransportResponse

    org.opensearch.core.transport.TransportResponse.Empty

    Nested classes/interfaces inherited from interface org.opensearch.core.xcontent.ToXContent

    org.opensearch.core.xcontent.ToXContent.DelegatingMapParams, org.opensearch.core.xcontent.ToXContent.MapParams, org.opensearch.core.xcontent.ToXContent.Params

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

    org.opensearch.core.common.io.stream.Writeable.Reader<V>, org.opensearch.core.common.io.stream.Writeable.WriteableRegistry, org.opensearch.core.common.io.stream.Writeable.Writer<V>

  • Field Summary

    Fields inherited from interface org.opensearch.core.xcontent.ToXContent

    EMPTY_PARAMS

  • Constructor Summary

    Constructors
    Constructor
    Description
    GetSettingsResponse(Map<String,Settings> indexToSettings, Map<String,Settings> indexToDefaultSettings)
     
    GetSettingsResponse(org.opensearch.core.common.io.stream.StreamInput in)
     

  • Method Summary

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

    Methods inherited from class org.opensearch.core.transport.TransportMessage

    remoteAddress, remoteAddress

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface org.opensearch.core.xcontent.ToXContentObject

    isFragment

  • Constructor Details

  • Method Details

    • getIndexToSettings

      public Map<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 Map<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 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 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(org.opensearch.core.common.io.stream.StreamOutput out) throws IOException
      Specified by:
      writeTo in interface org.opensearch.core.common.io.stream.Writeable
      Throws:
      IOException

    • fromXContent

      public static GetSettingsResponse fromXContent(org.opensearch.core.xcontent.XContentParser parser) throws IOException
      Throws:
      IOException

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • toXContent

      public org.opensearch.core.xcontent.XContentBuilder toXContent(org.opensearch.core.xcontent.XContentBuilder builder, org.opensearch.core.xcontent.ToXContent.Params params) throws IOException
      Specified by:
      toXContent in interface org.opensearch.core.xcontent.ToXContent
      Throws:
      IOException

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object