Kinetica   C#   API  Version 7.2.3.0
kinetica.CreateRoleRequest Class Reference

A set of parameters for Kinetica.createRole. More...

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

Classes

struct  Options
 A set of string constants for the parameter options. More...
 

Public Member Functions

 CreateRoleRequest ()
 Constructs a CreateRoleRequest object with default parameters. More...
 
 CreateRoleRequest (string name, IDictionary< string, string > options=null)
 Constructs a CreateRoleRequest 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 created. More...
 
IDictionary< string, string > options = new Dictionary<string, string>() [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.createRole.

Creates a new role.

Definition at line 15 of file CreateRole.cs.

Constructor & Destructor Documentation

◆ CreateRoleRequest() [1/2]

kinetica.CreateRoleRequest.CreateRoleRequest ( )
inline

Constructs a CreateRoleRequest object with default parameters.

Definition at line 47 of file CreateRole.cs.

◆ CreateRoleRequest() [2/2]

kinetica.CreateRoleRequest.CreateRoleRequest ( string  name,
IDictionary< string, string >  options = null 
)
inline

Constructs a CreateRoleRequest object with the specified parameters.

Parameters
nameName of the role to be created. Must contain only lowercase letters, digits, and underscores, and cannot begin with a digit. Must not be the same name as an existing user or role.
optionsOptional parameters.
  • RESOURCE_GROUP: Name of an existing resource group to associate with this user
The default value is an empty Dictionary.

Definition at line 66 of file CreateRole.cs.

Property Documentation

◆ name

string kinetica.CreateRoleRequest.name
getset

Name of the role to be created.

Must contain only lowercase letters, digits, and underscores, and cannot begin with a digit. Must not be the same name as an existing user or role.

Definition at line 31 of file CreateRole.cs.

◆ options

IDictionary<string, string> kinetica.CreateRoleRequest.options = new Dictionary<string, string>()
getset

Optional parameters.

  • RESOURCE_GROUP: Name of an existing resource group to associate with this user

The default value is an empty Dictionary.

Definition at line 43 of file CreateRole.cs.


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