A set of parameters for Kinetica.createUserInternal. More…
Inheritance diagram for kinetica.CreateUserInternalRequest:
[legend]
Collaboration diagram for kinetica.CreateUserInternalRequest:
[legend]
Classes | |
| struct | Options |
| A set of string constants for the parameter CreateUserInternalRequest.options. More… | |
Public Member Functions | |
| CreateUserInternalRequest () | |
| Constructs a CreateUserInternalRequest object with default parameters. | |
| CreateUserInternalRequest (string name, string password, IDictionary< string, string > options=null) | |
| Constructs a CreateUserInternalRequest object with the specified parameters. | |
| CreateUserInternalRequest () | |
| Constructs a CreateUserInternalRequest object with default parameters. | |
| CreateUserInternalRequest (string name, string password, IDictionary< string, string > options=null) | |
| Constructs a CreateUserInternalRequest object with the specified parameters. | |
| Public Member Functions inherited from kinetica.KineticaData | |
| KineticaData (KineticaType type) | |
| Constructor from Kinetica Type. | |
| KineticaData (System.Type type=null) | |
| Default constructor, with optional System.Type. | |
| object | Get (int fieldPos) |
| Retrieve a specific property from this object. | |
| void | Put (int fieldPos, object fieldValue) |
| Write a specific property to this object. | |
| KineticaData (KineticaType type) | |
| Constructor from Kinetica Type. | |
| KineticaData (System.Type type=null) | |
| Default constructor, with optional System.Type. | |
| object | Get (int fieldPos) |
| Retrieve a specific property from this object. | |
| void | Put (int fieldPos, object fieldValue) |
| Write a specific property to this object. | |
Properties | |
| string | name [get, set] |
| Name of the user to be created. | |
| string | password [get, set] |
| Initial password of the user to be created. | |
| IDictionary< string, string > | options = new Dictionary<string, string>() [get, set] |
| Optional parameters. | |
| Properties inherited from kinetica.KineticaData | |
| Schema | Schema [get] |
| Avro Schema for this class. | |
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. | |
| static ? RecordSchema | SchemaFromType (System.Type t, KineticaType? ktype=null) |
| Create an Avro Schema from a System.Type and a KineticaType. | |
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]
| inline |
Constructs a CreateUserInternalRequest object with default parameters.
Definition at line 182 of file CreateUserInternal.cs.
◆ CreateUserInternalRequest() [2/4]
| 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.
|
Definition at line 270 of file CreateUserInternal.cs.
◆ CreateUserInternalRequest() [3/4]
| inline |
Constructs a CreateUserInternalRequest object with default parameters.
Definition at line 182 of file CreateUserInternal.cs.
◆ CreateUserInternalRequest() [4/4]
| 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.
|
Definition at line 270 of file CreateUserInternal.cs.
Property Documentation
◆ 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 94 of file CreateUserInternal.cs.
◆ options
| getset |
Optional parameters.
- ACTIVATED: Is the user allowed to login. Supported values:The default value is TRUE.
- CREATE_HOME_DIRECTORY: When TRUE, a home directory in KiFS is created for this user. Supported values: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 178 of file CreateUserInternal.cs.
◆ password
| getset |
Initial password of the user to be created.
May be an empty string for no password.
Definition at line 98 of file CreateUserInternal.cs.
The documentation for this class was generated from the following files:
- _build/public-os_ubuntu24.04-arch_amd64-cc_gcc_13.3.0/install/Kinetica/Protocol/CreateUserInternal.cs
- Kinetica/Protocol/CreateUserInternal.cs