Module org.elasticsearch.server
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
A response for a get index action.
-
Nested Class Summary
Nested classes/interfaces inherited from class org.elasticsearch.action.ActionResponse
ActionResponse.EmptyNested 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
EMPTYFields inherited from interface org.elasticsearch.core.RefCounted
ALWAYS_REFERENCED -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionaliases()If the originatingGetIndexRequestobject was configured to include defaults, this will contain a mapping of index name toSettingsobjects.booleanString[]getSetting(String index, String setting) Returns the string value for the specified index and setting.inthashCode()String[]indices()mappings()settings()toString()Iterator<? extends ToXContent> toXContentChunked(ToXContent.Params ignored) Create an iterator ofToXContentchunks for a REST response.voidwriteTo(StreamOutput out) NB prior to 9.1 this was a TransportMasterNodeReadAction so for BwC we must remain able to write these responses until we no longer need to support calling this action remotely.Methods inherited from class org.elasticsearch.transport.TransportMessage
decRef, hasReferences, incRef, tryIncRefMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface org.elasticsearch.common.xcontent.ChunkedToXContent
toXContentChunked, toXContentChunkedV8Methods inherited from interface org.elasticsearch.common.xcontent.ChunkedToXContentObject
isFragmentMethods inherited from interface org.elasticsearch.core.RefCounted
mustIncRef
-
Constructor Details
-
GetIndexResponse
-
-
Method Details
-
indices
-
getIndices
-
mappings
-
getMappings
-
aliases
-
getAliases
-
settings
-
dataStreams
-
getDataStreams
-
defaultSettings
If the originatingGetIndexRequestobject was configured to include defaults, this will contain a mapping of index name toSettingsobjects. The returnedSettingsobjects will contain only those settings taking effect as defaults. Any settings explicitly set on the index will be available viasettings(). See alsoGetIndexRequest.includeDefaults(boolean) -
getSettings
-
getSetting
Returns the string value for the specified index and setting. If the includeDefaults flag was not set or set to false on theGetIndexRequest, 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 theGetIndexRequest, this method will fall back to return the default value if the setting was not explicitly set. -
writeTo
NB prior to 9.1 this was a TransportMasterNodeReadAction so for BwC we must remain able to write these responses until we no longer need to support calling this action remotely.- Specified by:
writeToin interfaceWriteable- Throws:
IOException
-
toXContentChunked
Description copied from interface:ChunkedToXContentCreate an iterator ofToXContentchunks for a REST response. Each chunk is serialized with the sameXContentBuilderandToXContent.Params, which is also the same as theToXContent.Paramspassed as theparamsargument. For best results, all chunks should beO(1)size. The last chunk in the iterator must always yield at least one byte of output. See alsoChunkedToXContentHelperfor 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:
toXContentChunkedin interfaceChunkedToXContent- Returns:
- iterator over chunks of
ToXContent
-
toString
-
equals
-
hashCode
public int hashCode()
-