Module org.elasticsearch.server
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, ChunkedToXContent, ChunkedToXContentObject, RefCounted
public class GetSettingsResponse extends ActionResponse implements ChunkedToXContentObject

  • 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.

    • getIndexToDefaultSettings

      public Map<String,Settings> getIndexToDefaultSettings()
      Returns a map of index name to Settings object. The returned Settings objects contain only the default settings

    • 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(StreamOutput out) throws IOException
      Description copied from interface: Writeable
      Write this into the StreamOutput.
      Specified by:
      writeTo in interface Writeable
      Throws:
      IOException

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • toXContentChunked

      public Iterator<? extends ToXContent> toXContentChunked(ToXContent.Params params)
      Description copied from interface: ChunkedToXContent
      Create an iterator of ToXContent chunks for a REST response. Each chunk is serialized with the same XContentBuilder and ToXContent.Params, which is also the same as the ToXContent.Params passed as the params argument. For best results, all chunks should be O(1) size. The last chunk in the iterator must always yield at least one byte of output. See also ChunkedToXContentHelper for some handy utilities.

      Note that chunked response bodies cannot send deprecation warning headers once transmission has started, so implementations must check for deprecated feature use before returning.

      Specified by:
      toXContentChunked in interface ChunkedToXContent
      Returns:
      iterator over chunks of ToXContent

    • equals

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

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object