ApiKey (java-client 7.15.1 API)

java.lang.Object

co.elastic.clients.elasticsearch.security.grant_api_key.ApiKey

All Implemented Interfaces:: JsonpSerializable

@JsonpDeserializable
public final class ApiKey
extends java.lang.Object
implements JsonpSerializable

Nested Class Summary

Nested Classes

Modifier and Type Class Description

static class ApiKey.Builder
Builder for ApiKey.
Field Summary

Fields

Modifier and Type Field Description

static JsonpDeserializer<ApiKey> _DESERIALIZER
Json deserializer for ApiKey
Constructor Summary

Constructors

Constructor Description

ApiKey(ApiKey.Builder builder)

ApiKey(java.util.function.Function<ApiKey.Builder,ApiKey.Builder> fn)

Method Summary

Modifier and Type	Method	Description
`java.lang.String`	`expiration()`	API name: `expiration`
`java.lang.String`	`name()`	Required - API name: `name`
`java.util.List<java.util.Map<java.lang.String,JsonData>>`	`roleDescriptors()`	API name: `role_descriptors`
`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`	`setupApiKeyDeserializer(DelegatingDeserializer<ApiKey.Builder> op)`

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details
- _DESERIALIZER
  
  public static final JsonpDeserializer<ApiKey> _DESERIALIZER
  
  Json deserializer for ApiKey
Constructor Details
- ApiKey
  
  public ApiKey(ApiKey.Builder builder)
- ApiKey
  
  public ApiKey(java.util.function.Function<ApiKey.Builder,ApiKey.Builder> fn)
Method Details
- name
  
  public java.lang.String name()
  
  Required - API name: name
- expiration
  
  @Nullable public java.lang.String expiration()
  
  API name: expiration
- roleDescriptors
  
  @Nullable public java.util.List<java.util.Map<java.lang.String,JsonData>> roleDescriptors()
  
  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)
- setupApiKeyDeserializer
  
  protected static void setupApiKeyDeserializer(DelegatingDeserializer<ApiKey.Builder> op)