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

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

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

Classes

struct  Permission
 Permission to grant to the user or role. More...
 

Public Member Functions

 GrantPermissionCredentialRequest ()
 Constructs a GrantPermissionCredentialRequest object with default parameters. More...
 
 GrantPermissionCredentialRequest (string name, string permission, string credential_name, IDictionary< string, string > options=null)
 Constructs a GrantPermissionCredentialRequest 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 or role to which the permission will be granted. More...
 
string permission [get, set]
 Permission to grant to the user or role. More...
 
string credential_name [get, set]
 Name of the credential on which the permission will be granted. 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.grantPermissionCredential(string,string,string,IDictionary{string, string}).


Grants a credential-level permission to a user or role.

Definition at line 22 of file GrantPermissionCredential.cs.

Constructor & Destructor Documentation

kinetica.GrantPermissionCredentialRequest.GrantPermissionCredentialRequest ( )
inline

Constructs a GrantPermissionCredentialRequest object with default parameters.

Definition at line 89 of file GrantPermissionCredential.cs.

kinetica.GrantPermissionCredentialRequest.GrantPermissionCredentialRequest ( string  name,
string  permission,
string  credential_name,
IDictionary< string, string >  options = null 
)
inline

Constructs a GrantPermissionCredentialRequest object with the specified parameters.

Parameters
nameName of the user or role to which the permission will be granted. Must be an existing user or role.
permissionPermission to grant to the user or role. Supported values:
credential_nameName of the credential on which the permission will be granted. Must be an existing credential, or an empty string to grant access on all credentials.
optionsOptional parameters. The default value is an empty Dictionary.

Definition at line 118 of file GrantPermissionCredential.cs.

Property Documentation

string kinetica.GrantPermissionCredentialRequest.credential_name
getset

Name of the credential on which the permission will be granted.

Must be an existing credential, or an empty string to grant access on all credentials.

Definition at line 80 of file GrantPermissionCredential.cs.

string kinetica.GrantPermissionCredentialRequest.name
getset

Name of the user or role to which the permission will be granted.

Must be an existing user or role.

Definition at line 57 of file GrantPermissionCredential.cs.

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

Optional parameters.

The default value is an empty Dictionary.

Definition at line 84 of file GrantPermissionCredential.cs.

string kinetica.GrantPermissionCredentialRequest.permission
getset

Permission to grant to the user or role.

Supported values:

Definition at line 75 of file GrantPermissionCredential.cs.


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