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

    • creation

      public final ApiKey.Builder creation​(@Nullable java.lang.Long value)
      API name: creation

    • expiration

      public final ApiKey.Builder expiration​(@Nullable java.lang.Long value)
      API name: expiration

    • id

      public final ApiKey.Builder id​(java.lang.String value)
      Required - API name: id

    • invalidated

      public final ApiKey.Builder invalidated​(@Nullable java.lang.Boolean value)
      API name: invalidated

    • name

      public final ApiKey.Builder name​(java.lang.String value)
      Required - API name: name

    • realm

      public final ApiKey.Builder realm​(@Nullable java.lang.String value)
      API name: realm

    • username

      public final ApiKey.Builder username​(@Nullable java.lang.String value)
      API name: username

    • metadata

      public final ApiKey.Builder metadata​(java.util.Map<java.lang.String,​JsonData> map)
      API name: metadata

      Adds all entries of map to metadata.

    • metadata

      public final ApiKey.Builder metadata​(java.lang.String key, JsonData value)
      API name: metadata

      Adds an entry to metadata.

    • roleDescriptors

      public final ApiKey.Builder roleDescriptors​(java.util.Map<java.lang.String,​RoleDescriptor> map)
      API name: role_descriptors

      Adds all entries of map to roleDescriptors.

    • roleDescriptors

      public final ApiKey.Builder roleDescriptors​(java.lang.String key, RoleDescriptor value)
      API name: role_descriptors

      Adds an entry to roleDescriptors.

    • roleDescriptors

      public final ApiKey.Builder roleDescriptors​(java.lang.String key, java.util.function.Function<RoleDescriptor.Builder,​ObjectBuilder<RoleDescriptor>> fn)
      API name: role_descriptors

      Adds an entry to roleDescriptors using a builder lambda.

    • limitedBy

      public final ApiKey.Builder limitedBy​(java.util.List<java.util.Map<java.lang.String,​RoleDescriptor>> list)
      API name: limited_by

      Adds all elements of list to limitedBy.

    • limitedBy

      public final ApiKey.Builder limitedBy​(java.util.Map<java.lang.String,​RoleDescriptor> value, java.util.Map<java.lang.String,​RoleDescriptor>... values)
      API name: limited_by

      Adds one or more values to limitedBy.

    • sort

      public final ApiKey.Builder sort​(java.util.List<FieldValue> list)
      API name: _sort

      Adds all elements of list to sort.

    • sort

      public final ApiKey.Builder sort​(FieldValue value, FieldValue... values)
      API name: _sort

      Adds one or more values to sort.

    • sort

      public final ApiKey.Builder sort​(java.util.function.Function<FieldValue.Builder,​ObjectBuilder<FieldValue>> fn)
      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:
      java.lang.NullPointerException - if some of the required fields are null.