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

Class GetIndexResponse

java.lang.Object

org.opensearch.core.transport.TransportMessage

org.opensearch.core.transport.TransportResponse

org.opensearch.core.action.ActionResponse

org.opensearch.action.admin.indices.get.GetIndexResponse

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 GetIndexResponse
extends org.opensearch.core.action.ActionResponse
implements org.opensearch.core.xcontent.ToXContentObject

A response for a get index action.

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
GetIndexResponse(String[] indices, Map<String,MappingMetadata> mappings, Map<String,List<AliasMetadata>> aliases, Map<String,Settings> settings, Map<String,Settings> defaultSettings, Map<String,String> dataStreams)
GetIndexResponse(String[] indices, Map<String,MappingMetadata> mappings, Map<String,List<AliasMetadata>> aliases, Map<String,Settings> settings, Map<String,Settings> defaultSettings, Map<String,String> dataStreams, Map<String,Context> contexts)

Method Summary

Modifier and Type	Method	Description
Map<String,List<AliasMetadata>>	aliases()
Map<String,Context>	contexts()
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()
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

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)

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,
 Map<String,Context> contexts)

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()

contexts

public Map<String,Context> contexts()

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(org.opensearch.core.common.io.stream.StreamOutput out)
             throws IOException

Specified by:

writeTo in interface org.opensearch.core.common.io.stream.Writeable

Throws:

IOException

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

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