Module org.elasticsearch.server

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

Class GetIndexResponse

java.lang.Object

org.elasticsearch.transport.TransportMessage

org.elasticsearch.transport.TransportResponse

org.elasticsearch.action.ActionResponse

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

All Implemented Interfaces:

Writeable, ChunkedToXContent, ChunkedToXContentObject, RefCounted

public class GetIndexResponse
extends ActionResponse
implements ChunkedToXContentObject

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.io.stream.Writeable

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

Field Summary

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

EMPTY

Fields inherited from interface org.elasticsearch.core.RefCounted

ALWAYS_REFERENCED

Constructor Summary

Constructors

Constructor	Description
GetIndexResponse(String[] indices, Map<String,MappingMetadata> mappings, Map<String,List<AliasMetadata>> aliases, Map<String,Settings> settings, Map<String,Settings> defaultSettings, Map<String,String> dataStreams)

Method Summary

Modifier and Type	Method	Description
Map<String,List<AliasMetadata>>	aliases()
Map<String,String>	dataStreams()
Map<String,Settings>	defaultSettings()	If the originating GetIndexRequest object was configured to include defaults, this will contain a mapping of index name to Settings objects.
boolean	equals(Object o)
Map<String,List<AliasMetadata>>	getAliases()
Map<String,String>	getDataStreams()
String[]	getIndices()
Map<String,MappingMetadata>	getMappings()
String	getSetting(String index, String setting)	Returns the string value for the specified index and setting.
Map<String,Settings>	getSettings()
int	hashCode()
String[]	indices()
Map<String,MappingMetadata>	mappings()
Map<String,Settings>	settings()
String	toString()
Iterator<? extends ToXContent>	toXContentChunked(ToXContent.Params ignored)	Create an iterator of ToXContent chunks for a REST response.
void	writeTo(StreamOutput out)	Write this into the StreamOutput.

Methods inherited from class org.elasticsearch.transport.TransportMessage

decRef, hasReferences, incRef, remoteAddress, remoteAddress, tryIncRef

Methods inherited from class java.lang.Object

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

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

toXContentChunkedV7

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

isFragment

Methods inherited from interface org.elasticsearch.core.RefCounted

mustIncRef

Constructor Details

GetIndexResponse

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

Method Details

indices

public String[] indices()

getIndices

public String[] getIndices()

mappings

public Map<String,MappingMetadata> mappings()

getMappings

public Map<String,MappingMetadata> getMappings()

aliases

public Map<String,List<AliasMetadata>> aliases()

getAliases

public Map<String,List<AliasMetadata>> getAliases()

settings

public Map<String,Settings> settings()

dataStreams

public Map<String,String> dataStreams()

getDataStreams

public Map<String,String> getDataStreams()

defaultSettings

public Map<String,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 Map<String,Settings> getSettings()

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 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 IOException

Description copied from interface: Writeable

Write this into the StreamOutput.

Specified by:

writeTo in interface Writeable

Throws:

IOException

toXContentChunked

public Iterator<? extends ToXContent> toXContentChunked(ToXContent.Params ignored)

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

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object