Module org.elasticsearch.xcore

Package org.elasticsearch.xpack.core.security.action.user

Class PutUserRequest

java.lang.Object

org.elasticsearch.transport.TransportMessage

org.elasticsearch.transport.AbstractTransportRequest

org.elasticsearch.action.ActionRequest

org.elasticsearch.action.UntypedActionRequest

org.elasticsearch.xpack.core.security.action.user.PutUserRequest

All Implemented Interfaces:

WriteRequest<PutUserRequest>, Writeable, RefCounted, TaskAwareRequest, TransportRequest, UserRequest

public class PutUserRequest
extends UntypedActionRequest
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

Constructor	Description
PutUserRequest()
PutUserRequest(StreamInput in)

Method Summary

Modifier and Type	Method	Description
String	email()
void	email(String email)
boolean	enabled()
void	enabled(boolean enabled)
String	fullName()
void	fullName(String fullName)
WriteRequest.RefreshPolicy	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).
Map<String,Object>	metadata()
void	metadata(Map<String,Object> metadata)
char[]	passwordHash()
void	passwordHash(char[] passwordHash)
String[]	roles()
void	roles(String... roles)
PutUserRequest	setRefreshPolicy(WriteRequest.RefreshPolicy refreshPolicy)
String	toString()
String	username()
void	username(String username)
String[]	usernames()	Accessor for the usernames that this request pertains to.
ActionRequestValidationException	validate()
void	writeTo(StreamOutput out)

Methods inherited from class org.elasticsearch.action.ActionRequest

getShouldStoreResult

Methods inherited from class org.elasticsearch.transport.AbstractTransportRequest

copyFieldsFrom, getParentTask, getRequestId, remoteAddress, remoteAddress, setParentTask, setRequestId

Methods inherited from class org.elasticsearch.transport.TransportMessage

decRef, hasReferences, incRef, tryIncRef

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.elasticsearch.core.RefCounted

decRef, hasReferences, incRef, mustIncRef, tryIncRef

Methods inherited from interface org.elasticsearch.tasks.TaskAwareRequest

createTask, createTask, getDescription, setParentTask

Methods inherited from interface org.elasticsearch.action.support.WriteRequest

setRefreshPolicy

Constructor Details

PutUserRequest

public PutUserRequest(StreamInput in)
               throws IOException

Throws:

IOException

PutUserRequest

public PutUserRequest()

Method Details

validate

public ActionRequestValidationException validate()

Specified by:

validate in interface WriteRequest<PutUserRequest>

Specified by:

validate in class ActionRequest

username

public void username(String username)

roles

public void roles(String... roles)

fullName

public void fullName(String fullName)

email

public void email(String email)

metadata

public void metadata(Map<String,Object> metadata)

passwordHash

public void passwordHash(@Nullable
 char[] passwordHash)

enabled

public void enabled(boolean enabled)

getRefreshPolicy

public WriteRequest.RefreshPolicy 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:

getRefreshPolicy in interface WriteRequest<PutUserRequest>

setRefreshPolicy

public PutUserRequest setRefreshPolicy(WriteRequest.RefreshPolicy refreshPolicy)

Specified by:

setRefreshPolicy in interface WriteRequest<PutUserRequest>

username

public String username()

roles

public String[] roles()

fullName

public String fullName()

email

public String email()

metadata

public Map<String,Object> metadata()

passwordHash

@Nullable
public char[] passwordHash()

enabled

public boolean enabled()

usernames

public String[] usernames()

Description copied from interface: UserRequest

Accessor for the usernames that this request pertains to. null should never be returned!

Specified by:

usernames in interface UserRequest

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Specified by:

writeTo in interface Writeable

Overrides:

writeTo in class ActionRequest

Throws:

IOException

toString

public String toString()

Overrides:

toString in class AbstractTransportRequest