Package co.elastic.clients.elasticsearch.security

Class CreateApiKeyRequest.Builder

java.lang.Object
co.elastic.clients.util.ObjectBuilderBase
co.elastic.clients.util.WithJsonObjectBuilderBase<BuilderT>
co.elastic.clients.elasticsearch._types.RequestBase.AbstractBuilder<CreateApiKeyRequest.Builder>
co.elastic.clients.elasticsearch.security.CreateApiKeyRequest.Builder
All Implemented Interfaces:
WithJson<CreateApiKeyRequest.Builder>, ObjectBuilder<CreateApiKeyRequest>
Enclosing class:
CreateApiKeyRequest
public static class CreateApiKeyRequest.Builder extends RequestBase.AbstractBuilder<CreateApiKeyRequest.Builder> implements ObjectBuilder<CreateApiKeyRequest>
Builder for CreateApiKeyRequest.

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • expiration

      public final CreateApiKeyRequest.Builder expiration(@Nullable Time value)
      The expiration time for the API key. By default, API keys never expire.

      API name: expiration

    • expiration

      public final CreateApiKeyRequest.Builder expiration(Function<Time.Builder,ObjectBuilder<Time>> fn)
      The expiration time for the API key. By default, API keys never expire.

      API name: expiration

    • metadata

      public final CreateApiKeyRequest.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.

      API name: metadata

      Adds all entries of map to metadata.

    • metadata

      public final CreateApiKeyRequest.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.

      API name: metadata

      Adds an entry to metadata.

    • name

      public final CreateApiKeyRequest.Builder name(@Nullable String value)
      A name for the API key.

      API name: name

    • refresh

      public final CreateApiKeyRequest.Builder refresh(@Nullable Refresh value)
      If true (the default) then refresh the affected shards to make this operation visible to search, if wait_for then wait for a refresh to make this operation visible to search, if false then do nothing with refreshes.

      API name: refresh

    • roleDescriptors

      public final CreateApiKeyRequest.Builder roleDescriptors(Map<String,RoleDescriptor> map)
      An array of role descriptors for this API key. When it is not specified or it is an empty array, the API key will have a point in time snapshot of permissions of the authenticated user. If you supply role descriptors, the resultant permissions are an intersection of API keys permissions and the authenticated user's permissions thereby limiting the access scope for API keys. The structure of role descriptor is the same as the request for the create role API. For more details, refer to the create or update roles API.

      NOTE: Due to the way in which this permission intersection is calculated, it is not possible to create an API key that is a child of another API key, unless the derived key is created without any privileges. In this case, you must explicitly specify a role descriptor with no privileges. The derived API key can be used for authentication; it will not have authority to call Elasticsearch APIs.

      API name: role_descriptors

      Adds all entries of map to roleDescriptors.

    • roleDescriptors

      public final CreateApiKeyRequest.Builder roleDescriptors(String key, RoleDescriptor value)
      An array of role descriptors for this API key. When it is not specified or it is an empty array, the API key will have a point in time snapshot of permissions of the authenticated user. If you supply role descriptors, the resultant permissions are an intersection of API keys permissions and the authenticated user's permissions thereby limiting the access scope for API keys. The structure of role descriptor is the same as the request for the create role API. For more details, refer to the create or update roles API.

      NOTE: Due to the way in which this permission intersection is calculated, it is not possible to create an API key that is a child of another API key, unless the derived key is created without any privileges. In this case, you must explicitly specify a role descriptor with no privileges. The derived API key can be used for authentication; it will not have authority to call Elasticsearch APIs.

      API name: role_descriptors

      Adds an entry to roleDescriptors.

    • roleDescriptors

      public final CreateApiKeyRequest.Builder roleDescriptors(String key, Function<RoleDescriptor.Builder,ObjectBuilder<RoleDescriptor>> fn)
      An array of role descriptors for this API key. When it is not specified or it is an empty array, the API key will have a point in time snapshot of permissions of the authenticated user. If you supply role descriptors, the resultant permissions are an intersection of API keys permissions and the authenticated user's permissions thereby limiting the access scope for API keys. The structure of role descriptor is the same as the request for the create role API. For more details, refer to the create or update roles API.

      NOTE: Due to the way in which this permission intersection is calculated, it is not possible to create an API key that is a child of another API key, unless the derived key is created without any privileges. In this case, you must explicitly specify a role descriptor with no privileges. The derived API key can be used for authentication; it will not have authority to call Elasticsearch APIs.

      API name: role_descriptors

      Adds an entry to roleDescriptors using a builder lambda.

    • self

      protected CreateApiKeyRequest.Builder self()
      Specified by:
      self in class RequestBase.AbstractBuilder<CreateApiKeyRequest.Builder>

    • build

      public CreateApiKeyRequest build()
      Builds a CreateApiKeyRequest.
      Specified by:
      build in interface ObjectBuilder<CreateApiKeyRequest>
      Throws:
      NullPointerException - if some of the required fields are null.