Package co.elastic.clients.elasticsearch.security

Class UpdateApiKeyRequest

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.security.UpdateApiKeyRequest

All Implemented Interfaces:

JsonpSerializable

@JsonpDeserializable
public class UpdateApiKeyRequest
extends RequestBase
implements JsonpSerializable

Updates attributes of an existing API key.

See Also:

API specification

Nested Class Summary

Nested Classes

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

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 JsonpDeserializer<UpdateApiKeyRequest>	_DESERIALIZER	Json deserializer for UpdateApiKeyRequest
static Endpoint<UpdateApiKeyRequest,UpdateApiKeyResponse,ErrorResponse>	_ENDPOINT	Endpoint "security.update_api_key".

Method Summary

Modifier and Type	Method	Description
java.lang.String	id()	Required - The ID of the API key to update.
java.util.Map<java.lang.String,JsonData>	metadata()	Arbitrary metadata that you want to associate with the API key.
static UpdateApiKeyRequest	of(java.util.function.Function<UpdateApiKeyRequest.Builder,ObjectBuilder<UpdateApiKeyRequest>> fn)
java.util.Map<java.lang.String,RoleDescriptor>	roleDescriptors()	An array of role descriptors for this API key.
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	setupUpdateApiKeyRequestDeserializer(ObjectDeserializer<UpdateApiKeyRequest.Builder> op)

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<UpdateApiKeyRequest> _DESERIALIZER

Json deserializer for UpdateApiKeyRequest

_ENDPOINT

public static final Endpoint<UpdateApiKeyRequest,UpdateApiKeyResponse,ErrorResponse> _ENDPOINT

Endpoint "security.update_api_key".

Method Details

of

public static UpdateApiKeyRequest of(java.util.function.Function<UpdateApiKeyRequest.Builder,ObjectBuilder<UpdateApiKeyRequest>> fn)

id

public final java.lang.String id()

Required - The ID of the API key to update.

API name: id

metadata

public final java.util.Map<java.lang.String,JsonData> metadata()

Arbitrary metadata that you want to associate with the API key. It supports nested data structure. Within the metadata object, keys beginning with _ are reserved for system usage.

API name: metadata

roleDescriptors

public final java.util.Map<java.lang.String,RoleDescriptor> roleDescriptors()

An array of role descriptors for this API key. This parameter is optional. When it is not specified or is an empty array, then the API key will have a point in time snapshot of permissions of the authenticated user. If you supply role descriptors then the resultant permissions would be an intersection of API keys permissions and authenticated user’s permissions thereby limiting the access scope for API keys. The structure of role descriptor is the same as the request for create role API. For more details, see create or update roles API.

API name: role_descriptors

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)

setupUpdateApiKeyRequestDeserializer

protected static void setupUpdateApiKeyRequestDeserializer(ObjectDeserializer<UpdateApiKeyRequest.Builder> op)