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
-
Method Summary
Modifier and TypeMethodDescriptionbuild()
Builds aApiKey
.final ApiKey.Builder
API name:creation
final ApiKey.Builder
expiration
(Long value) API name:expiration
final ApiKey.Builder
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
API name:metadata
final ApiKey.Builder
API name:metadata
final ApiKey.Builder
Required - API name:name
final ApiKey.Builder
API name:realm
final ApiKey.Builder
roleDescriptors
(String key, RoleDescriptor value) API name:role_descriptors
final ApiKey.Builder
API name:role_descriptors
final ApiKey.Builder
API name:role_descriptors
protected ApiKey.Builder
self()
final ApiKey.Builder
sort
(FieldValue value, FieldValue... values) API name:_sort
final ApiKey.Builder
API name:_sort
final ApiKey.Builder
sort
(List<FieldValue> list) API name:_sort
final ApiKey.Builder
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
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
creation
API name:creation
-
expiration
API name:expiration
-
id
Required - API name:id
-
invalidated
API name:invalidated
-
name
Required - API name:name
-
realm
API name:realm
-
username
API name:username
-
metadata
API name:metadata
Adds all entries of
map
tometadata
. -
metadata
API name:metadata
Adds an entry to
metadata
. -
roleDescriptors
API name:role_descriptors
Adds all entries of
map
toroleDescriptors
. -
roleDescriptors
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
API name:limited_by
Adds all elements of
list
tolimitedBy
. -
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
API name:_sort
Adds all elements of
list
tosort
. -
sort
API name:_sort
Adds one or more values to
sort
. -
sort
API name:_sort
Adds a value to
sort
using a builder lambda. -
self
- Specified by:
self
in classWithJsonObjectBuilderBase<ApiKey.Builder>
-
build
Builds aApiKey
.- Specified by:
build
in interfaceObjectBuilder<ApiKey>
- Throws:
NullPointerException
- if some of the required fields are null.
-