Module org.elasticsearch.xcore

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

Class PutPrivilegesRequest

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.privilege.PutPrivilegesRequest

All Implemented Interfaces:

WriteRequest<PutPrivilegesRequest>, Writeable, RefCounted, TaskAwareRequest, TransportRequest, ApplicationPrivilegesRequest

public final class PutPrivilegesRequest
extends UntypedActionRequest
implements ApplicationPrivilegesRequest, WriteRequest<PutPrivilegesRequest>

Request object to put a one or more application privileges.

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

Method Summary

Modifier and Type	Method	Description
Collection<String>	getApplicationNames()
List<ApplicationPrivilegeDescriptor>	getPrivileges()
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).
void	setPrivileges(Collection<ApplicationPrivilegeDescriptor> privileges)
PutPrivilegesRequest	setRefreshPolicy(WriteRequest.RefreshPolicy refreshPolicy)
String	toString()
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

PutPrivilegesRequest

public PutPrivilegesRequest(StreamInput in)
                     throws IOException

Throws:

IOException

PutPrivilegesRequest

public PutPrivilegesRequest()

Method Details

validate

public ActionRequestValidationException validate()

Specified by:

validate in interface WriteRequest<PutPrivilegesRequest>

Specified by:

validate in class ActionRequest

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

setRefreshPolicy

public PutPrivilegesRequest setRefreshPolicy(WriteRequest.RefreshPolicy refreshPolicy)

Specified by:

setRefreshPolicy in interface WriteRequest<PutPrivilegesRequest>

getPrivileges

public List<ApplicationPrivilegeDescriptor> getPrivileges()

setPrivileges

public void setPrivileges(Collection<ApplicationPrivilegeDescriptor> privileges)

getApplicationNames

public Collection<String> getApplicationNames()

Specified by:

getApplicationNames in interface ApplicationPrivilegesRequest

toString

public String toString()

Overrides:

toString in class AbstractTransportRequest

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Specified by:

writeTo in interface Writeable

Overrides:

writeTo in class ActionRequest

Throws:

IOException