Kinetica C# API  Version 7.0.19.0
 All Classes Namespaces Files Functions Variables Enumerations Enumerator Properties Pages
kinetica.AlterUserRequest Class Reference

A set of parameters for Kinetica.alterUser(string,string,string,IDictionary{string, string}). More...

+ Inheritance diagram for kinetica.AlterUserRequest:
+ Collaboration diagram for kinetica.AlterUserRequest:

Classes

struct  Action
 Modification operation to be applied to the user. More...
 

Public Member Functions

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


Alters a user.

Definition at line 19 of file AlterUser.cs.

Constructor & Destructor Documentation

kinetica.AlterUserRequest.AlterUserRequest ( )
inline

Constructs an AlterUserRequest object with default parameters.

Definition at line 89 of file AlterUser.cs.

kinetica.AlterUserRequest.AlterUserRequest ( string  name,
string  action,
string  _value,
IDictionary< string, string >  options = null 
)
inline

Constructs an AlterUserRequest object with the specified parameters.

Parameters
nameName of the user to be altered. Must be an existing user.
actionModification operation to be applied to the user. Supported values:
  • 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.
_valueThe value of the modification, depending on .
optionsOptional parameters. The default value is an empty Dictionary.

Definition at line 119 of file AlterUser.cs.

Property Documentation

string kinetica.AlterUserRequest._value
getset

The value of the modification, depending on .

Definition at line 80 of file AlterUser.cs.

string kinetica.AlterUserRequest.action
getset

Modification operation to be applied to the user.

Supported values:

  • 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 76 of file AlterUser.cs.

string kinetica.AlterUserRequest.name
getset

Name of the user to be altered.

Must be an existing user.

Definition at line 57 of file AlterUser.cs.

IDictionary<string, string> kinetica.AlterUserRequest.options
getset

Optional parameters.

The default value is an empty Dictionary.

Definition at line 84 of file AlterUser.cs.


The documentation for this class was generated from the following file: