Package co.elastic.clients.elasticsearch.security

Class UpdateApiKeyRequest.Builder

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

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • id

      public final UpdateApiKeyRequest.Builder id(String value)
      Required - The ID of the API key to update.

      API name: id

    • metadata

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

    • roleDescriptors

      public final UpdateApiKeyRequest.Builder roleDescriptors(Map<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 to roleDescriptors.

    • roleDescriptors

      public final UpdateApiKeyRequest.Builder roleDescriptors(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 UpdateApiKeyRequest.Builder roleDescriptors(String key, 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.

    • self

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

    • build

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