Skip to main content

A set of parameters for Kinetica.createCredential. More…

Inheritance diagram for kinetica.CreateCredentialRequest:
Collaboration diagram for kinetica.CreateCredentialRequest:

Classes

struct  Type
 A set of string constants for the parameter CreateCredentialRequest.type. More…
 

Public Member Functions

 CreateCredentialRequest ()
 Constructs a CreateCredentialRequest object with default parameters.
 
 CreateCredentialRequest (string credential_name, string type, string identity, string secret, IDictionary< string, string > options=null)
 Constructs a CreateCredentialRequest object with the specified parameters.
 
 CreateCredentialRequest ()
 Constructs a CreateCredentialRequest object with default parameters.
 
 CreateCredentialRequest (string credential_name, string type, string identity, string secret, IDictionary< string, string > options=null)
 Constructs a CreateCredentialRequest 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 credential_name [get, set]
 Name of the credential to be created.
 
string type [get, set]
 Type of the credential to be created.
 
string identity [get, set]
 User of the credential to be created.
 
string secret [get, set]
 Password of the credential to be created.
 
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.createCredential.

Create a new credential.

Definition at line 16 of file CreateCredential.cs.

Constructor & Destructor Documentation

◆ CreateCredentialRequest() [1/4]

kinetica.CreateCredentialRequest.CreateCredentialRequest ()
inline

Constructs a CreateCredentialRequest object with default parameters.

Definition at line 188 of file CreateCredential.cs.

◆ CreateCredentialRequest() [2/4]

kinetica.CreateCredentialRequest.CreateCredentialRequest (stringcredential_name,
stringtype,
stringidentity,
stringsecret,
IDictionary< string, string >options = null )
inline

Constructs a CreateCredentialRequest object with the specified parameters.

Parameters
credential_nameName of the credential to be created. Must contain only letters, digits, and underscores, and cannot begin with a digit. Must not match an existing credential name.
typeType of the credential to be created. Supported values:
identityUser of the credential to be created.
secretPassword of the credential to be created.
optionsOptional parameters. The default value is an empty Dictionary.

Definition at line 279 of file CreateCredential.cs.

◆ CreateCredentialRequest() [3/4]

kinetica.CreateCredentialRequest.CreateCredentialRequest ()
inline

Constructs a CreateCredentialRequest object with default parameters.

Definition at line 188 of file CreateCredential.cs.

◆ CreateCredentialRequest() [4/4]

kinetica.CreateCredentialRequest.CreateCredentialRequest (stringcredential_name,
stringtype,
stringidentity,
stringsecret,
IDictionary< string, string >options = null )
inline

Constructs a CreateCredentialRequest object with the specified parameters.

Parameters
credential_nameName of the credential to be created. Must contain only letters, digits, and underscores, and cannot begin with a digit. Must not match an existing credential name.
typeType of the credential to be created. Supported values:
identityUser of the credential to be created.
secretPassword of the credential to be created.
optionsOptional parameters. The default value is an empty Dictionary.

Definition at line 279 of file CreateCredential.cs.

Property Documentation

◆ credential_name

string kinetica.CreateCredentialRequest.credential_name
getset

Name of the credential to be created.

Must contain only letters, digits, and underscores, and cannot begin with a digit. Must not match an existing credential name.

Definition at line 92 of file CreateCredential.cs.

◆ identity

string kinetica.CreateCredentialRequest.identity
getset

User of the credential to be created.

Definition at line 176 of file CreateCredential.cs.

◆ options

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

Optional parameters.

The default value is an empty Dictionary.

Definition at line 184 of file CreateCredential.cs.

◆ secret

string kinetica.CreateCredentialRequest.secret
getset

Password of the credential to be created.

Definition at line 179 of file CreateCredential.cs.

◆ type

string kinetica.CreateCredentialRequest.type
getset

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