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

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

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

Classes

struct  Options
 Optional parameters. More...
 

Public Member Functions

 CreateUserInternalRequest ()
 Constructs a CreateUserInternalRequest object with default parameters. More...
 
 CreateUserInternalRequest (string name, string password, IDictionary< string, string > options=null)
 Constructs a CreateUserInternalRequest 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 user to be created. More...
 
string password [get, set]
 Initial password of the user to be created. 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.createUserInternal(string,string,IDictionary{string, string}).


Creates a new internal user (a user whose credentials are managed by the database system).

Definition at line 20 of file CreateUserInternal.cs.

Constructor & Destructor Documentation

kinetica.CreateUserInternalRequest.CreateUserInternalRequest ( )
inline

Constructs a CreateUserInternalRequest object with default parameters.

Definition at line 69 of file CreateUserInternal.cs.

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

Constructs a CreateUserInternalRequest object with the specified parameters.

Parameters
nameName of the user 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.
passwordInitial password of the user to be created. May be an empty string for no password.
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 91 of file CreateUserInternal.cs.

Property Documentation

string kinetica.CreateUserInternalRequest.name
getset

Name of the user 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 48 of file CreateUserInternal.cs.

IDictionary<string, string> kinetica.CreateUserInternalRequest.options
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 64 of file CreateUserInternal.cs.

string kinetica.CreateUserInternalRequest.password
getset

Initial password of the user to be created.

May be an empty string for no password.

Definition at line 52 of file CreateUserInternal.cs.


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