Package co.elastic.clients.elasticsearch.security

Class CloneApiKeyRequest.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

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

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

co.elastic.clients.elasticsearch.security.CloneApiKeyRequest.Builder

All Implemented Interfaces:

WithJson<CloneApiKeyRequest.Builder>, ObjectBuilder<CloneApiKeyRequest>

Enclosing class:

CloneApiKeyRequest

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

Builder for CloneApiKeyRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
final CloneApiKeyRequest.Builder	apiKey(String value)	Required - The credentials of the API key to clone.
CloneApiKeyRequest	build()	Builds a CloneApiKeyRequest.
final CloneApiKeyRequest.Builder	expiration(Time value)	The expiration time for the cloned API key.
final CloneApiKeyRequest.Builder	expiration(Function<Time.Builder,ObjectBuilder<Time>> fn)	The expiration time for the cloned API key.
final CloneApiKeyRequest.Builder	metadata(String key, JsonData value)	Arbitrary metadata to associate with the cloned API key.
final CloneApiKeyRequest.Builder	metadata(Map<String,JsonData> map)	Arbitrary metadata to associate with the cloned API key.
final CloneApiKeyRequest.Builder	name(String value)	A name for the cloned API key.
final CloneApiKeyRequest.Builder	refresh(Refresh value)	If true (the default) then refresh the affected shards to make this operation visible to search, if wait_for then wait for a refresh to make this operation visible to search, if false then do nothing with refreshes.
protected CloneApiKeyRequest.Builder	self()

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

apiKey

public final CloneApiKeyRequest.Builder apiKey(String value)

Required - The credentials of the API key to clone. This is the secret value returned when the key was originally created.

API name: api_key

expiration

public final CloneApiKeyRequest.Builder expiration(@Nullable
 Time value)

The expiration time for the cloned API key. By default, API keys never expire. Set to null to explicitly create a key with no expiration.

API name: expiration

expiration

public final CloneApiKeyRequest.Builder expiration(Function<Time.Builder,ObjectBuilder<Time>> fn)

The expiration time for the cloned API key. By default, API keys never expire. Set to null to explicitly create a key with no expiration.

API name: expiration

metadata

public final CloneApiKeyRequest.Builder metadata(Map<String,JsonData> map)

Arbitrary metadata to associate with the cloned API key. It supports nested data structure. Within the metadata object, keys beginning with _ are reserved for system usage.

API name: metadata

Adds all entries of map to metadata.

metadata

public final CloneApiKeyRequest.Builder metadata(String key,
 JsonData value)

Arbitrary metadata to associate with the cloned API key. It supports nested data structure. Within the metadata object, keys beginning with _ are reserved for system usage.

API name: metadata

Adds an entry to metadata.

name

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

A name for the cloned API key. If not provided, the name of the source key is used.

API name: name

refresh

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

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

API name: refresh

self

protected CloneApiKeyRequest.Builder self()

Specified by:

self in class RequestBase.AbstractBuilder<CloneApiKeyRequest.Builder>

build

public CloneApiKeyRequest build()

Builds a CloneApiKeyRequest.

Specified by:

build in interface ObjectBuilder<CloneApiKeyRequest>

Throws:

NullPointerException - if some of the required fields are null.