Package co.elastic.clients.elasticsearch.security

Class GrantApiKeyRequest.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

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

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

co.elastic.clients.elasticsearch.security.GrantApiKeyRequest.Builder

All Implemented Interfaces:

WithJson<GrantApiKeyRequest.Builder>, ObjectBuilder<GrantApiKeyRequest>

Enclosing class:

GrantApiKeyRequest

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

Builder for GrantApiKeyRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
final GrantApiKeyRequest.Builder	accessToken(String value)	The user's access token.
final GrantApiKeyRequest.Builder	apiKey(GrantApiKey value)	Required - The API key.
final GrantApiKeyRequest.Builder	apiKey(Function<GrantApiKey.Builder,ObjectBuilder<GrantApiKey>> fn)	Required - The API key.
GrantApiKeyRequest	build()	Builds a GrantApiKeyRequest.
final GrantApiKeyRequest.Builder	grantType(ApiKeyGrantType value)	Required - The type of grant.
final GrantApiKeyRequest.Builder	password(String value)	The user's password.
final GrantApiKeyRequest.Builder	refresh(Refresh value)	If 'true', Elasticsearch refreshes the affected shards to make this operation visible to search.
final GrantApiKeyRequest.Builder	runAs(String value)	The name of the user to be impersonated.
protected GrantApiKeyRequest.Builder	self()
final GrantApiKeyRequest.Builder	username(String value)	The user name that identifies the user.

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

accessToken

public final GrantApiKeyRequest.Builder accessToken(@Nullable
 String value)

The user's access token. If you specify the access_token grant type, this parameter is required. It is not valid with other grant types.

API name: access_token

apiKey

public final GrantApiKeyRequest.Builder apiKey(GrantApiKey value)

Required - The API key.

API name: api_key

apiKey

public final GrantApiKeyRequest.Builder apiKey(Function<GrantApiKey.Builder,ObjectBuilder<GrantApiKey>> fn)

Required - The API key.

API name: api_key

grantType

public final GrantApiKeyRequest.Builder grantType(ApiKeyGrantType value)

Required - The type of grant. Supported grant types are: access_token, password.

API name: grant_type

password

public final GrantApiKeyRequest.Builder password(@Nullable
 String value)

The user's password. If you specify the password grant type, this parameter is required. It is not valid with other grant types.

API name: password

refresh

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

If 'true', Elasticsearch refreshes the affected shards to make this operation visible to search. If 'wait_for', it waits for a refresh to make this operation visible to search. If 'false', nothing is done with refreshes.

API name: refresh

runAs

public final GrantApiKeyRequest.Builder runAs(@Nullable
 String value)

The name of the user to be impersonated.

API name: run_as

username

public final GrantApiKeyRequest.Builder username(@Nullable
 String value)

The user name that identifies the user. If you specify the password grant type, this parameter is required. It is not valid with other grant types.

API name: username

self

protected GrantApiKeyRequest.Builder self()

Specified by:

self in class RequestBase.AbstractBuilder<GrantApiKeyRequest.Builder>

build

public GrantApiKeyRequest build()

Builds a GrantApiKeyRequest.

Specified by:

build in interface ObjectBuilder<GrantApiKeyRequest>

Throws:

NullPointerException - if some of the required fields are null.