TargetDatabaseSummary

class oci.data_safe.models.TargetDatabaseSummary(**kwargs)

Bases: object

Summary of a Data Safe target database.

Attributes:

DATABASE_TYPE_AUTONOMOUS_DATABASE

A constant which can be used with the database_type property of a TargetDatabaseSummary.

DATABASE_TYPE_DATABASE_CLOUD_SERVICE

A constant which can be used with the database_type property of a TargetDatabaseSummary.

DATABASE_TYPE_INSTALLED_DATABASE

A constant which can be used with the database_type property of a TargetDatabaseSummary.

INFRASTRUCTURE_TYPE_CLOUD_AT_CUSTOMER

A constant which can be used with the infrastructure_type property of a TargetDatabaseSummary.

INFRASTRUCTURE_TYPE_NON_ORACLE_CLOUD

A constant which can be used with the infrastructure_type property of a TargetDatabaseSummary.

INFRASTRUCTURE_TYPE_ON_PREMISES

A constant which can be used with the infrastructure_type property of a TargetDatabaseSummary.

INFRASTRUCTURE_TYPE_ORACLE_CLOUD

A constant which can be used with the infrastructure_type property of a TargetDatabaseSummary.

LIFECYCLE_STATE_ACTIVE

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

LIFECYCLE_STATE_CREATING

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

LIFECYCLE_STATE_DELETED

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

LIFECYCLE_STATE_DELETING

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

LIFECYCLE_STATE_FAILED

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

LIFECYCLE_STATE_INACTIVE

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

LIFECYCLE_STATE_NEEDS_ATTENTION

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

LIFECYCLE_STATE_UPDATING

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

associated_resource_ids

Gets the associated_resource_ids of this TargetDatabaseSummary.

compartment_id

[Required] Gets the compartment_id of this TargetDatabaseSummary.

database_type

[Required] Gets the database_type of this TargetDatabaseSummary.

defined_tags

Gets the defined_tags of this TargetDatabaseSummary.

description

Gets the description of this TargetDatabaseSummary.

display_name

[Required] Gets the display_name of this TargetDatabaseSummary.

features

Gets the features of this TargetDatabaseSummary.

freeform_tags

Gets the freeform_tags of this TargetDatabaseSummary.

id

[Required] Gets the id of this TargetDatabaseSummary.

infrastructure_type

[Required] Gets the infrastructure_type of this TargetDatabaseSummary.

lifecycle_details

Gets the lifecycle_details of this TargetDatabaseSummary.

lifecycle_state

[Required] Gets the lifecycle_state of this TargetDatabaseSummary.

system_tags

Gets the system_tags of this TargetDatabaseSummary.

time_created

[Required] Gets the time_created of this TargetDatabaseSummary.

Methods:

__init__(**kwargs)

Initializes a new TargetDatabaseSummary object with values from keyword arguments.

DATABASE_TYPE_AUTONOMOUS_DATABASE = 'AUTONOMOUS_DATABASE'

A constant which can be used with the database_type property of a TargetDatabaseSummary. This constant has a value of “AUTONOMOUS_DATABASE”

DATABASE_TYPE_DATABASE_CLOUD_SERVICE = 'DATABASE_CLOUD_SERVICE'

A constant which can be used with the database_type property of a TargetDatabaseSummary. This constant has a value of “DATABASE_CLOUD_SERVICE”

DATABASE_TYPE_INSTALLED_DATABASE = 'INSTALLED_DATABASE'

A constant which can be used with the database_type property of a TargetDatabaseSummary. This constant has a value of “INSTALLED_DATABASE”

INFRASTRUCTURE_TYPE_CLOUD_AT_CUSTOMER = 'CLOUD_AT_CUSTOMER'

A constant which can be used with the infrastructure_type property of a TargetDatabaseSummary. This constant has a value of “CLOUD_AT_CUSTOMER”

INFRASTRUCTURE_TYPE_NON_ORACLE_CLOUD = 'NON_ORACLE_CLOUD'

A constant which can be used with the infrastructure_type property of a TargetDatabaseSummary. This constant has a value of “NON_ORACLE_CLOUD”

INFRASTRUCTURE_TYPE_ON_PREMISES = 'ON_PREMISES'

A constant which can be used with the infrastructure_type property of a TargetDatabaseSummary. This constant has a value of “ON_PREMISES”

INFRASTRUCTURE_TYPE_ORACLE_CLOUD = 'ORACLE_CLOUD'

A constant which can be used with the infrastructure_type property of a TargetDatabaseSummary. This constant has a value of “ORACLE_CLOUD”

LIFECYCLE_STATE_ACTIVE = 'ACTIVE'

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

LIFECYCLE_STATE_CREATING = 'CREATING'

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

LIFECYCLE_STATE_DELETED = 'DELETED'

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

LIFECYCLE_STATE_DELETING = 'DELETING'

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

LIFECYCLE_STATE_FAILED = 'FAILED'

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

LIFECYCLE_STATE_INACTIVE = 'INACTIVE'

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

LIFECYCLE_STATE_NEEDS_ATTENTION = 'NEEDS_ATTENTION'

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

LIFECYCLE_STATE_UPDATING = 'UPDATING'

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

__init__(**kwargs)

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

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

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

  • display_name (str) – The value to assign to the display_name property of this TargetDatabaseSummary.

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

  • infrastructure_type (str) – The value to assign to the infrastructure_type property of this TargetDatabaseSummary. Allowed values for this property are: “ORACLE_CLOUD”, “CLOUD_AT_CUSTOMER”, “ON_PREMISES”, “NON_ORACLE_CLOUD”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

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

  • associated_resource_ids (list[str]) – The value to assign to the associated_resource_ids property of this TargetDatabaseSummary.

  • lifecycle_state (str) – The value to assign to the lifecycle_state property of this TargetDatabaseSummary. Allowed values for this property are: “CREATING”, “UPDATING”, “ACTIVE”, “INACTIVE”, “DELETING”, “DELETED”, “NEEDS_ATTENTION”, “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 TargetDatabaseSummary.

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

  • features (list[str]) – The value to assign to the features property of this TargetDatabaseSummary.

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

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

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

property associated_resource_ids

Gets the associated_resource_ids of this TargetDatabaseSummary. The OCIDs of associated resources like database, Data Safe private endpoint etc.

Returns

The associated_resource_ids of this TargetDatabaseSummary.

Return type

list[str]

property compartment_id

[Required] Gets the compartment_id of this TargetDatabaseSummary. The OCID of the compartment that contains the Data Safe target database.

Returns

The compartment_id of this TargetDatabaseSummary.

Return type

str

property database_type

[Required] Gets the database_type of this TargetDatabaseSummary. The database type.

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

Returns

The database_type of this TargetDatabaseSummary.

Return type

str

property defined_tags

Gets the defined_tags of this TargetDatabaseSummary. 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 TargetDatabaseSummary.

Return type

dict(str, dict(str, object))

property description

Gets the description of this TargetDatabaseSummary. The description of the target database in Data Safe.

Returns

The description of this TargetDatabaseSummary.

Return type

str

property display_name

[Required] Gets the display_name of this TargetDatabaseSummary. The display name of the target database in Data Safe.

Returns

The display_name of this TargetDatabaseSummary.

Return type

str

property features

Gets the features of this TargetDatabaseSummary. List of enabled features based on granted ORA_DSCS_* roles in target database

Returns

The features of this TargetDatabaseSummary.

Return type

list[str]

property freeform_tags

Gets the freeform_tags of this TargetDatabaseSummary. 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 TargetDatabaseSummary.

Return type

dict(str, str)

property id

[Required] Gets the id of this TargetDatabaseSummary. The OCID of the Data Safe target database.

Returns

The id of this TargetDatabaseSummary.

Return type

str

property infrastructure_type

[Required] Gets the infrastructure_type of this TargetDatabaseSummary. The infrastructure type the database is running on.

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

Returns

The infrastructure_type of this TargetDatabaseSummary.

Return type

str

property lifecycle_details

Gets the lifecycle_details of this TargetDatabaseSummary. Details about the current state of the target database in Data Safe.

Returns

The lifecycle_details of this TargetDatabaseSummary.

Return type

str

property lifecycle_state

[Required] Gets the lifecycle_state of this TargetDatabaseSummary. The current state of the target database in Data Safe.

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

Returns

The lifecycle_state of this TargetDatabaseSummary.

Return type

str

property system_tags

Gets the system_tags of this TargetDatabaseSummary. System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {“orcl-cloud”: {“free-tier-retained”: “true”}}

Returns

The system_tags of this TargetDatabaseSummary.

Return type

dict(str, dict(str, object))

property time_created

[Required] Gets the time_created of this TargetDatabaseSummary. The date and time the database was registered in Data Safe and created as a target database in Data Safe.

Returns

The time_created of this TargetDatabaseSummary.

Return type

datetime