Package co.elastic.clients.elasticsearch.security.grant_api_key

Class GrantApiKey.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

co.elastic.clients.util.WithJsonObjectBuilderBase<GrantApiKey.Builder>

co.elastic.clients.elasticsearch.security.grant_api_key.GrantApiKey.Builder

All Implemented Interfaces:

WithJson<GrantApiKey.Builder>, ObjectBuilder<GrantApiKey>

Enclosing class:

GrantApiKey

public static class GrantApiKey.Builder
extends WithJsonObjectBuilderBase<GrantApiKey.Builder>
implements ObjectBuilder<GrantApiKey>

Builder for GrantApiKey.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
GrantApiKey	build()	Builds a GrantApiKey.
final GrantApiKey.Builder	expiration(Time value)	API name: expiration
final GrantApiKey.Builder	expiration(Function<Time.Builder,ObjectBuilder<Time>> fn)	API name: expiration
final GrantApiKey.Builder	metadata(String key, JsonData value)	API name: metadata
final GrantApiKey.Builder	metadata(Map<String,JsonData> map)	API name: metadata
final GrantApiKey.Builder	name(String value)	Required - API name: name
final GrantApiKey.Builder	roleDescriptors(List<Map<String,RoleDescriptor>> list)	API name: role_descriptors
final GrantApiKey.Builder	roleDescriptors(Map<String,RoleDescriptor> value, Map<String,RoleDescriptor>... values)	API name: role_descriptors
protected GrantApiKey.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

name

public final GrantApiKey.Builder name(String value)

Required - API name: name

expiration

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

API name: expiration

expiration

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

API name: expiration

roleDescriptors

public final GrantApiKey.Builder roleDescriptors(List<Map<String,RoleDescriptor>> list)

API name: role_descriptors

Adds all elements of list to roleDescriptors.

roleDescriptors

public final GrantApiKey.Builder roleDescriptors(Map<String,RoleDescriptor> value,
 Map<String,RoleDescriptor>... values)

API name: role_descriptors

Adds one or more values to roleDescriptors.

metadata

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

API name: metadata

Adds all entries of map to metadata.

metadata

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

API name: metadata

Adds an entry to metadata.

self

protected GrantApiKey.Builder self()

Specified by:

self in class WithJsonObjectBuilderBase<GrantApiKey.Builder>

build

public GrantApiKey build()

Builds a GrantApiKey.

Specified by:

build in interface ObjectBuilder<GrantApiKey>

Throws:

NullPointerException - if some of the required fields are null.