A set of parameters for Kinetica.createUserExternal. More…
Inheritance diagram for kinetica.CreateUserExternalRequest:
[legend]
Collaboration diagram for kinetica.CreateUserExternalRequest:
[legend]
Classes | |
| struct | Options |
| A set of string constants for the parameter CreateUserExternalRequest.options. More… | |
Public Member Functions | |
| CreateUserExternalRequest () | |
| Constructs a CreateUserExternalRequest object with default parameters. | |
| CreateUserExternalRequest (string name, IDictionary< string, string > options=null) | |
| Constructs a CreateUserExternalRequest object with the specified parameters. | |
| CreateUserExternalRequest () | |
| Constructs a CreateUserExternalRequest object with default parameters. | |
| CreateUserExternalRequest (string name, IDictionary< string, string > options=null) | |
| Constructs a CreateUserExternalRequest 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. | |
| 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.createUserExternal.
Creates a new external user (a user whose credentials are managed by an external LDAP).
Definition at line 16 of file CreateUserExternal.cs.
Constructor & Destructor Documentation
◆ CreateUserExternalRequest() [1/4]
| inline |
Constructs a CreateUserExternalRequest object with default parameters.
Definition at line 178 of file CreateUserExternal.cs.
◆ CreateUserExternalRequest() [2/4]
| inline |
Constructs a CreateUserExternalRequest object with the specified parameters.
Parameters
| name | Name of the user to be created. Must exactly match the user’s name in the external LDAP, prefixed with a . Must not be the same name as an existing user. |
| options | Optional parameters.
|
Definition at line 264 of file CreateUserExternal.cs.
◆ CreateUserExternalRequest() [3/4]
| inline |
Constructs a CreateUserExternalRequest object with default parameters.
Definition at line 178 of file CreateUserExternal.cs.
◆ CreateUserExternalRequest() [4/4]
| inline |
Constructs a CreateUserExternalRequest object with the specified parameters.
Parameters
| name | Name of the user to be created. Must exactly match the user’s name in the external LDAP, prefixed with a . Must not be the same name as an existing user. |
| options | Optional parameters.
|
Definition at line 264 of file CreateUserExternal.cs.
Property Documentation
◆ name
| getset |
Name of the user to be created.
Must exactly match the user’s name in the external LDAP, prefixed with a . Must not be the same name as an existing user.
Definition at line 94 of file CreateUserExternal.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 174 of file CreateUserExternal.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/CreateUserExternal.cs
- Kinetica/Protocol/CreateUserExternal.cs