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

Inheritance diagram for kinetica.CreateUserInternalRequest:

Collaboration diagram for kinetica.CreateUserInternalRequest:

Classes
struct	Options
	A set of string constants for the parameter options. 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...

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

	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 = new Dictionary<string, string>() `[get, set]`
	Optional parameters. More...

Properties inherited from kinetica.KineticaData
Schema	Schema `[get]`
	Avro Schema for this class More...

Properties inherited from Avro.Specific.ISpecificRecord
Schema	Schema `[get]`

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

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.

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

Definition at line 16 of file CreateUserInternal.cs.

Constructor & Destructor Documentation

◆ CreateUserInternalRequest() [1/4]

kinetica.CreateUserInternalRequest.CreateUserInternalRequest ( )

inline

Constructs a CreateUserInternalRequest object with default parameters.

Definition at line 150 of file CreateUserInternal.cs.

◆ CreateUserInternalRequest() [2/4]

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

inline

Constructs a CreateUserInternalRequest object with the specified parameters.

Parameters

name	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.
password	Initial password of the user to be created. May be an empty string for no password.
options	Optional parameters. ACTIVATED: Is the user allowed to login. Supported values: TRUE: User may login FALSE: User may not login The default value is TRUE. CREATE_HOME_DIRECTORY: When TRUE, a home directory in KiFS is created for this user. Supported values: TRUE FALSE The default value is TRUE. DEFAULT_SCHEMA: Default schema to associate with this user DIRECTORY_DATA_LIMIT: The maximum capacity to apply to the created directory if CREATE_HOME_DIRECTORY is TRUE. Set to -1 to indicate no upper limit. If empty, the system default limit is applied. RESOURCE_GROUP: Name of an existing resource group to associate with this user The default value is an empty Dictionary.

Definition at line 223 of file CreateUserInternal.cs.

◆ CreateUserInternalRequest() [3/4]

kinetica.CreateUserInternalRequest.CreateUserInternalRequest ( )

inline

Constructs a CreateUserInternalRequest object with default parameters.

Definition at line 150 of file CreateUserInternal.cs.

◆ CreateUserInternalRequest() [4/4]

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

inline

Constructs a CreateUserInternalRequest object with the specified parameters.

Parameters

name	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.
password	Initial password of the user to be created. May be an empty string for no password.
options	Optional parameters. ACTIVATED: Is the user allowed to login. Supported values: TRUE: User may login FALSE: User may not login The default value is TRUE. CREATE_HOME_DIRECTORY: When TRUE, a home directory in KiFS is created for this user. Supported values: TRUE FALSE The default value is TRUE. DEFAULT_SCHEMA: Default schema to associate with this user DIRECTORY_DATA_LIMIT: The maximum capacity to apply to the created directory if CREATE_HOME_DIRECTORY is TRUE. Set to -1 to indicate no upper limit. If empty, the system default limit is applied. RESOURCE_GROUP: Name of an existing resource group to associate with this user The default value is an empty Dictionary.

Definition at line 223 of file CreateUserInternal.cs.

Property Documentation

◆ name

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 77 of file CreateUserInternal.cs.

◆ options

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

getset

Optional parameters.

ACTIVATED: Is the user allowed to login. Supported values:
- TRUE: User may login
- FALSE: User may not login
The default value is TRUE.
CREATE_HOME_DIRECTORY: When TRUE, a home directory in KiFS is created for this user. Supported values:
- TRUE
- FALSE
The default value is TRUE.
DEFAULT_SCHEMA: Default schema to associate with this user
DIRECTORY_DATA_LIMIT: The maximum capacity to apply to the created directory if CREATE_HOME_DIRECTORY is TRUE. Set to -1 to indicate no upper limit. If empty, the system default limit is applied.
RESOURCE_GROUP: Name of an existing resource group to associate with this user

The default value is an empty Dictionary.

Definition at line 146 of file CreateUserInternal.cs.

◆ password

string kinetica.CreateUserInternalRequest.password

getset

Initial password of the user to be created.

May be an empty string for no password.

Definition at line 82 of file CreateUserInternal.cs.

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

_build/public-os_ubuntu24.04-arch_amd64-cc_gcc_13.3.0/install/Kinetica/Protocol/CreateUserInternal.cs

Classes

Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ CreateUserInternalRequest() [1/4]

◆ CreateUserInternalRequest() [2/4]

◆ CreateUserInternalRequest() [3/4]

◆ CreateUserInternalRequest() [4/4]

Property Documentation

◆ name

◆ options

◆ password