Package co.elastic.clients.elasticsearch.security

Class CreateCrossClusterApiKeyRequest

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.security.CreateCrossClusterApiKeyRequest

All Implemented Interfaces:

JsonpSerializable

@JsonpDeserializable
public class CreateCrossClusterApiKeyRequest
extends RequestBase
implements JsonpSerializable

Create a cross-cluster API key.

Create an API key of the cross_cluster type for the API key based remote cluster access. A cross_cluster API key cannot be used to authenticate through the REST interface.

IMPORTANT: To authenticate this request you must use a credential that is not an API key. Even if you use an API key that has the required privilege, the API returns an error.

Cross-cluster API keys are created by the Elasticsearch API key service, which is automatically enabled.

NOTE: Unlike REST API keys, a cross-cluster API key does not capture permissions of the authenticated user. The API key’s effective permission is exactly as specified with the access property.

A successful request returns a JSON structure that contains the API key, its unique ID, and its name. If applicable, it also returns expiration information for the API key in milliseconds.

By default, API keys never expire. You can specify expiration information when you create the API keys.

Cross-cluster API keys can only be updated with the update cross-cluster API key API. Attempting to update them with the update REST API key API or the bulk update REST API keys API will result in an error.

See Also:

• API specification

Nested Class Summary

Nested Classes

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

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<CreateCrossClusterApiKeyRequest>	_DESERIALIZER	Json deserializer for CreateCrossClusterApiKeyRequest
static final Endpoint<CreateCrossClusterApiKeyRequest,CreateCrossClusterApiKeyResponse,ErrorResponse>	_ENDPOINT	Endpoint "security.create_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()	Expiration time for the API key.
final Map<String,JsonData>	metadata()	Arbitrary metadata that you want to associate with the API key.
final String	name()	Required - Specifies the name for this API key.
static CreateCrossClusterApiKeyRequest	of(Function<CreateCrossClusterApiKeyRequest.Builder,ObjectBuilder<CreateCrossClusterApiKeyRequest>> 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	setupCreateCrossClusterApiKeyRequestDeserializer(ObjectDeserializer<CreateCrossClusterApiKeyRequest.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<CreateCrossClusterApiKeyRequest> _DESERIALIZER

Json deserializer for CreateCrossClusterApiKeyRequest

_ENDPOINT

public static final Endpoint<CreateCrossClusterApiKeyRequest,CreateCrossClusterApiKeyResponse,ErrorResponse> _ENDPOINT

Endpoint "security.create_cross_cluster_api_key".

Method Details

of

public static CreateCrossClusterApiKeyRequest of(Function<CreateCrossClusterApiKeyRequest.Builder,ObjectBuilder<CreateCrossClusterApiKeyRequest>> 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.

NOTE: No explicit privileges should be specified for either search or replication access. The creation process automatically converts the access specification to a role descriptor which has relevant privileges assigned accordingly.

API name: access

expiration

@Nullable
public final Time expiration()

Expiration time for the API key. By default, API keys never expire.

API name: expiration

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.

API name: metadata

name

public final String name()

Required - Specifies the name for this API key.

API name: name

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)

setupCreateCrossClusterApiKeyRequestDeserializer

protected static void setupCreateCrossClusterApiKeyRequestDeserializer(ObjectDeserializer<CreateCrossClusterApiKeyRequest.Builder> op)