Skip to main content

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 AlterRoleRequest.action. More…
 

Public Member Functions

 AlterRoleRequest ()
 Constructs an AlterRoleRequest object with default parameters.
 
 AlterRoleRequest (string name, string action, string _value, IDictionary< string, string > options=null)
 Constructs an AlterRoleRequest object with the specified parameters.
 
 AlterRoleRequest ()
 Constructs an AlterRoleRequest object with default parameters.
 
 AlterRoleRequest (string name, string action, string _value, IDictionary< string, string > options=null)
 Constructs an AlterRoleRequest 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 role to be altered.
 
string action [get, set]
 Modification operation to be applied to the role.
 
string _value [get, set]
 The value of the modification, depending on AlterRoleRequest.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.alterRole.

Alters a Role.

Definition at line 15 of file AlterRole.cs.

Constructor & Destructor Documentation

◆ AlterRoleRequest() [1/4]

kinetica.AlterRoleRequest.AlterRoleRequest ()
inline

Constructs an AlterRoleRequest object with default parameters.

Definition at line 69 of file AlterRole.cs.

◆ AlterRoleRequest() [2/4]

kinetica.AlterRoleRequest.AlterRoleRequest (stringname,
stringaction,
string_value,
IDictionary< string, string >options = null )
inline

Constructs an AlterRoleRequest object with the specified parameters.

Parameters
nameName of the role to be altered. Must be an existing role.
actionModification 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.
_valueThe value of the modification, depending on action .
optionsOptional parameters. The default value is an empty Dictionary.

Definition at line 99 of file AlterRole.cs.

◆ AlterRoleRequest() [3/4]

kinetica.AlterRoleRequest.AlterRoleRequest ()
inline

Constructs an AlterRoleRequest object with default parameters.

Definition at line 69 of file AlterRole.cs.

◆ AlterRoleRequest() [4/4]

kinetica.AlterRoleRequest.AlterRoleRequest (stringname,
stringaction,
string_value,
IDictionary< string, string >options = null )
inline

Constructs an AlterRoleRequest object with the specified parameters.

Parameters
nameName of the role to be altered. Must be an existing role.
actionModification 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.
_valueThe value of the modification, depending on action .
optionsOptional parameters. The default value is an empty Dictionary.

Definition at line 99 of file AlterRole.cs.

Property Documentation

◆ _value

string kinetica.AlterRoleRequest._value
getset

The value of the modification, depending on AlterRoleRequest.action.

Definition at line 60 of file AlterRole.cs.

◆ action

string kinetica.AlterRoleRequest.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 56 of file AlterRole.cs.

◆ name

string kinetica.AlterRoleRequest.name
getset

Name of the role to be altered.

Must be an existing role.

Definition at line 35 of file AlterRole.cs.

◆ options

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

Optional parameters.

The default value is an empty Dictionary.

Definition at line 65 of file AlterRole.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/AlterRole.cs
  • Kinetica/Protocol/AlterRole.cs