Package co.elastic.clients.elasticsearch.security

Class GetApiKeyRequest.Builder

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

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • activeOnly

      public final GetApiKeyRequest.Builder activeOnly(@Nullable Boolean value)
      A boolean flag that can be used to query API keys that are currently active. An API key is considered active if it is neither invalidated, nor expired at query time. You can specify this together with other parameters such as owner or name. If active_only is false, the response will include both active and inactive (expired or invalidated) keys.

      API name: active_only

    • id

      public final GetApiKeyRequest.Builder id(@Nullable String value)
      An API key id. This parameter cannot be used with any of name, realm_name or username.

      API name: id

    • name

      public final GetApiKeyRequest.Builder name(@Nullable String value)
      An API key name. This parameter cannot be used with any of id, realm_name or username. It supports prefix search with wildcard.

      API name: name

    • owner

      public final GetApiKeyRequest.Builder owner(@Nullable Boolean value)
      A boolean flag that can be used to query API keys owned by the currently authenticated user. The realm_name or username parameters cannot be specified when this parameter is set to true as they are assumed to be the currently authenticated ones.

      API name: owner

    • realmName

      public final GetApiKeyRequest.Builder realmName(@Nullable String value)
      The name of an authentication realm. This parameter cannot be used with either id or name or when owner flag is set to true.

      API name: realm_name

    • username

      public final GetApiKeyRequest.Builder username(@Nullable String value)
      The username of a user. This parameter cannot be used with either id or name or when owner flag is set to true.

      API name: username

    • withLimitedBy

      public final GetApiKeyRequest.Builder withLimitedBy(@Nullable Boolean value)
      Return the snapshot of the owner user's role descriptors associated with the API key. An API key's actual permission is the intersection of its assigned role descriptors and the owner user's role descriptors.

      API name: with_limited_by

    • withProfileUid

      public final GetApiKeyRequest.Builder withProfileUid(@Nullable Boolean value)
      Determines whether to also retrieve the profile uid, for the API key owner principal, if it exists.

      API name: with_profile_uid

    • self

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

    • build

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