Package co.elastic.clients.elasticsearch.security

Class CreateApiKeyResponse

java.lang.Object

co.elastic.clients.elasticsearch.security.CreateApiKeyResponse

All Implemented Interfaces:

JsonpSerializable

@JsonpDeserializable
public class CreateApiKeyResponse
extends Object
implements JsonpSerializable

See Also:

• API specification

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field	Description
static final JsonpDeserializer<CreateApiKeyResponse>	_DESERIALIZER	Json deserializer for CreateApiKeyResponse

Method Summary

Modifier and Type	Method	Description
final String	apiKey()	Required - Generated API key.
final String	encoded()	Required - API key credentials which is the base64-encoding of the UTF-8 representation of id and api_key joined by a colon (:).
final Long	expiration()	Expiration in milliseconds for the API key.
final String	id()	Required - Unique ID for this API key.
final String	name()	Required - Specifies the name for this API key.
static CreateApiKeyResponse	of(Function<CreateApiKeyResponse.Builder,ObjectBuilder<CreateApiKeyResponse>> 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	setupCreateApiKeyResponseDeserializer(ObjectDeserializer<CreateApiKeyResponse.Builder> op)
String	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<CreateApiKeyResponse> _DESERIALIZER

Json deserializer for CreateApiKeyResponse

Method Details

of

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

apiKey

public final String apiKey()

Required - Generated API key.

API name: api_key

expiration

@Nullable
public final Long expiration()

Expiration in milliseconds for the API key.

API name: expiration

id

public final String id()

Required - Unique ID for this API key.

API name: id

name

public final String name()

Required - Specifies the name for this API key.

API name: name

encoded

public final String encoded()

Required - API key credentials which is the base64-encoding of the UTF-8 representation of id and api_key joined by a colon (:).

API name: encoded

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)

toString

public String toString()

Overrides:

toString in class Object

setupCreateApiKeyResponseDeserializer

protected static void setupCreateApiKeyResponseDeserializer(ObjectDeserializer<CreateApiKeyResponse.Builder> op)