Module org.elasticsearch.xcore
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,org.elasticsearch.core.RefCounted,org.elasticsearch.xcontent.ToXContent,org.elasticsearch.xcontent.ToXContentObject
public final class InvalidateApiKeyResponse
extends ActionResponse
implements org.elasticsearch.xcontent.ToXContentObject, Writeable
Response for invalidation of one or more API keys result.
The result contains information about:
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.EmptyNested classes/interfaces inherited from interface org.elasticsearch.xcontent.ToXContent
org.elasticsearch.xcontent.ToXContent.DelegatingMapParams, org.elasticsearch.xcontent.ToXContent.MapParams, org.elasticsearch.xcontent.ToXContent.ParamsNested 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_REFERENCEDFields inherited from interface org.elasticsearch.xcontent.ToXContent
EMPTY, EMPTY_PARAMS -
Constructor Summary
ConstructorsConstructorDescriptionInvalidateApiKeyResponse(List<String> invalidatedApiKeys, List<String> previouslyInvalidatedApiKeys, List<ElasticsearchException> errors) Constructor for API keys invalidation response -
Method Summary
Modifier and TypeMethodDescriptionstatic InvalidateApiKeyResponsestatic InvalidateApiKeyResponsefromXContent(org.elasticsearch.xcontent.XContentParser parser) toString()org.elasticsearch.xcontent.XContentBuildertoXContent(org.elasticsearch.xcontent.XContentBuilder builder, org.elasticsearch.xcontent.ToXContent.Params params) voidwriteTo(StreamOutput out) Methods inherited from class org.elasticsearch.transport.TransportMessage
decRef, hasReferences, incRef, tryIncRefMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitMethods inherited from interface org.elasticsearch.core.RefCounted
mustIncRefMethods inherited from interface org.elasticsearch.xcontent.ToXContentObject
isFragment
-
Constructor Details
-
InvalidateApiKeyResponse
- 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 idspreviouslyInvalidatedApiKeys- list of previously invalidated API key idserrors- list of encountered errors while invalidating API keys
-
-
Method Details
-
emptyResponse
-
getInvalidatedApiKeys
-
getPreviouslyInvalidatedApiKeys
-
getErrors
-
toXContent
public org.elasticsearch.xcontent.XContentBuilder toXContent(org.elasticsearch.xcontent.XContentBuilder builder, org.elasticsearch.xcontent.ToXContent.Params params) throws IOException - Specified by:
toXContentin interfaceorg.elasticsearch.xcontent.ToXContent- Throws:
IOException
-
writeTo
- Specified by:
writeToin interfaceWriteable- Throws:
IOException
-
fromXContent
public static InvalidateApiKeyResponse fromXContent(org.elasticsearch.xcontent.XContentParser parser) throws IOException - Throws:
IOException
-
toString
-