Class GetApiKeyRequest
java.lang.Object
co.elastic.clients.elasticsearch._types.RequestBase
co.elastic.clients.elasticsearch.security.GetApiKeyRequest
Retrieves information for one or more API keys.
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from class co.elastic.clients.elasticsearch._types.RequestBase
RequestBase.AbstractBuilder<BuilderT extends RequestBase.AbstractBuilder<BuilderT>>
-
Field Summary
Modifier and TypeFieldDescriptionstatic final Endpoint<GetApiKeyRequest,
GetApiKeyResponse, ErrorResponse> Endpoint "security.get_api_key
". -
Method Summary
Modifier and TypeMethodDescriptionfinal String
id()
API key id of the API key to be retrievedfinal String
name()
API key name of the API key to be retrievedstatic GetApiKeyRequest
final Boolean
owner()
flag to query API keys owned by the currently authenticated userfinal String
realm name of the user who created this API key to be retrievedfinal String
username()
user name of the user who created this API key to be retrievedMethods inherited from class co.elastic.clients.elasticsearch._types.RequestBase
toString
-
Field Details
-
_ENDPOINT
Endpoint "security.get_api_key
".
-
-
Method Details
-
of
public static GetApiKeyRequest of(Function<GetApiKeyRequest.Builder, ObjectBuilder<GetApiKeyRequest>> fn) -
id
API key id of the API key to be retrievedAPI name:
id
-
name
API key name of the API key to be retrievedAPI name:
name
-
owner
flag to query API keys owned by the currently authenticated userAPI name:
owner
-
realmName
realm name of the user who created this API key to be retrievedAPI name:
realm_name
-
username
user name of the user who created this API key to be retrievedAPI name:
username
-