A set of parameters for Kinetica.alterRole. More...
Inheritance diagram for kinetica.AlterRoleRequest:
Collaboration diagram for kinetica.AlterRoleRequest:
Classes | |
| struct | Action |
| A set of string constants for the parameter action. More... | |
Public Member Functions | |
| AlterRoleRequest () | |
| Constructs an AlterRoleRequest object with default parameters. More... | |
| AlterRoleRequest (string name, string action, string _value, IDictionary< string, string > options=null) | |
| Constructs an AlterRoleRequest 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 role to be altered. More... | |
| string | action [get, set] |
| Modification operation to be applied to the role. More... | |
| string | _value [get, set] |
| The value of the modification, depending on action. 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... | |
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.alterRole.
Alters a Role.
Definition at line 15 of file AlterRole.cs.
Constructor & Destructor Documentation
◆ AlterRoleRequest() [1/2]
|
inline |
Constructs an AlterRoleRequest object with default parameters.
Definition at line 71 of file AlterRole.cs.
◆ AlterRoleRequest() [2/2]
|
inline |
Constructs an AlterRoleRequest object with the specified parameters.
- Parameters
-
name Name of the role to be altered. Must be an existing role. action Modification operation to be applied to the role. Supported values: - SET_COMMENT: Sets the comment for an internal role.
- SET_RESOURCE_GROUP: Sets the resource group for an internal role. The resource group must exist, otherwise, an empty string assigns the role to the default resource group.
_value The value of the modification, depending on action . options Optional parameters. The default value is an empty Dictionary.
Definition at line 102 of file AlterRole.cs.
Property Documentation
◆ _value
|
getset |
The value of the modification, depending on action.
Definition at line 62 of file AlterRole.cs.
◆ action
|
getset |
Modification operation to be applied to the role.
Supported values:
- SET_COMMENT: Sets the comment for an internal role.
- SET_RESOURCE_GROUP: Sets the resource group for an internal role. The resource group must exist, otherwise, an empty string assigns the role to the default resource group.
Definition at line 58 of file AlterRole.cs.
◆ name
|
getset |
Name of the role to be altered.
Must be an existing role.
Definition at line 36 of file AlterRole.cs.
◆ options
|
getset |
Optional parameters.
The default value is an empty Dictionary.
Definition at line 67 of file AlterRole.cs.
The documentation for this class was generated from the following file:
- Kinetica/Protocol/AlterRole.cs
