Package co.elastic.clients.elasticsearch.security

Class ApiKey.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

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

co.elastic.clients.elasticsearch.security.ApiKey.Builder

All Implemented Interfaces:

WithJson<ApiKey.Builder>, ObjectBuilder<ApiKey>

Enclosing class:

ApiKey

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

Builder for ApiKey.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
ApiKey	build()	Builds a ApiKey.
final ApiKey.Builder	creation(Long value)	API name: creation
final ApiKey.Builder	expiration(Long value)	API name: expiration
final ApiKey.Builder	id(String value)	Required - API name: id
final ApiKey.Builder	invalidated(Boolean value)	API name: invalidated
final ApiKey.Builder	limitedBy(List<Map<String,RoleDescriptor>> list)	API name: limited_by
final ApiKey.Builder	limitedBy(Map<String,RoleDescriptor> value, Map<String,RoleDescriptor>... values)	API name: limited_by
final ApiKey.Builder	metadata(String key, JsonData value)	API name: metadata
final ApiKey.Builder	metadata(Map<String,JsonData> map)	API name: metadata
final ApiKey.Builder	name(String value)	Required - API name: name
final ApiKey.Builder	realm(String value)	API name: realm
final ApiKey.Builder	roleDescriptors(String key, RoleDescriptor value)	API name: role_descriptors
final ApiKey.Builder	roleDescriptors(String key, Function<RoleDescriptor.Builder,ObjectBuilder<RoleDescriptor>> fn)	API name: role_descriptors
final ApiKey.Builder	roleDescriptors(Map<String,RoleDescriptor> map)	API name: role_descriptors
protected ApiKey.Builder	self()
final ApiKey.Builder	sort(FieldValue value, FieldValue... values)	API name: _sort
final ApiKey.Builder	sort(Function<FieldValue.Builder,ObjectBuilder<FieldValue>> fn)	API name: _sort
final ApiKey.Builder	sort(List<FieldValue> list)	API name: _sort
final ApiKey.Builder	username(String value)	API name: username

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

creation

public final ApiKey.Builder creation(@Nullable
 Long value)

API name: creation

expiration

public final ApiKey.Builder expiration(@Nullable
 Long value)

API name: expiration

id

public final ApiKey.Builder id(String value)

Required - API name: id

invalidated

public final ApiKey.Builder invalidated(@Nullable
 Boolean value)

API name: invalidated

name

public final ApiKey.Builder name(String value)

Required - API name: name

realm

public final ApiKey.Builder realm(@Nullable
 String value)

API name: realm

username

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

API name: username

metadata

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

API name: metadata

Adds all entries of map to metadata.

metadata

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

API name: metadata

Adds an entry to metadata.

roleDescriptors

public final ApiKey.Builder roleDescriptors(Map<String,RoleDescriptor> map)

API name: role_descriptors

Adds all entries of map to roleDescriptors.

roleDescriptors

public final ApiKey.Builder roleDescriptors(String key,
 RoleDescriptor value)

API name: role_descriptors

Adds an entry to roleDescriptors.

roleDescriptors

public final ApiKey.Builder roleDescriptors(String key,
 Function<RoleDescriptor.Builder,ObjectBuilder<RoleDescriptor>> fn)

API name: role_descriptors

Adds an entry to roleDescriptors using a builder lambda.

limitedBy

public final ApiKey.Builder limitedBy(List<Map<String,RoleDescriptor>> list)

API name: limited_by

Adds all elements of list to limitedBy.

limitedBy

public final ApiKey.Builder limitedBy(Map<String,RoleDescriptor> value,
 Map<String,RoleDescriptor>... values)

API name: limited_by

Adds one or more values to limitedBy.

sort

public final ApiKey.Builder sort(List<FieldValue> list)

API name: _sort

Adds all elements of list to sort.

sort

public final ApiKey.Builder sort(FieldValue value,
 FieldValue... values)

API name: _sort

Adds one or more values to sort.

sort

public final ApiKey.Builder sort(Function<FieldValue.Builder,ObjectBuilder<FieldValue>> fn)

API name: _sort

Adds a value to sort using a builder lambda.

self

protected ApiKey.Builder self()

Specified by:

self in class WithJsonObjectBuilderBase<ApiKey.Builder>

build

public ApiKey build()

Builds a ApiKey.

Specified by:

build in interface ObjectBuilder<ApiKey>

Throws:

NullPointerException - if some of the required fields are null.