Package co.elastic.clients.elasticsearch.security

Class UpdateCrossClusterApiKeyRequest

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.security.UpdateCrossClusterApiKeyRequest

All Implemented Interfaces:

JsonpSerializable

@JsonpDeserializable
public class UpdateCrossClusterApiKeyRequest
extends RequestBase
implements JsonpSerializable

Update a cross-cluster API key.

Update the attributes of an existing cross-cluster API key, which is used for API key based remote cluster access.

To use this API, you must have at least the manage_security cluster privilege. Users can only update API keys that they created. To update another user's API key, use the run_as feature to submit a request on behalf of another user.

IMPORTANT: It's not possible to use an API key as the authentication credential for this API. To update an API key, the owner user's credentials are required.

It's not possible to update expired API keys, or API keys that have been invalidated by the invalidate API key API.

This API supports updates to an API key's access scope, metadata, and expiration. The owner user's information, such as the username and realm, is also updated automatically on every call.

NOTE: This API cannot update REST API keys, which should be updated by either the update API key or bulk update API keys API.

See Also:

• API specification

Nested Class Summary

Nested Classes

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

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<UpdateCrossClusterApiKeyRequest>	_DESERIALIZER	Json deserializer for UpdateCrossClusterApiKeyRequest
static final Endpoint<UpdateCrossClusterApiKeyRequest,UpdateCrossClusterApiKeyResponse,ErrorResponse>	_ENDPOINT	Endpoint "security.update_cross_cluster_api_key".

Method Summary

Modifier and Type	Method	Description
final Access	access()	Required - The access to be granted to this API key.
final Time	expiration()	The expiration time for the API key.
final String	id()	Required - The ID of the cross-cluster API key to update.
final Map<String,JsonData>	metadata()	Arbitrary metadata that you want to associate with the API key.
static UpdateCrossClusterApiKeyRequest	of(Function<UpdateCrossClusterApiKeyRequest.Builder,ObjectBuilder<UpdateCrossClusterApiKeyRequest>> fn)
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	setupUpdateCrossClusterApiKeyRequestDeserializer(ObjectDeserializer<UpdateCrossClusterApiKeyRequest.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<UpdateCrossClusterApiKeyRequest> _DESERIALIZER

Json deserializer for UpdateCrossClusterApiKeyRequest

_ENDPOINT

public static final Endpoint<UpdateCrossClusterApiKeyRequest,UpdateCrossClusterApiKeyResponse,ErrorResponse> _ENDPOINT

Endpoint "security.update_cross_cluster_api_key".

Method Details

of

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

access

public final Access access()

Required - The access to be granted to this API key. The access is composed of permissions for cross cluster search and cross cluster replication. At least one of them must be specified. When specified, the new access assignment fully replaces the previously assigned access.

API name: access

expiration

@Nullable
public final Time expiration()

The expiration time for the API key. By default, API keys never expire. This property can be omitted to leave the value unchanged.

API name: expiration

id

public final String id()

Required - The ID of the cross-cluster API key to update.

API name: id

metadata

public final Map<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. When specified, this information fully replaces metadata previously associated with the API key.

API name: metadata

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)

setupUpdateCrossClusterApiKeyRequestDeserializer

protected static void setupUpdateCrossClusterApiKeyRequestDeserializer(ObjectDeserializer<UpdateCrossClusterApiKeyRequest.Builder> op)