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:

Streamable, Writeable, ToXContent, ToXContentObject

public class GetSettingsResponse
extends ActionResponse
implements ToXContentObject

Nested Class Summary

Nested classes/interfaces inherited from class org.elasticsearch.transport.TransportResponse

TransportResponse.Empty

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

ToXContent.DelegatingMapParams, ToXContent.MapParams, 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
GetSettingsResponse(ImmutableOpenMap<java.lang.String,Settings> indexToSettings, ImmutableOpenMap<java.lang.String,Settings> indexToDefaultSettings)

Method Summary

Modifier and Type	Method	Description
boolean	equals(java.lang.Object o)
static GetSettingsResponse	fromXContent(XContentParser parser)
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.
ImmutableOpenMap<java.lang.String,Settings>	getIndexToSettings()	Returns a map of index name to Settings object.
java.lang.String	getSetting(java.lang.String index, java.lang.String setting)	Returns the string value for the specified index and setting.
int	hashCode()
void	readFrom(StreamInput in)	Set this object's fields from a StreamInput.
java.lang.String	toString()
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
void	writeTo(StreamOutput out)	Write this object's fields to a StreamOutput.

Methods inherited from class org.elasticsearch.transport.TransportMessage

remoteAddress, remoteAddress

Methods inherited from class java.lang.Object

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

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

isFragment

Constructor Detail

GetSettingsResponse

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

Method Detail

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.

readFrom

public void readFrom(StreamInput in)
              throws java.io.IOException

Description copied from interface: Streamable

Set this object's fields from a StreamInput.

Specified by:

readFrom in interface Streamable

Overrides:

readFrom in class ActionResponse

Throws:

java.io.IOException

writeTo

public void writeTo(StreamOutput out)
             throws java.io.IOException

Description copied from interface: Streamable

Write this object's fields to a StreamOutput.

Specified by:

writeTo in interface Streamable

Specified by:

writeTo in interface Writeable

Overrides:

writeTo in class ActionResponse

Throws:

java.io.IOException

fromXContent

public static GetSettingsResponse fromXContent(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 XContentBuilder toXContent(XContentBuilder builder,
                                  ToXContent.Params params)
                           throws java.io.IOException

Specified by:

toXContent in interface 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