Module org.elasticsearch.xcore

Package org.elasticsearch.xpack.core.security.action.apikey

Class InvalidateApiKeyResponse

java.lang.Object

org.elasticsearch.transport.TransportMessage

org.elasticsearch.transport.TransportResponse

org.elasticsearch.action.ActionResponse

org.elasticsearch.xpack.core.security.action.apikey.InvalidateApiKeyResponse

All Implemented Interfaces:

Writeable, RefCounted, ToXContent, ToXContentObject

public final class InvalidateApiKeyResponse
extends ActionResponse
implements ToXContentObject, Writeable

Response for invalidation of one or more API keys result.
The result contains information about:

• API key ids that were actually invalidated
• API key ids that were not invalidated in this request because they were already invalidated
• how many errors were encountered while invalidating API keys and the error details

Nested Class Summary

Nested classes/interfaces inherited from class org.elasticsearch.action.ActionResponse

ActionResponse.Empty

Nested classes/interfaces inherited from interface org.elasticsearch.xcontent.ToXContent

ToXContent.DelegatingMapParams, ToXContent.MapParams, 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.core.RefCounted

ALWAYS_REFERENCED

Fields inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY, EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
InvalidateApiKeyResponse(List<String> invalidatedApiKeys, List<String> previouslyInvalidatedApiKeys, List<ElasticsearchException> errors)	Constructor for API keys invalidation response
InvalidateApiKeyResponse(StreamInput in)

Method Summary

Modifier and Type	Method	Description
static InvalidateApiKeyResponse	emptyResponse()
static InvalidateApiKeyResponse	fromXContent(XContentParser parser)
List<ElasticsearchException>	getErrors()
List<String>	getInvalidatedApiKeys()
List<String>	getPreviouslyInvalidatedApiKeys()
String	toString()
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
void	writeTo(StreamOutput out)

Methods inherited from class org.elasticsearch.transport.TransportMessage

decRef, hasReferences, incRef, tryIncRef

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.elasticsearch.core.RefCounted

mustIncRef

Methods inherited from interface org.elasticsearch.xcontent.ToXContentObject

isFragment

Constructor Details

InvalidateApiKeyResponse

public InvalidateApiKeyResponse(StreamInput in)
                         throws IOException

Throws:

IOException

InvalidateApiKeyResponse

public InvalidateApiKeyResponse(List<String> invalidatedApiKeys,
 List<String> previouslyInvalidatedApiKeys,
 @Nullable
 List<ElasticsearchException> errors)

Constructor for API keys invalidation response

Parameters:

invalidatedApiKeys - list of invalidated API key ids

previouslyInvalidatedApiKeys - list of previously invalidated API key ids

errors - list of encountered errors while invalidating API keys

Method Details

emptyResponse

public static InvalidateApiKeyResponse emptyResponse()

getInvalidatedApiKeys

public List<String> getInvalidatedApiKeys()

getPreviouslyInvalidatedApiKeys

public List<String> getPreviouslyInvalidatedApiKeys()

getErrors

public List<ElasticsearchException> getErrors()

toXContent

public XContentBuilder toXContent(XContentBuilder builder,
 ToXContent.Params params)
                           throws IOException

Specified by:

toXContent in interface ToXContent

Throws:

IOException

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Specified by:

writeTo in interface Writeable

Throws:

IOException

fromXContent

public static InvalidateApiKeyResponse fromXContent(XContentParser parser)
                                             throws IOException

Throws:

IOException

toString

public String toString()

Overrides:

toString in class Object