Package co.elastic.clients.elasticsearch.security

Class BulkUpdateApiKeysRequest.Builder

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

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • expiration

      public final BulkUpdateApiKeysRequest.Builder expiration(@Nullable Time value)
      Expiration time for the API keys. By default, API keys never expire. This property can be omitted to leave the value unchanged.

      API name: expiration

    • expiration

      public final BulkUpdateApiKeysRequest.Builder expiration(Function<Time.Builder,ObjectBuilder<Time>> fn)
      Expiration time for the API keys. By default, API keys never expire. This property can be omitted to leave the value unchanged.

      API name: expiration

    • ids

      public final BulkUpdateApiKeysRequest.Builder ids(List<String> list)
      Required - The API key identifiers.

      API name: ids

      Adds all elements of list to ids.

    • ids

      public final BulkUpdateApiKeysRequest.Builder ids(String value, String... values)
      Required - The API key identifiers.

      API name: ids

      Adds one or more values to ids.

    • metadata

      public final BulkUpdateApiKeysRequest.Builder metadata(Map<String,JsonData> map)
      Arbitrary nested metadata to associate with the API keys. Within the metadata object, top-level keys beginning with an underscore (_) are reserved for system usage. Any information specified with this parameter fully replaces metadata previously associated with the API key.

      API name: metadata

      Adds all entries of map to metadata.

    • metadata

      public final BulkUpdateApiKeysRequest.Builder metadata(String key, JsonData value)
      Arbitrary nested metadata to associate with the API keys. Within the metadata object, top-level keys beginning with an underscore (_) are reserved for system usage. Any information specified with this parameter fully replaces metadata previously associated with the API key.

      API name: metadata

      Adds an entry to metadata.

    • roleDescriptors

      public final BulkUpdateApiKeysRequest.Builder roleDescriptors(Map<String,RoleDescriptor> map)
      The role descriptors to assign to the API keys. An API key's effective permissions are an intersection of its assigned privileges and the point-in-time snapshot of permissions of the owner user. You can assign new privileges by specifying them in this parameter. To remove assigned privileges, supply the role_descriptors parameter as an empty object {}. If an API key has no assigned privileges, it inherits the owner user's full permissions. The snapshot of the owner's permissions is always updated, whether you supply the role_descriptors parameter. The structure of a role descriptor is the same as the request for the create API keys API.

      API name: role_descriptors

      Adds all entries of map to roleDescriptors.

    • roleDescriptors

      public final BulkUpdateApiKeysRequest.Builder roleDescriptors(String key, RoleDescriptor value)
      The role descriptors to assign to the API keys. An API key's effective permissions are an intersection of its assigned privileges and the point-in-time snapshot of permissions of the owner user. You can assign new privileges by specifying them in this parameter. To remove assigned privileges, supply the role_descriptors parameter as an empty object {}. If an API key has no assigned privileges, it inherits the owner user's full permissions. The snapshot of the owner's permissions is always updated, whether you supply the role_descriptors parameter. The structure of a role descriptor is the same as the request for the create API keys API.

      API name: role_descriptors

      Adds an entry to roleDescriptors.

    • roleDescriptors

      public final BulkUpdateApiKeysRequest.Builder roleDescriptors(String key, Function<RoleDescriptor.Builder,ObjectBuilder<RoleDescriptor>> fn)
      The role descriptors to assign to the API keys. An API key's effective permissions are an intersection of its assigned privileges and the point-in-time snapshot of permissions of the owner user. You can assign new privileges by specifying them in this parameter. To remove assigned privileges, supply the role_descriptors parameter as an empty object {}. If an API key has no assigned privileges, it inherits the owner user's full permissions. The snapshot of the owner's permissions is always updated, whether you supply the role_descriptors parameter. The structure of a role descriptor is the same as the request for the create API keys API.

      API name: role_descriptors

      Adds an entry to roleDescriptors using a builder lambda.

    • self

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

    • build

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