Package org.elasticsearch.client
Class GetAliasesResponse
java.lang.Object
org.elasticsearch.client.GetAliasesResponse
- All Implemented Interfaces:
org.elasticsearch.common.xcontent.StatusToXContentObject
,org.elasticsearch.common.xcontent.ToXContent
,org.elasticsearch.common.xcontent.ToXContentObject
public class GetAliasesResponse
extends java.lang.Object
implements org.elasticsearch.common.xcontent.StatusToXContentObject
Response obtained from the get aliases API.
The format is pretty horrible as it holds aliases, but at the same time errors can come back through the status and error fields.
Such errors are mostly 404 - NOT FOUND for aliases that were specified but not found. In such case the client won't throw exception
so it allows to retrieve the returned aliases, while at the same time checking if errors were returned.
There's also the case where an exception is returned, like for instance an
IndexNotFoundException
.
We would usually throw such exception, but we configure the client to not throw for 404 to support the case above, hence we also not
throw in case an index is not found, although it is a hard error that doesn't come back with aliases.-
Nested Class Summary
-
Field Summary
-
Method Summary
Modifier and Type Method Description static GetAliasesResponse
fromXContent(org.elasticsearch.common.xcontent.XContentParser parser)
Parse the get aliases responsejava.util.Map<java.lang.String,java.util.Set<org.elasticsearch.cluster.metadata.AliasMetadata>>
getAliases()
Return the requested aliasesjava.lang.String
getError()
Return the possibly returned error, null otherwiseorg.elasticsearch.ElasticsearchException
getException()
Return the exception that may have been returnedorg.elasticsearch.rest.RestStatus
status()
org.elasticsearch.common.xcontent.XContentBuilder
toXContent(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params)
-
Method Details
-
status
public org.elasticsearch.rest.RestStatus status()- Specified by:
status
in interfaceorg.elasticsearch.common.xcontent.StatusToXContentObject
-
getError
public java.lang.String getError()Return the possibly returned error, null otherwise -
getException
public org.elasticsearch.ElasticsearchException getException()Return the exception that may have been returned -
getAliases
public java.util.Map<java.lang.String,java.util.Set<org.elasticsearch.cluster.metadata.AliasMetadata>> getAliases()Return the requested aliases -
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 GetAliasesResponse fromXContent(org.elasticsearch.common.xcontent.XContentParser parser) throws java.io.IOExceptionParse the get aliases response- Throws:
java.io.IOException
-