Class ChangePasswordRequest.Builder
java.lang.Object
co.elastic.clients.util.ObjectBuilderBase
co.elastic.clients.elasticsearch.security.ChangePasswordRequest.Builder
- All Implemented Interfaces:
ObjectBuilder<ChangePasswordRequest>
- Enclosing class:
- ChangePasswordRequest
public static class ChangePasswordRequest.Builder extends ObjectBuilderBase implements ObjectBuilder<ChangePasswordRequest>
Builder for
ChangePasswordRequest
.-
Constructor Summary
Constructors Constructor Description Builder()
-
Method Summary
Modifier and Type Method Description ChangePasswordRequest
build()
Builds aChangePasswordRequest
.ChangePasswordRequest.Builder
password(java.lang.String value)
The new password value.ChangePasswordRequest.Builder
passwordHash(java.lang.String value)
A hash of the new password value.ChangePasswordRequest.Builder
refresh(Refresh value)
Iftrue
(the default) then refresh the affected shards to make this operation visible to search, ifwait_for
then wait for a refresh to make this operation visible to search, iffalse
then do nothing with refreshes.ChangePasswordRequest.Builder
username(java.lang.String value)
The user whose password you want to change.Methods inherited from class co.elastic.clients.util.ObjectBuilderBase
_checkSingleUse, _listAdd, _listAddAll, _mapPut, _mapPutAll
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
password
The new password value. Passwords must be at least 6 characters long.API name:
password
-
passwordHash
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 thexpack.security.authc.password_hashing.algorithm
setting.API name:
password_hash
-
refresh
Iftrue
(the default) then refresh the affected shards to make this operation visible to search, ifwait_for
then wait for a refresh to make this operation visible to search, iffalse
then do nothing with refreshes.API name:
refresh
-
username
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
-
build
Builds aChangePasswordRequest
.- Specified by:
build
in interfaceObjectBuilder<ChangePasswordRequest>
- Throws:
java.lang.NullPointerException
- if some of the required fields are null.
-