Package co.elastic.clients.elasticsearch.security

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 for GetApiKeyRequest.

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 final Endpoint<GetApiKeyRequest,GetApiKeyResponse,ErrorResponse>	_ENDPOINT	Endpoint "security.get_api_key".

Method Summary

Modifier and Type	Method	Description
final String	id()	API key id of the API key to be retrieved
final String	name()	API key name of the API key to be retrieved
static GetApiKeyRequest	of(Function<GetApiKeyRequest.Builder,ObjectBuilder<GetApiKeyRequest>> fn)
final Boolean	owner()	flag to query API keys owned by the currently authenticated user
final String	realmName()	realm name of the user who created this API key to be retrieved
final String	username()	user name of the user who created this API key to be retrieved
final Boolean	withLimitedBy()	Return the snapshot of the owner user's role descriptors associated with the API key.

Methods 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

public static final Endpoint<GetApiKeyRequest,GetApiKeyResponse,ErrorResponse> _ENDPOINT

Endpoint "security.get_api_key".

Method Details

of

public static GetApiKeyRequest of(Function<GetApiKeyRequest.Builder,ObjectBuilder<GetApiKeyRequest>> fn)

id

@Nullable
public final String id()

API key id of the API key to be retrieved

API name: id

name

@Nullable
public final String name()

API key name of the API key to be retrieved

API name: name

owner

@Nullable
public final Boolean owner()

flag to query API keys owned by the currently authenticated user

API name: owner

realmName

@Nullable
public final String realmName()

realm name of the user who created this API key to be retrieved

API name: realm_name

username

@Nullable
public final String username()

user name of the user who created this API key to be retrieved

API name: username

withLimitedBy

@Nullable
public final Boolean withLimitedBy()

Return the snapshot of the owner user's role descriptors associated with the API key. An API key's actual permission is the intersection of its assigned role descriptors and the owner user's role descriptors.

API name: with_limited_by