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

    • id

      public final GetApiKeyRequest.Builder id​(@Nullable java.lang.String value)
      API key id of the API key to be retrieved

      API name: id

    • name

      public final GetApiKeyRequest.Builder name​(@Nullable java.lang.String value)
      API key name of the API key to be retrieved

      API name: name

    • owner

      public final GetApiKeyRequest.Builder owner​(@Nullable java.lang.Boolean value)
      flag to query API keys owned by the currently authenticated user

      API name: owner

    • realmName

      public final GetApiKeyRequest.Builder realmName​(@Nullable java.lang.String value)
      realm name of the user who created this API key to be retrieved

      API name: realm_name

    • username

      public final GetApiKeyRequest.Builder username​(@Nullable java.lang.String value)
      user name of the user who created this API key to be retrieved

      API name: username

    • withLimitedBy

      public final GetApiKeyRequest.Builder withLimitedBy​(@Nullable java.lang.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

    • 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:
      java.lang.NullPointerException - if some of the required fields are null.