Class InvalidateApiKeyRequest
- java.lang.Object
-
- org.elasticsearch.client.security.InvalidateApiKeyRequest
-
- All Implemented Interfaces:
Validatable
,ToXContent
,ToXContentObject
public final class InvalidateApiKeyRequest extends java.lang.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 java.lang.String
getId()
java.lang.String
getName()
java.lang.String
getRealmName()
java.lang.String
getUserName()
XContentBuilder
toXContent(XContentBuilder builder, ToXContent.Params params)
static InvalidateApiKeyRequest
usingApiKeyId(java.lang.String apiKeyId)
Creates invalidate API key request for given api key idstatic InvalidateApiKeyRequest
usingApiKeyName(java.lang.String apiKeyName)
Creates invalidate API key request for given api key namestatic InvalidateApiKeyRequest
usingRealmAndUserName(java.lang.String realmName, java.lang.String userName)
Creates invalidate API key request for given realm and user namestatic InvalidateApiKeyRequest
usingRealmName(java.lang.String realmName)
Creates invalidate API key request for given realm namestatic InvalidateApiKeyRequest
usingUserName(java.lang.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 java.lang.String getRealmName()
-
getUserName
public java.lang.String getUserName()
-
getId
public java.lang.String getId()
-
getName
public java.lang.String getName()
-
usingRealmName
public static InvalidateApiKeyRequest usingRealmName(java.lang.String realmName)
Creates invalidate API key request for given realm name- Parameters:
realmName
- realm name- Returns:
InvalidateApiKeyRequest
-
usingUserName
public static InvalidateApiKeyRequest usingUserName(java.lang.String userName)
Creates invalidate API key request for given user name- Parameters:
userName
- user name- Returns:
InvalidateApiKeyRequest
-
usingRealmAndUserName
public static InvalidateApiKeyRequest usingRealmAndUserName(java.lang.String realmName, java.lang.String userName)
Creates invalidate API key request for given realm and user name- Parameters:
realmName
- realm nameuserName
- user name- Returns:
InvalidateApiKeyRequest
-
usingApiKeyId
public static InvalidateApiKeyRequest usingApiKeyId(java.lang.String apiKeyId)
Creates invalidate API key request for given api key id- Parameters:
apiKeyId
- api key id- Returns:
InvalidateApiKeyRequest
-
usingApiKeyName
public static InvalidateApiKeyRequest usingApiKeyName(java.lang.String apiKeyName)
Creates invalidate API key request for given api key name- Parameters:
apiKeyName
- api key name- Returns:
InvalidateApiKeyRequest
-
toXContent
public XContentBuilder toXContent(XContentBuilder builder, ToXContent.Params params) throws java.io.IOException
- Specified by:
toXContent
in interfaceToXContent
- Throws:
java.io.IOException
-
-