Class GetApiKeyRequest
java.lang.Object
co.elastic.clients.elasticsearch._types.RequestBase
co.elastic.clients.elasticsearch.security.GetApiKeyRequest
public class GetApiKeyRequest extends RequestBase
Retrieves information for one or more API keys.
- See Also:
- API specification
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
GetApiKeyRequest.Builder
Builder forGetApiKeyRequest
.Nested classes/interfaces inherited from class co.elastic.clients.elasticsearch._types.RequestBase
RequestBase.AbstractBuilder<BuilderT extends RequestBase.AbstractBuilder<BuilderT>>
-
Field Summary
Fields Modifier and Type Field Description static Endpoint<GetApiKeyRequest,GetApiKeyResponse,ErrorResponse>
_ENDPOINT
Endpoint "security.get_api_key
". -
Method Summary
Modifier and Type Method Description java.lang.String
id()
API key id of the API key to be retrievedjava.lang.String
name()
API key name of the API key to be retrievedstatic GetApiKeyRequest
of(java.util.function.Function<GetApiKeyRequest.Builder,ObjectBuilder<GetApiKeyRequest>> fn)
java.lang.Boolean
owner()
flag to query API keys owned by the currently authenticated userjava.lang.String
realmName()
realm name of the user who created this API key to be retrievedjava.lang.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
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
-
Field Details
-
_ENDPOINT
Endpoint "security.get_api_key
".
-
-
Method Details
-
of
public static GetApiKeyRequest of(java.util.function.Function<GetApiKeyRequest.Builder,ObjectBuilder<GetApiKeyRequest>> fn) -
id
@Nullable public final java.lang.String id()API key id of the API key to be retrievedAPI name:
id
-
name
@Nullable public final java.lang.String name()API key name of the API key to be retrievedAPI name:
name
-
owner
@Nullable public final java.lang.Boolean owner()flag to query API keys owned by the currently authenticated userAPI name:
owner
-
realmName
@Nullable public final java.lang.String realmName()realm name of the user who created this API key to be retrievedAPI name:
realm_name
-
username
@Nullable public final java.lang.String username()user name of the user who created this API key to be retrievedAPI name:
username
-