Package co.elastic.clients.elasticsearch.security

Class ChangePasswordRequest.Builder

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

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • password

      public final ChangePasswordRequest.Builder password​(@Nullable java.lang.String value)
      The new password value. Passwords must be at least 6 characters long.

      API name: password

    • passwordHash

      public final ChangePasswordRequest.Builder passwordHash​(@Nullable java.lang.String value)
      A hash of the new password value. This must be produced using the same hashing algorithm as has been configured for password storage. For more details, see the explanation of the xpack.security.authc.password_hashing.algorithm setting.

      API name: password_hash

    • refresh

      public final ChangePasswordRequest.Builder refresh​(@Nullable Refresh value)
      If true (the default) then refresh the affected shards to make this operation visible to search, if wait_for then wait for a refresh to make this operation visible to search, if false then do nothing with refreshes.

      API name: refresh

    • username

      public final ChangePasswordRequest.Builder username​(@Nullable java.lang.String value)
      The user whose password you want to change. If you do not specify this parameter, the password is changed for the current user.

      API name: username

    • self

      protected ChangePasswordRequest.Builder self()
      Specified by:
      self in class WithJsonObjectBuilderBase<ChangePasswordRequest.Builder>

    • build

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