Kinetica C# API  Version 6.2.0.1
kinetica.CreateUserExternalRequest Class Reference

A set of parameters for Kinetica.createUserExternal(string,IDictionary<string, string>). More...

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

Public Member Functions

 CreateUserExternalRequest ()
 Constructs a CreateUserExternalRequest object with default parameters. More...
 
 CreateUserExternalRequest (string name, IDictionary< string, string > options=null)
 Constructs a CreateUserExternalRequest 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 created. 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.createUserExternal(string,IDictionary<string, string>).


Creates a new external user (a user whose credentials are managed by an external LDAP).

Definition at line 20 of file CreateUserExternal.cs.

Constructor & Destructor Documentation

◆ CreateUserExternalRequest() [1/2]

kinetica.CreateUserExternalRequest.CreateUserExternalRequest ( )
inline

Constructs a CreateUserExternalRequest object with default parameters.

Definition at line 35 of file CreateUserExternal.cs.

◆ CreateUserExternalRequest() [2/2]

kinetica.CreateUserExternalRequest.CreateUserExternalRequest ( string  name,
IDictionary< string, string >  options = null 
)
inline

Constructs a CreateUserExternalRequest object with the specified parameters.

Parameters
nameName 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.
optionsOptional parameters. The default value is an empty Dictionary.

Definition at line 46 of file CreateUserExternal.cs.

Property Documentation

◆ name

string kinetica.CreateUserExternalRequest.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 26 of file CreateUserExternal.cs.

◆ options

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

Optional parameters.

The default value is an empty Dictionary.

Definition at line 30 of file CreateUserExternal.cs.


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