Class InvalidateApiKeyRequest
java.lang.Object
org.elasticsearch.client.security.InvalidateApiKeyRequest
- All Implemented Interfaces:
Validatable
,org.elasticsearch.xcontent.ToXContent
,org.elasticsearch.xcontent.ToXContentObject
public final class InvalidateApiKeyRequest
extends Object
implements Validatable, org.elasticsearch.xcontent.ToXContentObject
Request for invalidating API key(s) so that it can no longer be used
-
Nested Class Summary
Nested classes/interfaces inherited from interface org.elasticsearch.xcontent.ToXContent
org.elasticsearch.xcontent.ToXContent.DelegatingMapParams, org.elasticsearch.xcontent.ToXContent.MapParams, org.elasticsearch.xcontent.ToXContent.Params
-
Field Summary
Fields inherited from interface org.elasticsearch.xcontent.ToXContent
EMPTY_PARAMS
Fields inherited from interface org.elasticsearch.client.Validatable
EMPTY
-
Method Summary
Modifier and TypeMethodDescriptionstatic InvalidateApiKeyRequest
Creates invalidate api key request to invalidate api keys owned by the current authenticated user.getId()
Deprecated.getIds()
getName()
boolean
org.elasticsearch.xcontent.XContentBuilder
toXContent
(org.elasticsearch.xcontent.XContentBuilder builder, org.elasticsearch.xcontent.ToXContent.Params params) static InvalidateApiKeyRequest
usingApiKeyId
(String apiKeyId, boolean ownedByAuthenticatedUser) Creates invalidate API key request for given api key idstatic InvalidateApiKeyRequest
usingApiKeyIds
(List<String> apiKeyIds, boolean ownedByAuthenticatedUser) Creates invalidate API key request for given api key idsstatic InvalidateApiKeyRequest
usingApiKeyName
(String apiKeyName, boolean ownedByAuthenticatedUser) Creates invalidate API key request for given api key namestatic InvalidateApiKeyRequest
usingRealmAndUserName
(String realmName, String userName) Creates invalidate API key request for given realm and user namestatic InvalidateApiKeyRequest
usingRealmName
(String realmName) Creates invalidate API key request for given realm namestatic InvalidateApiKeyRequest
usingUserName
(String userName) Creates invalidate API key request for given user nameMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface org.elasticsearch.xcontent.ToXContentObject
isFragment
Methods inherited from interface org.elasticsearch.client.Validatable
validate
-
Method Details
-
getRealmName
-
getUserName
-
getId
Deprecated. -
getIds
-
getName
-
ownedByAuthenticatedUser
public boolean ownedByAuthenticatedUser() -
usingRealmName
Creates invalidate API key request for given realm name- Parameters:
realmName
- realm name- Returns:
InvalidateApiKeyRequest
-
usingUserName
Creates invalidate API key request for given user name- Parameters:
userName
- user name- Returns:
InvalidateApiKeyRequest
-
usingRealmAndUserName
Creates invalidate API key request for given realm and user name- Parameters:
realmName
- realm nameuserName
- user name- Returns:
InvalidateApiKeyRequest
-
usingApiKeyId
public static InvalidateApiKeyRequest usingApiKeyId(String apiKeyId, boolean ownedByAuthenticatedUser) Creates invalidate API key request for given api key id- Parameters:
apiKeyId
- api key idownedByAuthenticatedUser
- settrue
if the request is only for the API keys owned by current authenticated user elsefalse
- Returns:
InvalidateApiKeyRequest
-
usingApiKeyIds
public static InvalidateApiKeyRequest usingApiKeyIds(List<String> apiKeyIds, boolean ownedByAuthenticatedUser) Creates invalidate API key request for given api key ids- Parameters:
apiKeyIds
- api key idsownedByAuthenticatedUser
- settrue
if the request is only for the API keys owned by current authenticated user elsefalse
- Returns:
InvalidateApiKeyRequest
-
usingApiKeyName
public static InvalidateApiKeyRequest usingApiKeyName(String apiKeyName, boolean ownedByAuthenticatedUser) Creates invalidate API key request for given api key name- Parameters:
apiKeyName
- api key nameownedByAuthenticatedUser
- settrue
if the request is only for the API keys owned by current authenticated user elsefalse
- Returns:
InvalidateApiKeyRequest
-
forOwnedApiKeys
Creates invalidate api key request to invalidate api keys owned by the current authenticated user. -
toXContent
public org.elasticsearch.xcontent.XContentBuilder toXContent(org.elasticsearch.xcontent.XContentBuilder builder, org.elasticsearch.xcontent.ToXContent.Params params) throws IOException - Specified by:
toXContent
in interfaceorg.elasticsearch.xcontent.ToXContent
- Throws:
IOException
-