Class GrantApiKey
java.lang.Object
co.elastic.clients.elasticsearch.security.grant_api_key.GrantApiKey
- All Implemented Interfaces:
JsonpSerializable
- See Also:
-
Nested Class Summary
-
Field Summary
Modifier and TypeFieldDescriptionstatic final JsonpDeserializer<GrantApiKey>
Json deserializer forGrantApiKey
-
Method Summary
Modifier and TypeMethodDescriptionfinal Time
Expiration time for the API key.metadata()
Arbitrary metadata that you want to associate with the API key.final String
name()
Required - API name:name
static GrantApiKey
final List<Map<String,
RoleDescriptor>> The role descriptors for this API key.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
toString()
-
Field Details
-
_DESERIALIZER
Json deserializer forGrantApiKey
-
-
Method Details
-
of
-
name
Required - API name:name
-
expiration
Expiration time for the API key. By default, API keys never expire.API name:
expiration
-
roleDescriptors
The role descriptors for this API key. This parameter is optional. When it is not specified or is an empty array, the API key has a point in time snapshot of permissions of the specified user or access token. If you supply role descriptors, the resultant permissions are an intersection of API keys permissions and the permissions of the user or access token.API name:
role_descriptors
-
metadata
Arbitrary metadata that you want to associate with the API key. It supports nested data structure. Within themetadata
object, keys beginning with_
are reserved for system usage.API name:
metadata
-
serialize
Serialize this object to JSON.- Specified by:
serialize
in interfaceJsonpSerializable
-
serializeInternal
-
toString
-
setupGrantApiKeyDeserializer
-