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

Class GetIndexResponse

org.elasticsearch.transport.TransportMessage

org.elasticsearch.transport.TransportResponse

org.elasticsearch.action.ActionResponse

org.elasticsearch.action.admin.indices.get.GetIndexResponse

All Implemented Interfaces:

Writeable, org.elasticsearch.common.xcontent.ToXContent, org.elasticsearch.common.xcontent.ToXContentObject, org.elasticsearch.core.RefCounted

public class GetIndexResponse
extends ActionResponse
implements org.elasticsearch.common.xcontent.ToXContentObject

A response for a get index action.

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
[] indices, ,,MappingMetadata>> mappings, ,<AliasMetadata>> aliases, ,Settings> settings, ,Settings> defaultSettings, ,> dataStreams)

Method Summary

Modifier and Type	Method	Description
,<AliasMetadata>>	aliases()
,>	dataStreams()
,Settings>	defaultSettings()	If the originating GetIndexRequest object was configured to include defaults, this will contain a mapping of index name to Settings objects.
boolean	o)
static GetIndexResponse	fromXContent(org.elasticsearch.common.xcontent.XContentParser parser)
,<AliasMetadata>>	getAliases()
,>	getDataStreams()
[]	getIndices()
,,MappingMetadata>>	getMappings()
	index, setting)	Returns the string value for the specified index and setting.
,Settings>	getSettings()
int	hashCode()
[]	indices()
,,MappingMetadata>>	mappings()
,Settings>	settings()
	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

GetIndexResponse

public GetIndexResponse([] indices,
 ,,MappingMetadata>> mappings,
 ,<AliasMetadata>> aliases,
 ,Settings> settings,
 ,Settings> defaultSettings,
 ,> dataStreams)

Method Details

indices

public [] indices()

getIndices

public [] getIndices()

mappings

public ,,MappingMetadata>> mappings()

getMappings

public ,,MappingMetadata>> getMappings()

aliases

public ,<AliasMetadata>> aliases()

getAliases

public ,<AliasMetadata>> getAliases()

settings

public ,Settings> settings()

dataStreams

public ,> dataStreams()

getDataStreams

public ,> getDataStreams()

defaultSettings

public ,Settings> defaultSettings()

If the originating GetIndexRequest 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 settings(). See also GetIndexRequest.includeDefaults(boolean)

getSettings

public ,Settings> getSettings()

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 GetIndexRequest, 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 GetIndexRequest, 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:

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:

fromXContent

public static GetIndexResponse fromXContent(org.elasticsearch.common.xcontent.XContentParser parser)
                                     throws 

Throws:

toString

public  toString()

Overrides:

in class

equals

public boolean equals( o)

Overrides:

in class

hashCode

public int hashCode()

Overrides:

in class