Module org.elasticsearch.xcore

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

Class GetUsersRequest

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.GetUsersRequest

All Implemented Interfaces:

Writeable, RefCounted, TaskAwareRequest, TransportRequest, UserRequest

public class GetUsersRequest
extends UntypedActionRequest
implements UserRequest

Request to retrieve a native user.

Nested Class Summary

Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable

Writeable.Reader<V>, Writeable.Writer<V>

Field Summary

Fields inherited from interface org.elasticsearch.core.RefCounted

ALWAYS_REFERENCED

Constructor Summary

Constructors

Constructor	Description
GetUsersRequest()
GetUsersRequest(StreamInput in)

Method Summary

Modifier and Type	Method	Description
String[]	getUsernames()
boolean	isWithProfileUid()
void	setUsernames(String[] usernames)
void	setWithProfileUid(boolean withProfileUid)
String[]	usernames()	Accessor for the usernames that this request pertains to.
void	usernames(String... usernames)
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, toString

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

Constructor Details

GetUsersRequest

public GetUsersRequest(StreamInput in)
                throws IOException

Throws:

IOException

GetUsersRequest

public GetUsersRequest()

Method Details

validate

public ActionRequestValidationException validate()

Specified by:

validate in class ActionRequest

usernames

public void usernames(String... usernames)

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

getUsernames

public String[] getUsernames()

setUsernames

public void setUsernames(String[] usernames)

isWithProfileUid

public boolean isWithProfileUid()

setWithProfileUid

public void setWithProfileUid(boolean withProfileUid)

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Specified by:

writeTo in interface Writeable

Overrides:

writeTo in class ActionRequest

Throws:

IOException