NamedCredentialSummary

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

Bases: object

A summary of the named credential.

Attributes:

LIFECYCLE_STATE_ACTIVE

A constant which can be used with the lifecycle_state property of a NamedCredentialSummary.

LIFECYCLE_STATE_CREATING

A constant which can be used with the lifecycle_state property of a NamedCredentialSummary.

LIFECYCLE_STATE_DELETED

A constant which can be used with the lifecycle_state property of a NamedCredentialSummary.

LIFECYCLE_STATE_DELETING

A constant which can be used with the lifecycle_state property of a NamedCredentialSummary.

LIFECYCLE_STATE_FAILED

A constant which can be used with the lifecycle_state property of a NamedCredentialSummary.

LIFECYCLE_STATE_UPDATING

A constant which can be used with the lifecycle_state property of a NamedCredentialSummary.

SCOPE_GLOBAL

A constant which can be used with the scope property of a NamedCredentialSummary.

SCOPE_RESOURCE

A constant which can be used with the scope property of a NamedCredentialSummary.

TYPE_ORACLE_DB

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

compartment_id

[Required] Gets the compartment_id of this NamedCredentialSummary.

defined_tags

Gets the defined_tags of this NamedCredentialSummary.

description

[Required] Gets the description of this NamedCredentialSummary.

freeform_tags

Gets the freeform_tags of this NamedCredentialSummary.

id

[Required] Gets the id of this NamedCredentialSummary.

lifecycle_details

[Required] Gets the lifecycle_details of this NamedCredentialSummary.

lifecycle_state

[Required] Gets the lifecycle_state of this NamedCredentialSummary.

name

[Required] Gets the name of this NamedCredentialSummary.

scope

[Required] Gets the scope of this NamedCredentialSummary.

system_tags

Gets the system_tags of this NamedCredentialSummary.

time_created

[Required] Gets the time_created of this NamedCredentialSummary.

time_updated

[Required] Gets the time_updated of this NamedCredentialSummary.

type

[Required] Gets the type of this NamedCredentialSummary.

Methods:

__init__(**kwargs)

Initializes a new NamedCredentialSummary object with values from keyword arguments.

LIFECYCLE_STATE_ACTIVE = 'ACTIVE'

A constant which can be used with the lifecycle_state property of a NamedCredentialSummary. This constant has a value of “ACTIVE”

LIFECYCLE_STATE_CREATING = 'CREATING'

A constant which can be used with the lifecycle_state property of a NamedCredentialSummary. This constant has a value of “CREATING”

LIFECYCLE_STATE_DELETED = 'DELETED'

A constant which can be used with the lifecycle_state property of a NamedCredentialSummary. This constant has a value of “DELETED”

LIFECYCLE_STATE_DELETING = 'DELETING'

A constant which can be used with the lifecycle_state property of a NamedCredentialSummary. This constant has a value of “DELETING”

LIFECYCLE_STATE_FAILED = 'FAILED'

A constant which can be used with the lifecycle_state property of a NamedCredentialSummary. This constant has a value of “FAILED”

LIFECYCLE_STATE_UPDATING = 'UPDATING'

A constant which can be used with the lifecycle_state property of a NamedCredentialSummary. This constant has a value of “UPDATING”

SCOPE_GLOBAL = 'GLOBAL'

A constant which can be used with the scope property of a NamedCredentialSummary. This constant has a value of “GLOBAL”

SCOPE_RESOURCE = 'RESOURCE'

A constant which can be used with the scope property of a NamedCredentialSummary. This constant has a value of “RESOURCE”

TYPE_ORACLE_DB = 'ORACLE_DB'

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

__init__(**kwargs)

Initializes a new NamedCredentialSummary object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters
  • id (str) – The value to assign to the id property of this NamedCredentialSummary.

  • compartment_id (str) – The value to assign to the compartment_id property of this NamedCredentialSummary.

  • name (str) – The value to assign to the name property of this NamedCredentialSummary.

  • description (str) – The value to assign to the description property of this NamedCredentialSummary.

  • scope (str) – The value to assign to the scope property of this NamedCredentialSummary. Allowed values for this property are: “RESOURCE”, “GLOBAL”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

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

  • lifecycle_state (str) – The value to assign to the lifecycle_state property of this NamedCredentialSummary. Allowed values for this property are: “CREATING”, “UPDATING”, “ACTIVE”, “DELETING”, “DELETED”, “FAILED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

  • lifecycle_details (str) – The value to assign to the lifecycle_details property of this NamedCredentialSummary.

  • time_created (datetime) – The value to assign to the time_created property of this NamedCredentialSummary.

  • time_updated (datetime) – The value to assign to the time_updated property of this NamedCredentialSummary.

  • freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this NamedCredentialSummary.

  • defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this NamedCredentialSummary.

  • system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this NamedCredentialSummary.

property compartment_id

[Required] Gets the compartment_id of this NamedCredentialSummary. The OCID of the compartment in which the named credential resides.

Returns

The compartment_id of this NamedCredentialSummary.

Return type

str

property defined_tags

Gets the defined_tags of this NamedCredentialSummary. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {“Operations”: {“CostCenter”: “42”}}

Returns

The defined_tags of this NamedCredentialSummary.

Return type

dict(str, dict(str, object))

property description

[Required] Gets the description of this NamedCredentialSummary. The information specified by the user about the named credential.

Returns

The description of this NamedCredentialSummary.

Return type

str

property freeform_tags

Gets the freeform_tags of this NamedCredentialSummary. Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {“Department”: “Finance”}

Returns

The freeform_tags of this NamedCredentialSummary.

Return type

dict(str, str)

property id

[Required] Gets the id of this NamedCredentialSummary. The OCID of the named credential.

Returns

The id of this NamedCredentialSummary.

Return type

str

property lifecycle_details

[Required] Gets the lifecycle_details of this NamedCredentialSummary. The details of the lifecycle state.

Returns

The lifecycle_details of this NamedCredentialSummary.

Return type

str

property lifecycle_state

[Required] Gets the lifecycle_state of this NamedCredentialSummary. The current lifecycle state of the named credential.

Allowed values for this property are: “CREATING”, “UPDATING”, “ACTIVE”, “DELETING”, “DELETED”, “FAILED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns

The lifecycle_state of this NamedCredentialSummary.

Return type

str

property name

[Required] Gets the name of this NamedCredentialSummary. The name of the named credential. Valid characters are uppercase or lowercase letters, numbers, and “_”. The name of the named credential cannot be modified. It must be unique in the compartment and must begin with an alphabetic character.

Returns

The name of this NamedCredentialSummary.

Return type

str

property scope

[Required] Gets the scope of this NamedCredentialSummary. The scope of the named credential.

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

Returns

The scope of this NamedCredentialSummary.

Return type

str

property system_tags

Gets the system_tags of this NamedCredentialSummary. System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. System tags can be viewed by users, but can only be created by the system.

Example: {“orcl-cloud”: {“free-tier-retained”: “true”}}

Returns

The system_tags of this NamedCredentialSummary.

Return type

dict(str, dict(str, object))

property time_created

[Required] Gets the time_created of this NamedCredentialSummary. The date and time the named credential was created.

Returns

The time_created of this NamedCredentialSummary.

Return type

datetime

property time_updated

[Required] Gets the time_updated of this NamedCredentialSummary. The date and time the named credential was last updated.

Returns

The time_updated of this NamedCredentialSummary.

Return type

datetime

property type

[Required] Gets the type of this NamedCredentialSummary. The type of resource associated with the named credential.

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

Returns

The type of this NamedCredentialSummary.

Return type

str