Module org.elasticsearch.xcore

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

Class SetEnabledRequest

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

All Implemented Interfaces:

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

public class SetEnabledRequest
extends UntypedActionRequest
implements UserRequest, WriteRequest<SetEnabledRequest>

The request that allows to set a user as enabled or disabled

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
SetEnabledRequest()
SetEnabledRequest(StreamInput in)

Method Summary

Modifier and Type	Method	Description
Boolean	enabled()
void	enabled(boolean enabled)	Set whether the user should be enabled or not.
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).
SetEnabledRequest	setRefreshPolicy(WriteRequest.RefreshPolicy refreshPolicy)
String	username()
void	username(String username)	Set the username that the request applies to.
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, 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

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

setRefreshPolicy

Constructor Details

SetEnabledRequest

public SetEnabledRequest()

SetEnabledRequest

public SetEnabledRequest(StreamInput in)
                  throws IOException

Throws:

IOException

Method Details

validate

public ActionRequestValidationException validate()

Specified by:

validate in interface WriteRequest<SetEnabledRequest>

Specified by:

validate in class ActionRequest

enabled

public Boolean enabled()

Returns:

whether the user should be set to enabled or not

enabled

public void enabled(boolean enabled)

Set whether the user should be enabled or not.

username

public String username()

Returns:

the username that this request applies to.

username

public void username(String username)

Set the username that the request applies to. Must not be null

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

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<SetEnabledRequest>

setRefreshPolicy

public SetEnabledRequest setRefreshPolicy(WriteRequest.RefreshPolicy refreshPolicy)

Specified by:

setRefreshPolicy in interface WriteRequest<SetEnabledRequest>

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Specified by:

writeTo in interface Writeable

Overrides:

writeTo in class ActionRequest

Throws:

IOException