Kinetica C# API  Version 6.2.0.1
kinetica.ShowSecurityRequest Class Reference

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

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

Public Member Functions

 ShowSecurityRequest ()
 Constructs a ShowSecurityRequest object with default parameters. More...
 
 ShowSecurityRequest (IList< string > names, IDictionary< string, string > options=null)
 Constructs a ShowSecurityRequest 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

IList< string > names [get, set]
 A list of names of users and/or roles about which security information is requested. More...
 
IDictionary< string, string > options = new List<string>() [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.showSecurity(IList<string>,IDictionary<string, string>).


Shows security information relating to users and/or roles. If the caller is not a system administrator, only information relating to the caller and their roles is returned.

Definition at line 21 of file ShowSecurity.cs.

Constructor & Destructor Documentation

◆ ShowSecurityRequest() [1/2]

kinetica.ShowSecurityRequest.ShowSecurityRequest ( )
inline

Constructs a ShowSecurityRequest object with default parameters.

Definition at line 36 of file ShowSecurity.cs.

◆ ShowSecurityRequest() [2/2]

kinetica.ShowSecurityRequest.ShowSecurityRequest ( IList< string >  names,
IDictionary< string, string >  options = null 
)
inline

Constructs a ShowSecurityRequest object with the specified parameters.

Parameters
namesA list of names of users and/or roles about which security information is requested. If none are provided, information about all users and roles will be returned.
optionsOptional parameters. The default value is an empty Dictionary.

Definition at line 47 of file ShowSecurity.cs.

Property Documentation

◆ names

IList<string> kinetica.ShowSecurityRequest.names
getset

A list of names of users and/or roles about which security information is requested.

If none are provided, information about all users and roles will be returned.

Definition at line 27 of file ShowSecurity.cs.

◆ options

IDictionary<string, string> kinetica.ShowSecurityRequest.options = new List<string>()
getset

Optional parameters.

The default value is an empty Dictionary.

Definition at line 31 of file ShowSecurity.cs.


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