PreferredCredentialSummary¶
- class oci.database_management.models.PreferredCredentialSummary(**kwargs)¶
Bases:
objectThe summary of preferred credentials.
Attributes:
A constant which can be used with the role property of a PreferredCredentialSummary.
A constant which can be used with the role property of a PreferredCredentialSummary.
A constant which can be used with the role property of a PreferredCredentialSummary.
A constant which can be used with the status property of a PreferredCredentialSummary.
A constant which can be used with the status property of a PreferredCredentialSummary.
[Required] Gets the credential_name of this PreferredCredentialSummary.
[Required] Gets the is_accessible of this PreferredCredentialSummary.
Gets the named_credential_id of this PreferredCredentialSummary.
Gets the password_secret_id of this PreferredCredentialSummary.
Gets the role of this PreferredCredentialSummary.
[Required] Gets the status of this PreferredCredentialSummary.
Gets the user_name of this PreferredCredentialSummary.
Methods:
__init__(**kwargs)Initializes a new PreferredCredentialSummary object with values from keyword arguments.
- ROLE_NORMAL = 'NORMAL'¶
A constant which can be used with the role property of a PreferredCredentialSummary. This constant has a value of “NORMAL”
- ROLE_SYSDBA = 'SYSDBA'¶
A constant which can be used with the role property of a PreferredCredentialSummary. This constant has a value of “SYSDBA”
- ROLE_SYSDG = 'SYSDG'¶
A constant which can be used with the role property of a PreferredCredentialSummary. This constant has a value of “SYSDG”
- STATUS_NOT_SET = 'NOT_SET'¶
A constant which can be used with the status property of a PreferredCredentialSummary. This constant has a value of “NOT_SET”
- STATUS_SET = 'SET'¶
A constant which can be used with the status property of a PreferredCredentialSummary. This constant has a value of “SET”
- __init__(**kwargs)¶
Initializes a new PreferredCredentialSummary object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):
- Parameters
credential_name (str) – The value to assign to the credential_name property of this PreferredCredentialSummary.
status (str) – The value to assign to the status property of this PreferredCredentialSummary. Allowed values for this property are: “SET”, “NOT_SET”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
is_accessible (bool) – The value to assign to the is_accessible property of this PreferredCredentialSummary.
user_name (str) – The value to assign to the user_name property of this PreferredCredentialSummary.
role (str) – The value to assign to the role property of this PreferredCredentialSummary. Allowed values for this property are: “NORMAL”, “SYSDBA”, “SYSDG”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
password_secret_id (str) – The value to assign to the password_secret_id property of this PreferredCredentialSummary.
named_credential_id (str) – The value to assign to the named_credential_id property of this PreferredCredentialSummary.
- property credential_name¶
[Required] Gets the credential_name of this PreferredCredentialSummary. The name of the preferred credential.
- Returns
The credential_name of this PreferredCredentialSummary.
- Return type
str
- property is_accessible¶
[Required] Gets the is_accessible of this PreferredCredentialSummary. Indicates whether the preferred credential is accessible.
- Returns
The is_accessible of this PreferredCredentialSummary.
- Return type
bool
- property named_credential_id¶
Gets the named_credential_id of this PreferredCredentialSummary. The OCID of the Named Credential that contains the database user password metadata.
- Returns
The named_credential_id of this PreferredCredentialSummary.
- Return type
str
- property password_secret_id¶
Gets the password_secret_id of this PreferredCredentialSummary. The OCID of the Vault service secret that contains the database user password.
- Returns
The password_secret_id of this PreferredCredentialSummary.
- Return type
str
- property role¶
Gets the role of this PreferredCredentialSummary. The role of the database user.
Allowed values for this property are: “NORMAL”, “SYSDBA”, “SYSDG”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
- Returns
The role of this PreferredCredentialSummary.
- Return type
str
- property status¶
[Required] Gets the status of this PreferredCredentialSummary. The status of the preferred credential.
Allowed values for this property are: “SET”, “NOT_SET”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
- Returns
The status of this PreferredCredentialSummary.
- Return type
str
- property user_name¶
Gets the user_name of this PreferredCredentialSummary. The user name used to connect to the database.
- Returns
The user_name of this PreferredCredentialSummary.
- Return type
str