Package org.elasticsearch.client.security

Class InvalidateApiKeyRequest

java.lang.Object

org.elasticsearch.client.security.InvalidateApiKeyRequest

All Implemented Interfaces:

Validatable, ToXContent, ToXContentObject

public final class InvalidateApiKeyRequest
extends Object
implements Validatable, 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.common.xcontent.ToXContent

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Field Summary

Fields inherited from interface org.elasticsearch.common.xcontent.ToXContent

EMPTY_PARAMS

Fields inherited from interface org.elasticsearch.client.Validatable

EMPTY

Method Summary

Modifier and Type	Method	Description
static InvalidateApiKeyRequest	forOwnedApiKeys()	Creates invalidate api key request to invalidate api keys owned by the current authenticated user.
String	getId()
String	getName()
String	getRealmName()
String	getUserName()
boolean	ownedByAuthenticatedUser()
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
static InvalidateApiKeyRequest	usingApiKeyId(String apiKeyId, boolean ownedByAuthenticatedUser)	Creates invalidate API key request for given api key id
static InvalidateApiKeyRequest	usingApiKeyName(String apiKeyName, boolean ownedByAuthenticatedUser)	Creates invalidate API key request for given api key name
static InvalidateApiKeyRequest	usingRealmAndUserName(String realmName, String userName)	Creates invalidate API key request for given realm and user name
static InvalidateApiKeyRequest	usingRealmName(String realmName)	Creates invalidate API key request for given realm name
static InvalidateApiKeyRequest	usingUserName(String userName)	Creates invalidate API key request for given user name

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.common.xcontent.ToXContentObject

isFragment

Methods inherited from interface org.elasticsearch.client.Validatable

validate

Method Detail

getRealmName

public String getRealmName()

getUserName

public String getUserName()

getId

public String getId()

getName

public String getName()

ownedByAuthenticatedUser

public boolean ownedByAuthenticatedUser()

usingRealmName

public static InvalidateApiKeyRequest usingRealmName(String realmName)

Creates invalidate API key request for given realm name

Parameters:

realmName - realm name

Returns:

InvalidateApiKeyRequest

usingUserName

public static InvalidateApiKeyRequest usingUserName(String userName)

Creates invalidate API key request for given user name

Parameters:

userName - user name

Returns:

InvalidateApiKeyRequest

usingRealmAndUserName

public static InvalidateApiKeyRequest usingRealmAndUserName(String realmName,
                                                            String userName)

Creates invalidate API key request for given realm and user name

Parameters:

realmName - realm name

userName - 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 id

ownedByAuthenticatedUser - set true if the request is only for the API keys owned by current authenticated user else false

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 name

ownedByAuthenticatedUser - set true if the request is only for the API keys owned by current authenticated user else false

Returns:

InvalidateApiKeyRequest

forOwnedApiKeys

public static InvalidateApiKeyRequest forOwnedApiKeys()

Creates invalidate api key request to invalidate api keys owned by the current authenticated user.

toXContent

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

Specified by:

toXContent in interface ToXContent

Throws:

IOException