ApiKey (java-client 7.16.3 API)

java.lang.Object

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

All Implemented Interfaces:: JsonpSerializable

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

See Also:: API specification

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

Method Summary

Modifier and Type	Method	Description
`Time`	`expiration()`	API name: `expiration`
`java.lang.String`	`name()`	Required - API name: `name`
`static ApiKey`	`of(java.util.function.Function<ApiKey.Builder,ObjectBuilder<ApiKey>> fn)`
`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(ObjectDeserializer<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
Method Details
- of
  
  public static ApiKey of(java.util.function.Function<ApiKey.Builder,ObjectBuilder<ApiKey>> fn)
- name
  
  public final java.lang.String name()
  
  Required - API name: name
- expiration
  
  @Nullable public final Time expiration()
  
  API name: expiration
- roleDescriptors
  
  public final 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(ObjectDeserializer<ApiKey.Builder> op)