Package co.elastic.clients.elasticsearch.security

Class CreateServiceTokenRequest

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.security.CreateServiceTokenRequest

public class CreateServiceTokenRequest
extends RequestBase

Create a service account token.

Create a service accounts token for access without requiring basic authentication.

NOTE: Service account tokens never expire. You must actively delete them if they are no longer needed.

See Also:

• API specification

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from class co.elastic.clients.elasticsearch._types.RequestBase

RequestBase.AbstractBuilder<BuilderT extends RequestBase.AbstractBuilder<BuilderT>>

Field Summary

Fields

Modifier and Type	Field	Description
static final Endpoint<CreateServiceTokenRequest,CreateServiceTokenResponse,ErrorResponse>	_ENDPOINT	Endpoint "security.create_service_token".

Method Summary

Modifier and Type	Method	Description
final String	name()	The name for the service account token.
final String	namespace()	Required - The name of the namespace, which is a top-level grouping of service accounts.
static CreateServiceTokenRequest	of(Function<CreateServiceTokenRequest.Builder,ObjectBuilder<CreateServiceTokenRequest>> fn)
final Refresh	refresh()	If true then refresh the affected shards to make this operation visible to search, if wait_for (the default) then wait for a refresh to make this operation visible to search, if false then do nothing with refreshes.
final String	service()	Required - The name of the service.

Methods inherited from class co.elastic.clients.elasticsearch._types.RequestBase

toString

Methods inherited from class java.lang.Object

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

Field Details

_ENDPOINT

public static final Endpoint<CreateServiceTokenRequest,CreateServiceTokenResponse,ErrorResponse> _ENDPOINT

Endpoint "security.create_service_token".

Method Details

of

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

name

@Nullable
public final String name()

The name for the service account token. If omitted, a random name will be generated.

Token names must be at least one and no more than 256 characters. They can contain alphanumeric characters (a-z, A-Z, 0-9), dashes (-), and underscores (_), but cannot begin with an underscore.

NOTE: Token names must be unique in the context of the associated service account. They must also be globally unique with their fully qualified names, which are comprised of the service account principal and token name, such as <namespace>/<service>/<token-name>.

API name: name

namespace

public final String namespace()

Required - The name of the namespace, which is a top-level grouping of service accounts.

API name: namespace

refresh

@Nullable
public final Refresh refresh()

If true then refresh the affected shards to make this operation visible to search, if wait_for (the default) then wait for a refresh to make this operation visible to search, if false then do nothing with refreshes.

API name: refresh

service

public final String service()

Required - The name of the service.

API name: service