Package co.elastic.clients.elasticsearch.security

Class CreateServiceTokenRequest.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

co.elastic.clients.util.WithJsonObjectBuilderBase<BuilderT>

co.elastic.clients.elasticsearch._types.RequestBase.AbstractBuilder<CreateServiceTokenRequest.Builder>

co.elastic.clients.elasticsearch.security.CreateServiceTokenRequest.Builder

All Implemented Interfaces:

WithJson<CreateServiceTokenRequest.Builder>, ObjectBuilder<CreateServiceTokenRequest>

Enclosing class:

CreateServiceTokenRequest

public static class CreateServiceTokenRequest.Builder
extends RequestBase.AbstractBuilder<CreateServiceTokenRequest.Builder>
implements ObjectBuilder<CreateServiceTokenRequest>

Builder for CreateServiceTokenRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CreateServiceTokenRequest	build()	Builds a CreateServiceTokenRequest.
final CreateServiceTokenRequest.Builder	name(String value)	The name for the service account token.
final CreateServiceTokenRequest.Builder	namespace(String value)	Required - The name of the namespace, which is a top-level grouping of service accounts.
final CreateServiceTokenRequest.Builder	refresh(Refresh value)	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.
protected CreateServiceTokenRequest.Builder	self()
final CreateServiceTokenRequest.Builder	service(String value)	Required - The name of the service.

Methods inherited from class co.elastic.clients.util.WithJsonObjectBuilderBase

withJson

Methods inherited from class co.elastic.clients.util.ObjectBuilderBase

_checkSingleUse, _listAdd, _listAddAll, _mapPut, _mapPutAll

Methods inherited from class java.lang.Object

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

Methods inherited from interface co.elastic.clients.json.WithJson

withJson, withJson

Constructor Details

Builder

public Builder()

Method Details

name

public final CreateServiceTokenRequest.Builder name(@Nullable
 String value)

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 CreateServiceTokenRequest.Builder namespace(String value)

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

API name: namespace

refresh

public final CreateServiceTokenRequest.Builder refresh(@Nullable
 Refresh value)

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 CreateServiceTokenRequest.Builder service(String value)

Required - The name of the service.

API name: service

self

protected CreateServiceTokenRequest.Builder self()

Specified by:

self in class RequestBase.AbstractBuilder<CreateServiceTokenRequest.Builder>

build

public CreateServiceTokenRequest build()

Builds a CreateServiceTokenRequest.

Specified by:

build in interface ObjectBuilder<CreateServiceTokenRequest>

Throws:

NullPointerException - if some of the required fields are null.