Package co.elastic.clients.elasticsearch.security

Class UpdateCrossClusterApiKeyRequest.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

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

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

co.elastic.clients.elasticsearch.security.UpdateCrossClusterApiKeyRequest.Builder

All Implemented Interfaces:

WithJson<UpdateCrossClusterApiKeyRequest.Builder>, ObjectBuilder<UpdateCrossClusterApiKeyRequest>

Enclosing class:

UpdateCrossClusterApiKeyRequest

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

Builder for UpdateCrossClusterApiKeyRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
final UpdateCrossClusterApiKeyRequest.Builder	access(Access value)	Required - The access to be granted to this API key.
final UpdateCrossClusterApiKeyRequest.Builder	access(Function<Access.Builder,ObjectBuilder<Access>> fn)	Required - The access to be granted to this API key.
UpdateCrossClusterApiKeyRequest	build()	Builds a UpdateCrossClusterApiKeyRequest.
final UpdateCrossClusterApiKeyRequest.Builder	expiration(Time value)	The expiration time for the API key.
final UpdateCrossClusterApiKeyRequest.Builder	expiration(Function<Time.Builder,ObjectBuilder<Time>> fn)	The expiration time for the API key.
final UpdateCrossClusterApiKeyRequest.Builder	id(String value)	Required - The ID of the cross-cluster API key to update.
final UpdateCrossClusterApiKeyRequest.Builder	metadata(String key, JsonData value)	Arbitrary metadata that you want to associate with the API key.
final UpdateCrossClusterApiKeyRequest.Builder	metadata(Map<String,JsonData> map)	Arbitrary metadata that you want to associate with the API key.
protected UpdateCrossClusterApiKeyRequest.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

access

public final UpdateCrossClusterApiKeyRequest.Builder access(Access value)

Required - The access to be granted to this API key. The access is composed of permissions for cross cluster search and cross cluster replication. At least one of them must be specified. When specified, the new access assignment fully replaces the previously assigned access.

API name: access

access

public final UpdateCrossClusterApiKeyRequest.Builder access(Function<Access.Builder,ObjectBuilder<Access>> fn)

Required - The access to be granted to this API key. The access is composed of permissions for cross cluster search and cross cluster replication. At least one of them must be specified. When specified, the new access assignment fully replaces the previously assigned access.

API name: access

expiration

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

The expiration time for the API key. By default, API keys never expire. This property can be omitted to leave the value unchanged.

API name: expiration

expiration

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

The expiration time for the API key. By default, API keys never expire. This property can be omitted to leave the value unchanged.

API name: expiration

id

public final UpdateCrossClusterApiKeyRequest.Builder id(String value)

Required - The ID of the cross-cluster API key to update.

API name: id

metadata

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

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. When specified, this information fully replaces metadata previously associated with the API key.

API name: metadata

Adds all entries of map to metadata.

metadata

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

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. When specified, this information fully replaces metadata previously associated with the API key.

API name: metadata

Adds an entry to metadata.

self

protected UpdateCrossClusterApiKeyRequest.Builder self()

Specified by:

self in class RequestBase.AbstractBuilder<UpdateCrossClusterApiKeyRequest.Builder>

build

public UpdateCrossClusterApiKeyRequest build()

Builds a UpdateCrossClusterApiKeyRequest.

Specified by:

build in interface ObjectBuilder<UpdateCrossClusterApiKeyRequest>

Throws:

NullPointerException - if some of the required fields are null.