Module org.elasticsearch.xcore

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

Class PutRoleRequest

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.role.PutRoleRequest

All Implemented Interfaces:

Writeable, RefCounted, TaskAwareRequest, TransportRequest

public class PutRoleRequest
extends UntypedActionRequest

Request object for adding a role to the security index

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
PutRoleRequest()

Method Summary

Modifier and Type	Method	Description
void	addApplicationPrivileges(RoleDescriptor.ApplicationResourcePrivileges... privileges)
void	addIndex(String[] indices, String[] privileges, String[] grantedFields, String[] deniedFields, BytesReference query, boolean allowRestrictedIndices)
void	addIndex(RoleDescriptor.IndicesPrivileges... privileges)
void	addRemoteIndex(String[] remoteClusters, String[] indices, String[] privileges, String[] grantedFields, String[] deniedFields, BytesReference query, boolean allowRestrictedIndices)
void	addRemoteIndex(RoleDescriptor.RemoteIndicesPrivileges... privileges)
List<RoleDescriptor.ApplicationResourcePrivileges>	applicationPrivileges()
String[]	cluster()
void	cluster(String... clusterPrivilegesArray)
void	conditionalCluster(ConfigurableClusterPrivilege... configurableClusterPrivilegesArray)
ConfigurableClusterPrivilege[]	conditionalClusterPrivileges()
String	description()
void	description(String description)
WriteRequest.RefreshPolicy	getRefreshPolicy()
boolean	hasRemoteIndicesPrivileges()
RoleDescriptor.IndicesPrivileges[]	indices()
Map<String,Object>	metadata()
void	metadata(Map<String,Object> metadata)
String	name()
void	name(String name)
void	putRemoteCluster(RemoteClusterPermissions remoteClusterPermissions)
RoleDescriptor.RemoteIndicesPrivileges[]	remoteIndices()
RoleDescriptor	roleDescriptor()
String[]	runAs()
void	runAs(String... usernames)
PutRoleRequest	setRefreshPolicy(String refreshPolicy)
PutRoleRequest	setRefreshPolicy(WriteRequest.RefreshPolicy refreshPolicy)
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

PutRoleRequest

public PutRoleRequest()

Method Details

validate

public ActionRequestValidationException validate()

Specified by:

validate in class ActionRequest

name

public void name(String name)

description

public void description(String description)

cluster

public void cluster(String... clusterPrivilegesArray)

conditionalCluster

public void conditionalCluster(ConfigurableClusterPrivilege... configurableClusterPrivilegesArray)

addIndex

public void addIndex(RoleDescriptor.IndicesPrivileges... privileges)

addRemoteIndex

public void addRemoteIndex(RoleDescriptor.RemoteIndicesPrivileges... privileges)

putRemoteCluster

public void putRemoteCluster(RemoteClusterPermissions remoteClusterPermissions)

addRemoteIndex

public void addRemoteIndex(String[] remoteClusters,
 String[] indices,
 String[] privileges,
 String[] grantedFields,
 String[] deniedFields,
 @Nullable
 BytesReference query,
 boolean allowRestrictedIndices)

addIndex

public void addIndex(String[] indices,
 String[] privileges,
 String[] grantedFields,
 String[] deniedFields,
 @Nullable
 BytesReference query,
 boolean allowRestrictedIndices)

addApplicationPrivileges

public void addApplicationPrivileges(RoleDescriptor.ApplicationResourcePrivileges... privileges)

runAs

public void runAs(String... usernames)

setRefreshPolicy

public PutRoleRequest setRefreshPolicy(@Nullable
 String refreshPolicy)

setRefreshPolicy

public PutRoleRequest setRefreshPolicy(WriteRequest.RefreshPolicy refreshPolicy)

getRefreshPolicy

public WriteRequest.RefreshPolicy getRefreshPolicy()

metadata

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

name

public String name()

description

public String description()

cluster

public String[] cluster()

indices

public RoleDescriptor.IndicesPrivileges[] indices()

remoteIndices

public RoleDescriptor.RemoteIndicesPrivileges[] remoteIndices()

hasRemoteIndicesPrivileges

public boolean hasRemoteIndicesPrivileges()

applicationPrivileges

public List<RoleDescriptor.ApplicationResourcePrivileges> applicationPrivileges()

conditionalClusterPrivileges

public ConfigurableClusterPrivilege[] conditionalClusterPrivileges()

runAs

public String[] runAs()

metadata

public Map<String,Object> metadata()

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Specified by:

writeTo in interface Writeable

Overrides:

writeTo in class ActionRequest

Throws:

IOException

roleDescriptor

public RoleDescriptor roleDescriptor()