kinetica.AlterCredentialRequest Class Reference
A set of parameters for Kinetica.alterCredential. More...
Inheritance diagram for kinetica.AlterCredentialRequest:
Collaboration diagram for kinetica.AlterCredentialRequest:
Classes | |
| struct | CredentialUpdatesMap |
| A set of string constants for the parameter credential_updates_map. More... | |
Public Member Functions | |
| AlterCredentialRequest () | |
| Constructs an AlterCredentialRequest object with default parameters. More... | |
| AlterCredentialRequest (string credential_name, IDictionary< string, string > credential_updates_map, IDictionary< string, string > options) | |
| Constructs an AlterCredentialRequest object with the specified parameters. More... | |
| AlterCredentialRequest () | |
| Constructs an AlterCredentialRequest object with default parameters. More... | |
| AlterCredentialRequest (string credential_name, IDictionary< string, string > credential_updates_map, IDictionary< string, string > options) | |
| Constructs an AlterCredentialRequest 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... | |
| 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 | credential_name [get, set] |
| Name of the credential to be altered. More... | |
| IDictionary< string, string > | credential_updates_map = new Dictionary<string, string>() [get, set] |
| Map containing the properties of the credential to be updated. More... | |
| IDictionary< string, string > | options = new Dictionary<string, string>() [get, set] |
| Optional parameters. More... | |
| Properties inherited from kinetica.KineticaData | |
| Schema | Schema [get] |
| Avro Schema for this class More... | |
| Properties inherited from Avro.Specific.ISpecificRecord | |
| Schema | Schema [get] |
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... | |
| 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.alterCredential.
Alter the properties of an existing credential.
Definition at line 17 of file AlterCredential.cs.
Constructor & Destructor Documentation
◆ AlterCredentialRequest() [1/4]
|
inline |
Constructs an AlterCredentialRequest object with default parameters.
Definition at line 209 of file AlterCredential.cs.
◆ AlterCredentialRequest() [2/4]
|
inline |
Constructs an AlterCredentialRequest object with the specified parameters.
- Parameters
-
credential_name Name of the credential to be altered. Must be an existing credential. credential_updates_map Map containing the properties of the credential to be updated. Error if empty. - TYPE: New type for the credential. Supported values:
- IDENTITY: New user for the credential
- SECRET: New password for the credential
- SCHEMA_NAME: Updates the schema name. If SCHEMA_NAME doesn't exist, an error will be thrown. If SCHEMA_NAME is empty, then the user's default schema will be used.
options Optional parameters.
Definition at line 304 of file AlterCredential.cs.
◆ AlterCredentialRequest() [3/4]
|
inline |
Constructs an AlterCredentialRequest object with default parameters.
Definition at line 209 of file AlterCredential.cs.
◆ AlterCredentialRequest() [4/4]
|
inline |
Constructs an AlterCredentialRequest object with the specified parameters.
- Parameters
-
credential_name Name of the credential to be altered. Must be an existing credential. credential_updates_map Map containing the properties of the credential to be updated. Error if empty. - TYPE: New type for the credential. Supported values:
- IDENTITY: New user for the credential
- SECRET: New password for the credential
- SCHEMA_NAME: Updates the schema name. If SCHEMA_NAME doesn't exist, an error will be thrown. If SCHEMA_NAME is empty, then the user's default schema will be used.
options Optional parameters.
Definition at line 304 of file AlterCredential.cs.
Property Documentation
◆ credential_name
|
getset |
Name of the credential to be altered.
Must be an existing credential.
Definition at line 113 of file AlterCredential.cs.
◆ credential_updates_map
|
getset |
Map containing the properties of the credential to be updated.
- TYPE: New type for the credential. Supported values:
- IDENTITY: New user for the credential
- SECRET: New password for the credential
- SCHEMA_NAME: Updates the schema name. If SCHEMA_NAME doesn't exist, an error will be thrown. If SCHEMA_NAME is empty, then the user's default schema will be used.
Definition at line 202 of file AlterCredential.cs.
◆ options
|
getset |
Optional parameters.
Definition at line 205 of file AlterCredential.cs.
The documentation for this class was generated from the following file:
- _build/public-os_ubuntu24.04-arch_amd64-cc_gcc_13.3.0/install/Kinetica/Protocol/AlterCredential.cs
