BasicPreferredCredential

class oci.database_management.models.BasicPreferredCredential(**kwargs)

Bases: PreferredCredential

The details of the ‘BASIC’ preferred credential.

Attributes:

ROLE_NORMAL

A constant which can be used with the role property of a BasicPreferredCredential.

ROLE_SYSDBA

A constant which can be used with the role property of a BasicPreferredCredential.

ROLE_SYSDG

A constant which can be used with the role property of a BasicPreferredCredential.

STATUS_NOT_SET

A constant which can be used with the status property of a PreferredCredential.

STATUS_SET

A constant which can be used with the status property of a PreferredCredential.

TYPE_BASIC

A constant which can be used with the type property of a PreferredCredential.

TYPE_NAMED_CREDENTIAL

A constant which can be used with the type property of a PreferredCredential.

credential_name

Gets the credential_name of this PreferredCredential.

is_accessible

Gets the is_accessible of this PreferredCredential.

password_secret_id

Gets the password_secret_id of this BasicPreferredCredential.

role

Gets the role of this BasicPreferredCredential.

status

Gets the status of this PreferredCredential.

type

Gets the type of this PreferredCredential.

user_name

Gets the user_name of this BasicPreferredCredential.

Methods:

__init__(**kwargs)

Initializes a new BasicPreferredCredential object with values from keyword arguments.

get_subtype(object_dictionary)

Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.

ROLE_NORMAL = 'NORMAL'

A constant which can be used with the role property of a BasicPreferredCredential. This constant has a value of “NORMAL”

ROLE_SYSDBA = 'SYSDBA'

A constant which can be used with the role property of a BasicPreferredCredential. This constant has a value of “SYSDBA”

ROLE_SYSDG = 'SYSDG'

A constant which can be used with the role property of a BasicPreferredCredential. This constant has a value of “SYSDG”

STATUS_NOT_SET = 'NOT_SET'

A constant which can be used with the status property of a PreferredCredential. This constant has a value of “NOT_SET”

STATUS_SET = 'SET'

A constant which can be used with the status property of a PreferredCredential. This constant has a value of “SET”

TYPE_BASIC = 'BASIC'

A constant which can be used with the type property of a PreferredCredential. This constant has a value of “BASIC”

TYPE_NAMED_CREDENTIAL = 'NAMED_CREDENTIAL'

A constant which can be used with the type property of a PreferredCredential. This constant has a value of “NAMED_CREDENTIAL”

__init__(**kwargs)

Initializes a new BasicPreferredCredential object with values from keyword arguments. The default value of the type attribute of this class is BASIC and it should not be changed. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters
  • type (str) – The value to assign to the type property of this BasicPreferredCredential. Allowed values for this property are: “BASIC”, “NAMED_CREDENTIAL”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

  • credential_name (str) – The value to assign to the credential_name property of this BasicPreferredCredential.

  • status (str) – The value to assign to the status property of this BasicPreferredCredential. 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 BasicPreferredCredential.

  • user_name (str) – The value to assign to the user_name property of this BasicPreferredCredential.

  • role (str) – The value to assign to the role property of this BasicPreferredCredential. 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 BasicPreferredCredential.

property credential_name

Gets the credential_name of this PreferredCredential. The name of the preferred credential.

Returns

The credential_name of this PreferredCredential.

Return type

str

static get_subtype(object_dictionary)

Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.

property is_accessible

Gets the is_accessible of this PreferredCredential. Indicates whether the preferred credential is accessible.

Returns

The is_accessible of this PreferredCredential.

Return type

bool

property password_secret_id

Gets the password_secret_id of this BasicPreferredCredential. The OCID of the Vault service secret that contains the database user password.

Returns

The password_secret_id of this BasicPreferredCredential.

Return type

str

property role

Gets the role of this BasicPreferredCredential. 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 BasicPreferredCredential.

Return type

str

property status

Gets the status of this PreferredCredential. 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 PreferredCredential.

Return type

str

property type

Gets the type of this PreferredCredential. The type of preferred credential. Only ‘BASIC’ is supported currently.

Allowed values for this property are: “BASIC”, “NAMED_CREDENTIAL”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns

The type of this PreferredCredential.

Return type

str

property user_name

Gets the user_name of this BasicPreferredCredential. The user name used to connect to the database.

Returns

The user_name of this BasicPreferredCredential.

Return type

str