A set of parameters for Kinetica.alterUser. More…
Inheritance diagram for kinetica.AlterUserRequest:
[legend]
Collaboration diagram for kinetica.AlterUserRequest:
[legend]
Classes | |
| struct | Action |
| A set of string constants for the parameter AlterUserRequest.action. More… | |
Public Member Functions | |
| AlterUserRequest () | |
| Constructs an AlterUserRequest object with default parameters. | |
| AlterUserRequest (string name, string action, string _value, IDictionary< string, string > options=null) | |
| Constructs an AlterUserRequest object with the specified parameters. | |
| AlterUserRequest () | |
| Constructs an AlterUserRequest object with default parameters. | |
| AlterUserRequest (string name, string action, string _value, IDictionary< string, string > options=null) | |
| Constructs an AlterUserRequest 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 altered. | |
| string | action [get, set] |
| Modification operation to be applied to the user. | |
| string | _value [get, set] |
| The value of the modification, depending on AlterUserRequest.action. | |
| 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.alterUser.
Alters a user.
Definition at line 15 of file AlterUser.cs.
Constructor & Destructor Documentation
◆ AlterUserRequest() [1/4]
| inline |
Constructs an AlterUserRequest object with default parameters.
Definition at line 120 of file AlterUser.cs.
◆ AlterUserRequest() [2/4]
| inline |
Constructs an AlterUserRequest object with the specified parameters.
Parameters
| name | Name of the user to be altered. Must be an existing user. |
| action | Modification operation to be applied to the user. Supported values:
|
| _value | The value of the modification, depending on action . |
| options | Optional parameters. The default value is an empty Dictionary. |
Definition at line 181 of file AlterUser.cs.
◆ AlterUserRequest() [3/4]
| inline |
Constructs an AlterUserRequest object with default parameters.
Definition at line 120 of file AlterUser.cs.
◆ AlterUserRequest() [4/4]
| inline |
Constructs an AlterUserRequest object with the specified parameters.
Parameters
| name | Name of the user to be altered. Must be an existing user. |
| action | Modification operation to be applied to the user. Supported values:
|
| _value | The value of the modification, depending on action . |
| options | Optional parameters. The default value is an empty Dictionary. |
Definition at line 181 of file AlterUser.cs.
Property Documentation
◆ _value
| getset |
The value of the modification, depending on AlterUserRequest.action.
Definition at line 111 of file AlterUser.cs.
◆ action
| getset |
Modification operation to be applied to the user.
Supported values:
- SET_ACTIVATED: Is the user allowed to login.
- TRUE: User may login.
- FALSE: User may not login.
- SET_COMMENT: Sets the comment for an internal user.
- SET_DEFAULT_SCHEMA: Set the default_schema for an internal user. An empty string means the user will have no default schema.
- SET_PASSWORD: Sets the password of the user. The user must be an internal user.
- SET_RESOURCE_GROUP: Sets the resource group for an internal user. The resource group must exist, otherwise, an empty string assigns the user to the default resource group.
Definition at line 107 of file AlterUser.cs.
◆ name
| getset |
Name of the user to be altered.
Must be an existing user.
Definition at line 55 of file AlterUser.cs.
◆ options
| getset |
Optional parameters.
The default value is an empty Dictionary.
Definition at line 116 of file AlterUser.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/AlterUser.cs
- Kinetica/Protocol/AlterUser.cs