Package co.elastic.clients.elasticsearch.security

Class UpdateSettingsRequest

java.lang.Object
co.elastic.clients.elasticsearch._types.RequestBase
co.elastic.clients.elasticsearch.security.UpdateSettingsRequest
All Implemented Interfaces:
JsonpSerializable
@JsonpDeserializable public class UpdateSettingsRequest extends RequestBase implements JsonpSerializable
Update security index settings.

Update the user-configurable settings for the security internal index (.security and associated indices). Only a subset of settings are allowed to be modified. This includes index.auto_expand_replicas and index.number_of_replicas.

NOTE: If index.auto_expand_replicas is set, index.number_of_replicas will be ignored during updates.

If a specific index is not in use on the system and settings are provided for it, the request will be rejected. This API does not yet support configuring the settings for indices before they are in use.

See Also:

  • Field Details

  • Method Details

    • of

      public static UpdateSettingsRequest of(Function<UpdateSettingsRequest.Builder,ObjectBuilder<UpdateSettingsRequest>> fn)

    • masterTimeout

      @Nullable public final Time masterTimeout()
      The period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.

      API name: master_timeout

    • security

      @Nullable public final SecuritySettings security()
      Settings for the index used for most security configuration, including native realm users and roles configured with the API.

      API name: security

    • securityProfile

      @Nullable public final SecuritySettings securityProfile()
      Settings for the index used to store profile information.

      API name: security-profile

    • securityTokens

      @Nullable public final SecuritySettings securityTokens()
      Settings for the index used to store tokens.

      API name: security-tokens

    • timeout

      @Nullable public final Time timeout()
      The period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.

      API name: timeout

    • serialize

      public void serialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
      Serialize this object to JSON.
      Specified by:
      serialize in interface JsonpSerializable

    • serializeInternal

      protected void serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)

    • setupUpdateSettingsRequestDeserializer

      protected static void setupUpdateSettingsRequestDeserializer(ObjectDeserializer<UpdateSettingsRequest.Builder> op)