Package co.elastic.clients.elasticsearch.security

Class GrantApiKeyRequest

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.security.GrantApiKeyRequest

All Implemented Interfaces:

JsonpSerializable

@JsonpDeserializable
public class GrantApiKeyRequest
extends RequestBase
implements JsonpSerializable

Creates an API key on behalf of another user.

See Also:

• API specification

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	GrantApiKeyRequest.Builder	Builder for GrantApiKeyRequest.

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 JsonpDeserializer<GrantApiKeyRequest>	_DESERIALIZER	Json deserializer for GrantApiKeyRequest
static final Endpoint<GrantApiKeyRequest,GrantApiKeyResponse,ErrorResponse>	_ENDPOINT	Endpoint "security.grant_api_key".

Method Summary

Modifier and Type	Method	Description
final String	accessToken()	API name: access_token
final ApiKey	apiKey()	Required - API name: api_key
final ApiKeyGrantType	grantType()	Required - API name: grant_type
static GrantApiKeyRequest	of(Function<GrantApiKeyRequest.Builder,ObjectBuilder<GrantApiKeyRequest>> fn)
final String	password()	API name: password
void	serialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)	Serialize this object to JSON.
protected void	serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
protected static void	setupGrantApiKeyRequestDeserializer(ObjectDeserializer<GrantApiKeyRequest.Builder> op)
final String	username()	API name: username

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

_DESERIALIZER

public static final JsonpDeserializer<GrantApiKeyRequest> _DESERIALIZER

Json deserializer for GrantApiKeyRequest

_ENDPOINT

public static final Endpoint<GrantApiKeyRequest,GrantApiKeyResponse,ErrorResponse> _ENDPOINT

Endpoint "security.grant_api_key".

Method Details

of

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

accessToken

@Nullable
public final String accessToken()

API name: access_token

apiKey

public final ApiKey apiKey()

Required - API name: api_key

grantType

public final ApiKeyGrantType grantType()

Required - API name: grant_type

password

@Nullable
public final String password()

API name: password

username

@Nullable
public final String username()

API name: username

serialize

public void serialize(jakarta.json.stream.JsonGenerator generator,
 JsonpMapper mapper)

Serialize this object to JSON.

Specified by:

serialize in interface JsonpSerializable

serializeInternal

protected void serializeInternal(jakarta.json.stream.JsonGenerator generator,
 JsonpMapper mapper)

setupGrantApiKeyRequestDeserializer

protected static void setupGrantApiKeyRequestDeserializer(ObjectDeserializer<GrantApiKeyRequest.Builder> op)