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 Details

    • Builder

      public Builder()

  • Method Details

    • id

      public final ApiKey.Builder id(String value)
      Required - Id for the API key

      API name: id

    • name

      public final ApiKey.Builder name(String value)
      Required - Name of the API key.

      API name: name

    • type

      public final ApiKey.Builder type(ApiKeyType value)
      Required - The type of the API key (e.g. rest or cross_cluster).

      API name: type

    • creation

      public final ApiKey.Builder creation(long value)
      Required - Creation time for the API key in milliseconds.

      API name: creation

    • expiration

      public final ApiKey.Builder expiration(@Nullable Long value)
      Expiration time for the API key in milliseconds.

      API name: expiration

    • invalidated

      public final ApiKey.Builder invalidated(boolean value)
      Required - Invalidation status for the API key. If the key has been invalidated, it has a value of true. Otherwise, it is false.

      API name: invalidated

    • invalidation

      public final ApiKey.Builder invalidation(@Nullable Long value)
      If the key has been invalidated, invalidation time in milliseconds.

      API name: invalidation

    • username

      public final ApiKey.Builder username(String value)
      Required - Principal for which this API key was created

      API name: username

    • realm

      public final ApiKey.Builder realm(String value)
      Required - Realm name of the principal for which this API key was created.

      API name: realm

    • realmType

      public final ApiKey.Builder realmType(@Nullable String value)
      Realm type of the principal for which this API key was created

      API name: realm_type

    • metadata

      public final ApiKey.Builder metadata(Map<String,JsonData> map)
      Required - Metadata of the API key

      API name: metadata

      Adds all entries of map to metadata.

    • metadata

      public final ApiKey.Builder metadata(String key, JsonData value)
      Required - Metadata of the API key

      API name: metadata

      Adds an entry to metadata.

    • roleDescriptors

      public final ApiKey.Builder roleDescriptors(Map<String,RoleDescriptor> map)
      The role descriptors assigned to this API key when it was created or last updated. An empty role descriptor means the API key inherits the owner user’s permissions.

      API name: role_descriptors

      Adds all entries of map to roleDescriptors.

    • roleDescriptors

      public final ApiKey.Builder roleDescriptors(String key, RoleDescriptor value)
      The role descriptors assigned to this API key when it was created or last updated. An empty role descriptor means the API key inherits the owner user’s permissions.

      API name: role_descriptors

      Adds an entry to roleDescriptors.

    • roleDescriptors

      public final ApiKey.Builder roleDescriptors(String key, Function<RoleDescriptor.Builder,ObjectBuilder<RoleDescriptor>> fn)
      The role descriptors assigned to this API key when it was created or last updated. An empty role descriptor means the API key inherits the owner user’s permissions.

      API name: role_descriptors

      Adds an entry to roleDescriptors using a builder lambda.

    • limitedBy

      public final ApiKey.Builder limitedBy(List<Map<String,RoleDescriptor>> list)
      The owner user’s permissions associated with the API key. It is a point-in-time snapshot captured at creation and subsequent updates. An API key’s effective permissions are an intersection of its assigned privileges and the owner user’s permissions.

      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)
      The owner user’s permissions associated with the API key. It is a point-in-time snapshot captured at creation and subsequent updates. An API key’s effective permissions are an intersection of its assigned privileges and the owner user’s permissions.

      API name: limited_by

      Adds one or more values to limitedBy.

    • access

      public final ApiKey.Builder access(@Nullable Access value)
      The access granted to cross-cluster API keys. The access is composed of permissions for cross cluster search and cross cluster replication. At least one of them must be specified. When specified, the new access assignment fully replaces the previously assigned access.

      API name: access

    • access

      public final ApiKey.Builder access(Function<Access.Builder,ObjectBuilder<Access>> fn)
      The access granted to cross-cluster API keys. The access is composed of permissions for cross cluster search and cross cluster replication. At least one of them must be specified. When specified, the new access assignment fully replaces the previously assigned access.

      API name: access

    • profileUid

      public final ApiKey.Builder profileUid(@Nullable String value)
      The profile uid for the API key owner principal, if requested and if it exists

      API name: profile_uid

    • sort

      public final ApiKey.Builder sort(List<FieldValue> list)
      Sorting values when using the sort parameter with the security.query_api_keys API.

      API name: _sort

      Adds all elements of list to sort.

    • sort

      public final ApiKey.Builder sort(FieldValue value, FieldValue... values)
      Sorting values when using the sort parameter with the security.query_api_keys API.

      API name: _sort

      Adds one or more values to sort.

    • sort

      public final ApiKey.Builder sort(String value, String... values)
      Sorting values when using the sort parameter with the security.query_api_keys API.

      API name: _sort

      Adds one or more values to sort.

    • sort

      public final ApiKey.Builder sort(long value, long... values)
      Sorting values when using the sort parameter with the security.query_api_keys API.

      API name: _sort

      Adds one or more values to sort.

    • sort

      public final ApiKey.Builder sort(double value, double... values)
      Sorting values when using the sort parameter with the security.query_api_keys API.

      API name: _sort

      Adds one or more values to sort.

    • sort

      public final ApiKey.Builder sort(boolean value, boolean... values)
      Sorting values when using the sort parameter with the security.query_api_keys API.

      API name: _sort

      Adds one or more values to sort.

    • sort

      public final ApiKey.Builder sort(Function<FieldValue.Builder,ObjectBuilder<FieldValue>> fn)
      Sorting values when using the sort parameter with the security.query_api_keys API.

      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.