Class CreateApiKeyRequest.Builder
java.lang.Object
co.elastic.clients.util.ObjectBuilderBase
co.elastic.clients.elasticsearch.security.CreateApiKeyRequest.Builder
- All Implemented Interfaces:
ObjectBuilder<CreateApiKeyRequest>
- Enclosing class:
- CreateApiKeyRequest
public static class CreateApiKeyRequest.Builder extends ObjectBuilderBase implements ObjectBuilder<CreateApiKeyRequest>
Builder for
CreateApiKeyRequest
.-
Constructor Summary
Constructors Constructor Description Builder()
-
Method Summary
Modifier and Type Method Description CreateApiKeyRequest
build()
Builds aCreateApiKeyRequest
.CreateApiKeyRequest.Builder
expiration(Time value)
Expiration time for the API key.CreateApiKeyRequest.Builder
expiration(java.util.function.Function<Time.Builder,ObjectBuilder<Time>> fn)
Expiration time for the API key.CreateApiKeyRequest.Builder
metadata(java.lang.String key, JsonData value)
Arbitrary metadata that you want to associate with the API key.CreateApiKeyRequest.Builder
metadata(java.util.Map<java.lang.String,JsonData> map)
Arbitrary metadata that you want to associate with the API key.CreateApiKeyRequest.Builder
name(java.lang.String value)
Specifies the name for this API key.CreateApiKeyRequest.Builder
refresh(Refresh value)
Iftrue
(the default) then refresh the affected shards to make this operation visible to search, ifwait_for
then wait for a refresh to make this operation visible to search, iffalse
then do nothing with refreshes.CreateApiKeyRequest.Builder
roleDescriptors(java.lang.String key, RoleDescriptor value)
An array of role descriptors for this API key.CreateApiKeyRequest.Builder
roleDescriptors(java.lang.String key, java.util.function.Function<RoleDescriptor.Builder,ObjectBuilder<RoleDescriptor>> fn)
An array of role descriptors for this API key.CreateApiKeyRequest.Builder
roleDescriptors(java.util.Map<java.lang.String,RoleDescriptor> map)
An array of role descriptors for this API key.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
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
expiration
Expiration time for the API key. By default, API keys never expire.API name:
expiration
-
expiration
public final CreateApiKeyRequest.Builder expiration(java.util.function.Function<Time.Builder,ObjectBuilder<Time>> fn)Expiration time for the API key. By default, API keys never expire.API name:
expiration
-
metadata
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.API name:
metadata
Adds all entries of
map
tometadata
. -
metadata
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.API name:
metadata
Adds an entry to
metadata
. -
name
Specifies the name for this API key.API name:
name
-
refresh
Iftrue
(the default) then refresh the affected shards to make this operation visible to search, ifwait_for
then wait for a refresh to make this operation visible to search, iffalse
then do nothing with refreshes.API name:
refresh
-
roleDescriptors
public final CreateApiKeyRequest.Builder roleDescriptors(java.util.Map<java.lang.String,RoleDescriptor> map)An array of role descriptors for this API key. This parameter is optional. When it is not specified or is an empty array, then the API key will have a point in time snapshot of permissions of the authenticated user. If you supply role descriptors then the resultant permissions would be an intersection of API keys permissions and authenticated user’s permissions thereby limiting the access scope for API keys. The structure of role descriptor is the same as the request for create role API. For more details, see create or update roles API.API name:
role_descriptors
Adds all entries of
map
toroleDescriptors
. -
roleDescriptors
public final CreateApiKeyRequest.Builder roleDescriptors(java.lang.String key, RoleDescriptor value)An array of role descriptors for this API key. This parameter is optional. When it is not specified or is an empty array, then the API key will have a point in time snapshot of permissions of the authenticated user. If you supply role descriptors then the resultant permissions would be an intersection of API keys permissions and authenticated user’s permissions thereby limiting the access scope for API keys. The structure of role descriptor is the same as the request for create role API. For more details, see create or update roles API.API name:
role_descriptors
Adds an entry to
roleDescriptors
. -
roleDescriptors
public final CreateApiKeyRequest.Builder roleDescriptors(java.lang.String key, java.util.function.Function<RoleDescriptor.Builder,ObjectBuilder<RoleDescriptor>> fn)An array of role descriptors for this API key. This parameter is optional. When it is not specified or is an empty array, then the API key will have a point in time snapshot of permissions of the authenticated user. If you supply role descriptors then the resultant permissions would be an intersection of API keys permissions and authenticated user’s permissions thereby limiting the access scope for API keys. The structure of role descriptor is the same as the request for create role API. For more details, see create or update roles API.API name:
role_descriptors
Adds an entry to
roleDescriptors
using a builder lambda. -
build
Builds aCreateApiKeyRequest
.- Specified by:
build
in interfaceObjectBuilder<CreateApiKeyRequest>
- Throws:
java.lang.NullPointerException
- if some of the required fields are null.
-