Module org.elasticsearch.xcore
Class PutUserRequest
java.lang.Object
org.elasticsearch.transport.TransportMessage
org.elasticsearch.transport.TransportRequest
org.elasticsearch.action.ActionRequest
org.elasticsearch.action.LegacyActionRequest
org.elasticsearch.xpack.core.security.action.user.PutUserRequest
- All Implemented Interfaces:
WriteRequest<PutUserRequest>,Writeable,org.elasticsearch.core.RefCounted,TaskAwareRequest,UserRequest
public class PutUserRequest
extends LegacyActionRequest
implements UserRequest, WriteRequest<PutUserRequest>
Request object to put a native user.
-
Nested Class Summary
Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable
Writeable.Reader<V>, Writeable.Writer<V>Nested classes/interfaces inherited from interface org.elasticsearch.action.support.WriteRequest
WriteRequest.RefreshPolicy -
Field Summary
Fields inherited from interface org.elasticsearch.core.RefCounted
ALWAYS_REFERENCED -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionemail()voidbooleanenabled()voidenabled(boolean enabled) fullName()voidShould this request trigger a refresh (WriteRequest.RefreshPolicy.IMMEDIATE, the default), wait for a refresh ( WriteRequest.RefreshPolicy.WAIT_UNTIL), or proceed ignore refreshes entirely (WriteRequest.RefreshPolicy.NONE).metadata()voidchar[]voidpasswordHash(char[] passwordHash) String[]roles()voidsetRefreshPolicy(WriteRequest.RefreshPolicy refreshPolicy) toString()username()voidString[]Accessor for the usernames that this request pertains to.validate()voidwriteTo(StreamOutput out) Methods inherited from class org.elasticsearch.action.ActionRequest
getShouldStoreResultMethods inherited from class org.elasticsearch.transport.TransportRequest
getParentTask, getRequestId, setParentTask, setRequestIdMethods inherited from class org.elasticsearch.transport.TransportMessage
decRef, hasReferences, incRef, remoteAddress, remoteAddress, tryIncRefMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitMethods inherited from interface org.elasticsearch.core.RefCounted
mustIncRefMethods inherited from interface org.elasticsearch.tasks.TaskAwareRequest
createTask, getDescription, setParentTaskMethods inherited from interface org.elasticsearch.action.support.WriteRequest
setRefreshPolicy
-
Constructor Details
-
PutUserRequest
- Throws:
IOException
-
PutUserRequest
public PutUserRequest()
-
-
Method Details
-
validate
- Specified by:
validatein interfaceWriteRequest<PutUserRequest>- Specified by:
validatein classActionRequest
-
username
-
roles
-
fullName
-
email
-
metadata
-
passwordHash
public void passwordHash(@Nullable char[] passwordHash) -
enabled
public void enabled(boolean enabled) -
getRefreshPolicy
Should this request trigger a refresh (WriteRequest.RefreshPolicy.IMMEDIATE, the default), wait for a refresh ( WriteRequest.RefreshPolicy.WAIT_UNTIL), or proceed ignore refreshes entirely (WriteRequest.RefreshPolicy.NONE).- Specified by:
getRefreshPolicyin interfaceWriteRequest<PutUserRequest>
-
setRefreshPolicy
- Specified by:
setRefreshPolicyin interfaceWriteRequest<PutUserRequest>
-
username
-
roles
-
fullName
-
email
-
metadata
-
passwordHash
@Nullable public char[] passwordHash() -
enabled
public boolean enabled() -
usernames
Description copied from interface:UserRequestAccessor for the usernames that this request pertains to.nullshould never be returned!- Specified by:
usernamesin interfaceUserRequest
-
writeTo
- Specified by:
writeToin interfaceWriteable- Overrides:
writeToin classActionRequest- Throws:
IOException
-
toString
- Overrides:
toStringin classTransportRequest
-