Class CreateApiKeyRequest
java.lang.Object
co.elastic.clients.elasticsearch._types.RequestBase
co.elastic.clients.elasticsearch.security.CreateApiKeyRequest
- All Implemented Interfaces:
JsonpSerializable
@JsonpDeserializable
public class CreateApiKeyRequest
extends RequestBase
implements JsonpSerializable
Creates an API key for access without requiring basic authentication.
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from class co.elastic.clients.elasticsearch._types.RequestBase
RequestBase.AbstractBuilder<BuilderT extends RequestBase.AbstractBuilder<BuilderT>>
-
Field Summary
Modifier and TypeFieldDescriptionstatic final JsonpDeserializer<CreateApiKeyRequest>
Json deserializer forCreateApiKeyRequest
static final Endpoint<CreateApiKeyRequest,
CreateApiKeyResponse, ErrorResponse> Endpoint "security.create_api_key
". -
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()
Specifies the name for this API key.static CreateApiKeyRequest
final Refresh
refresh()
Iftrue
(the default) then refresh the affected shards to make this operation visible to search, ifwait_for
then wait for a refresh to make this operation visible to search, iffalse
then do nothing with refreshes.final Map<String,
RoleDescriptor> An array of 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
Methods inherited from class co.elastic.clients.elasticsearch._types.RequestBase
toString
-
Field Details
-
_DESERIALIZER
Json deserializer forCreateApiKeyRequest
-
_ENDPOINT
Endpoint "security.create_api_key
".
-
-
Method Details
-
of
public static CreateApiKeyRequest of(Function<CreateApiKeyRequest.Builder, ObjectBuilder<CreateApiKeyRequest>> fn) -
expiration
Expiration time for the API key. By default, API keys never expire.API name:
expiration
-
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
Specifies the name for this API key.API name:
name
-
refresh
Iftrue
(the default) then refresh the affected shards to make this operation visible to search, ifwait_for
then wait for a refresh to make this operation visible to search, iffalse
then do nothing with refreshes.API name:
refresh
-
roleDescriptors
An array of role descriptors for this API key. This parameter is optional. When it is not specified or is an empty array, then the API key will have a point in time snapshot of permissions of the authenticated user. If you supply role descriptors then the resultant permissions would be an intersection of API keys permissions and authenticated user’s permissions thereby limiting the access scope for API keys. The structure of role descriptor is the same as the request for create role API. For more details, see create or update roles API.API name:
role_descriptors
-
serialize
Serialize this object to JSON.- Specified by:
serialize
in interfaceJsonpSerializable
-
serializeInternal
-
setupCreateApiKeyRequestDeserializer
protected static void setupCreateApiKeyRequestDeserializer(ObjectDeserializer<CreateApiKeyRequest.Builder> op)
-