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
,org.elasticsearch.common.util.concurrent.RefCounted
,org.elasticsearch.common.xcontent.ToXContent
,org.elasticsearch.common.xcontent.ToXContentObject
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 GetIndexResponse(java.lang.String[] indices, ImmutableOpenMap<java.lang.String,ImmutableOpenMap<java.lang.String,MappingMetadata>> mappings, ImmutableOpenMap<java.lang.String,java.util.List<AliasMetadata>> aliases, ImmutableOpenMap<java.lang.String,Settings> settings, ImmutableOpenMap<java.lang.String,Settings> defaultSettings, ImmutableOpenMap<java.lang.String,java.lang.String> dataStreams)
-
Method Summary
Modifier and Type Method Description ImmutableOpenMap<java.lang.String,java.util.List<AliasMetadata>>
aliases()
ImmutableOpenMap<java.lang.String,java.lang.String>
dataStreams()
ImmutableOpenMap<java.lang.String,Settings>
defaultSettings()
If the originatingGetIndexRequest
object was configured to include defaults, this will contain a mapping of index name toSettings
objects.boolean
equals(java.lang.Object o)
static GetIndexResponse
fromXContent(org.elasticsearch.common.xcontent.XContentParser parser)
ImmutableOpenMap<java.lang.String,java.util.List<AliasMetadata>>
getAliases()
ImmutableOpenMap<java.lang.String,java.lang.String>
getDataStreams()
java.lang.String[]
getIndices()
ImmutableOpenMap<java.lang.String,ImmutableOpenMap<java.lang.String,MappingMetadata>>
getMappings()
java.lang.String
getSetting(java.lang.String index, java.lang.String setting)
Returns the string value for the specified index and setting.ImmutableOpenMap<java.lang.String,Settings>
getSettings()
int
hashCode()
java.lang.String[]
indices()
ImmutableOpenMap<java.lang.String,ImmutableOpenMap<java.lang.String,MappingMetadata>>
mappings()
ImmutableOpenMap<java.lang.String,Settings>
settings()
java.lang.String
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.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
Methods inherited from interface org.elasticsearch.common.xcontent.ToXContentObject
isFragment
-
Constructor Details
-
GetIndexResponse
public GetIndexResponse(java.lang.String[] indices, ImmutableOpenMap<java.lang.String,ImmutableOpenMap<java.lang.String,MappingMetadata>> mappings, ImmutableOpenMap<java.lang.String,java.util.List<AliasMetadata>> aliases, ImmutableOpenMap<java.lang.String,Settings> settings, ImmutableOpenMap<java.lang.String,Settings> defaultSettings, ImmutableOpenMap<java.lang.String,java.lang.String> dataStreams)
-
-
Method Details
-
indices
public java.lang.String[] indices() -
getIndices
public java.lang.String[] getIndices() -
mappings
public ImmutableOpenMap<java.lang.String,ImmutableOpenMap<java.lang.String,MappingMetadata>> mappings() -
getMappings
public ImmutableOpenMap<java.lang.String,ImmutableOpenMap<java.lang.String,MappingMetadata>> getMappings() -
aliases
-
getAliases
-
settings
-
dataStreams
-
getDataStreams
-
defaultSettings
If the originatingGetIndexRequest
object was configured to include defaults, this will contain a mapping of index name toSettings
objects. The returnedSettings
objects 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
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 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
Description copied from interface:Writeable
Write this into the StreamOutput. -
toXContent
public org.elasticsearch.common.xcontent.XContentBuilder toXContent(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params) throws java.io.IOException- Specified by:
toXContent
in interfaceorg.elasticsearch.common.xcontent.ToXContent
- Throws:
java.io.IOException
-
fromXContent
public static GetIndexResponse fromXContent(org.elasticsearch.common.xcontent.XContentParser parser) throws java.io.IOException- Throws:
java.io.IOException
-
toString
public java.lang.String toString()- Overrides:
toString
in classjava.lang.Object
-
equals
public boolean equals(java.lang.Object o)- Overrides:
equals
in classjava.lang.Object
-
hashCode
public int hashCode()- Overrides:
hashCode
in classjava.lang.Object
-