Kinetica C# API  Version 7.0.19.0
 All Classes Namespaces Files Functions Variables Enumerations Enumerator Properties Pages
kinetica.AlterRoleRequest Class Reference

A set of parameters for Kinetica.alterRole(string,string,string,IDictionary{string, string}). More...

+ Inheritance diagram for kinetica.AlterRoleRequest:
+ Collaboration diagram for kinetica.AlterRoleRequest:

Classes

struct  Action
 Modification operation to be applied to the role. More...
 

Public Member Functions

 AlterRoleRequest ()
 Constructs an AlterRoleRequest object with default parameters. More...
 
 AlterRoleRequest (string name, string action, string _value, IDictionary< string, string > options=null)
 Constructs an AlterRoleRequest object with the specified parameters. More...
 
- Public Member Functions inherited from kinetica.KineticaData
 KineticaData (KineticaType type)
 Constructor from Kinetica Type More...
 
 KineticaData (System.Type type=null)
 Default constructor, with optional System.Type More...
 
object Get (int fieldPos)
 Retrieve a specific property from this object More...
 
void Put (int fieldPos, object fieldValue)
 Write a specific property to this object More...
 

Properties

string name [get, set]
 Name of the role to be altered. More...
 
string action [get, set]
 Modification operation to be applied to the role. More...
 
string _value [get, set]
 The value of the modification, depending on . More...
 
IDictionary< string, string > options [get, set]
 Optional parameters. More...
 
- Properties inherited from kinetica.KineticaData
Schema Schema [get]
 Avro Schema for this class More...
 

Additional Inherited Members

- Static Public Member Functions inherited from kinetica.KineticaData
static RecordSchema SchemaFromType (System.Type t, KineticaType ktype=null)
 Create an Avro Schema from a System.Type and a KineticaType. More...
 

Detailed Description

A set of parameters for Kinetica.alterRole(string,string,string,IDictionary{string, string}).


Alters a Role.

Definition at line 19 of file AlterRole.cs.

Constructor & Destructor Documentation

kinetica.AlterRoleRequest.AlterRoleRequest ( )
inline

Constructs an AlterRoleRequest object with default parameters.

Definition at line 73 of file AlterRole.cs.

kinetica.AlterRoleRequest.AlterRoleRequest ( string  name,
string  action,
string  _value,
IDictionary< string, string >  options = null 
)
inline

Constructs an AlterRoleRequest object with the specified parameters.

Parameters
nameName of the role to be altered. Must be an existing role.
actionModification operation to be applied to the role. Supported values:
  • SET_RESOURCE_GROUP: Sets the resource group for an internal role. The resource group must exist, otherwise, an empty string assigns the role to the default resource group.
_valueThe value of the modification, depending on .
optionsOptional parameters. The default value is an empty Dictionary.

Definition at line 97 of file AlterRole.cs.

Property Documentation

string kinetica.AlterRoleRequest._value
getset

The value of the modification, depending on .

Definition at line 64 of file AlterRole.cs.

string kinetica.AlterRoleRequest.action
getset

Modification operation to be applied to the role.

Supported values:

  • SET_RESOURCE_GROUP: Sets the resource group for an internal role. The resource group must exist, otherwise, an empty string assigns the role to the default resource group.

Definition at line 60 of file AlterRole.cs.

string kinetica.AlterRoleRequest.name
getset

Name of the role to be altered.

Must be an existing role.

Definition at line 47 of file AlterRole.cs.

IDictionary<string, string> kinetica.AlterRoleRequest.options
getset

Optional parameters.

The default value is an empty Dictionary.

Definition at line 68 of file AlterRole.cs.


The documentation for this class was generated from the following file: