DatabaseRegistrationSummary¶

class oci.golden_gate.models.DatabaseRegistrationSummary(**kwargs)¶

Bases: object

Summary of the DatabaseRegistration.

Attributes

`LIFECYCLE_STATE_ACTIVE`	A constant which can be used with the lifecycle_state property of a DatabaseRegistrationSummary.
`LIFECYCLE_STATE_CANCELED`	A constant which can be used with the lifecycle_state property of a DatabaseRegistrationSummary.
`LIFECYCLE_STATE_CANCELING`	A constant which can be used with the lifecycle_state property of a DatabaseRegistrationSummary.
`LIFECYCLE_STATE_CREATING`	A constant which can be used with the lifecycle_state property of a DatabaseRegistrationSummary.
`LIFECYCLE_STATE_DELETED`	A constant which can be used with the lifecycle_state property of a DatabaseRegistrationSummary.
`LIFECYCLE_STATE_DELETING`	A constant which can be used with the lifecycle_state property of a DatabaseRegistrationSummary.
`LIFECYCLE_STATE_FAILED`	A constant which can be used with the lifecycle_state property of a DatabaseRegistrationSummary.
`LIFECYCLE_STATE_INACTIVE`	A constant which can be used with the lifecycle_state property of a DatabaseRegistrationSummary.
`LIFECYCLE_STATE_IN_PROGRESS`	A constant which can be used with the lifecycle_state property of a DatabaseRegistrationSummary.
`LIFECYCLE_STATE_NEEDS_ATTENTION`	A constant which can be used with the lifecycle_state property of a DatabaseRegistrationSummary.
`LIFECYCLE_STATE_SUCCEEDED`	A constant which can be used with the lifecycle_state property of a DatabaseRegistrationSummary.
`LIFECYCLE_STATE_UPDATING`	A constant which can be used with the lifecycle_state property of a DatabaseRegistrationSummary.
`LIFECYCLE_STATE_WAITING`	A constant which can be used with the lifecycle_state property of a DatabaseRegistrationSummary.
`SESSION_MODE_DIRECT`	A constant which can be used with the session_mode property of a DatabaseRegistrationSummary.
`SESSION_MODE_REDIRECT`	A constant which can be used with the session_mode property of a DatabaseRegistrationSummary.
`alias_name`	Gets the alias_name of this DatabaseRegistrationSummary.
`compartment_id`	[Required] Gets the compartment_id of this DatabaseRegistrationSummary.
`connection_string`	Gets the connection_string of this DatabaseRegistrationSummary.
`database_id`	Gets the database_id of this DatabaseRegistrationSummary.
`defined_tags`	Gets the defined_tags of this DatabaseRegistrationSummary.
`description`	Gets the description of this DatabaseRegistrationSummary.
`display_name`	[Required] Gets the display_name of this DatabaseRegistrationSummary.
`fqdn`	[Required] Gets the fqdn of this DatabaseRegistrationSummary.
`freeform_tags`	Gets the freeform_tags of this DatabaseRegistrationSummary.
`id`	[Required] Gets the id of this DatabaseRegistrationSummary.
`lifecycle_details`	Gets the lifecycle_details of this DatabaseRegistrationSummary.
`lifecycle_state`	Gets the lifecycle_state of this DatabaseRegistrationSummary.
`secret_id`	Gets the secret_id of this DatabaseRegistrationSummary.
`session_mode`	Gets the session_mode of this DatabaseRegistrationSummary.
`subnet_id`	Gets the subnet_id of this DatabaseRegistrationSummary.
`system_tags`	Gets the system_tags of this DatabaseRegistrationSummary.
`time_created`	Gets the time_created of this DatabaseRegistrationSummary.
`time_updated`	Gets the time_updated of this DatabaseRegistrationSummary.
`username`	Gets the username of this DatabaseRegistrationSummary.

Methods

__init__(**kwargs) Initializes a new DatabaseRegistrationSummary object with values from keyword arguments.

LIFECYCLE_STATE_ACTIVE = 'ACTIVE'¶: A constant which can be used with the lifecycle_state property of a DatabaseRegistrationSummary. This constant has a value of “ACTIVE”

LIFECYCLE_STATE_CANCELED = 'CANCELED'¶: A constant which can be used with the lifecycle_state property of a DatabaseRegistrationSummary. This constant has a value of “CANCELED”

LIFECYCLE_STATE_CANCELING = 'CANCELING'¶: A constant which can be used with the lifecycle_state property of a DatabaseRegistrationSummary. This constant has a value of “CANCELING”

LIFECYCLE_STATE_CREATING = 'CREATING'¶: A constant which can be used with the lifecycle_state property of a DatabaseRegistrationSummary. This constant has a value of “CREATING”

LIFECYCLE_STATE_DELETED = 'DELETED'¶: A constant which can be used with the lifecycle_state property of a DatabaseRegistrationSummary. This constant has a value of “DELETED”

LIFECYCLE_STATE_DELETING = 'DELETING'¶: A constant which can be used with the lifecycle_state property of a DatabaseRegistrationSummary. This constant has a value of “DELETING”

LIFECYCLE_STATE_FAILED = 'FAILED'¶: A constant which can be used with the lifecycle_state property of a DatabaseRegistrationSummary. This constant has a value of “FAILED”

LIFECYCLE_STATE_INACTIVE = 'INACTIVE'¶: A constant which can be used with the lifecycle_state property of a DatabaseRegistrationSummary. This constant has a value of “INACTIVE”

LIFECYCLE_STATE_IN_PROGRESS = 'IN_PROGRESS'¶: A constant which can be used with the lifecycle_state property of a DatabaseRegistrationSummary. This constant has a value of “IN_PROGRESS”

LIFECYCLE_STATE_NEEDS_ATTENTION = 'NEEDS_ATTENTION'¶: A constant which can be used with the lifecycle_state property of a DatabaseRegistrationSummary. This constant has a value of “NEEDS_ATTENTION”

LIFECYCLE_STATE_SUCCEEDED = 'SUCCEEDED'¶: A constant which can be used with the lifecycle_state property of a DatabaseRegistrationSummary. This constant has a value of “SUCCEEDED”

LIFECYCLE_STATE_UPDATING = 'UPDATING'¶: A constant which can be used with the lifecycle_state property of a DatabaseRegistrationSummary. This constant has a value of “UPDATING”

LIFECYCLE_STATE_WAITING = 'WAITING'¶: A constant which can be used with the lifecycle_state property of a DatabaseRegistrationSummary. This constant has a value of “WAITING”

SESSION_MODE_DIRECT = 'DIRECT'¶: A constant which can be used with the session_mode property of a DatabaseRegistrationSummary. This constant has a value of “DIRECT”

SESSION_MODE_REDIRECT = 'REDIRECT'¶: A constant which can be used with the session_mode property of a DatabaseRegistrationSummary. This constant has a value of “REDIRECT”

__init__(**kwargs)¶

Initializes a new DatabaseRegistrationSummary 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 DatabaseRegistrationSummary.
display_name (str) – The value to assign to the display_name property of this DatabaseRegistrationSummary.
description (str) – The value to assign to the description property of this DatabaseRegistrationSummary.
compartment_id (str) – The value to assign to the compartment_id property of this DatabaseRegistrationSummary.
time_created (datetime) – The value to assign to the time_created property of this DatabaseRegistrationSummary.
time_updated (datetime) – The value to assign to the time_updated property of this DatabaseRegistrationSummary.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this DatabaseRegistrationSummary. Allowed values for this property are: “CREATING”, “UPDATING”, “ACTIVE”, “INACTIVE”, “DELETING”, “DELETED”, “FAILED”, “NEEDS_ATTENTION”, “IN_PROGRESS”, “CANCELING”, “CANCELED”, “SUCCEEDED”, “WAITING”, ‘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 DatabaseRegistrationSummary.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this DatabaseRegistrationSummary.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this DatabaseRegistrationSummary.
fqdn (str) – The value to assign to the fqdn property of this DatabaseRegistrationSummary.
subnet_id (str) – The value to assign to the subnet_id property of this DatabaseRegistrationSummary.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this DatabaseRegistrationSummary.
database_id (str) – The value to assign to the database_id property of this DatabaseRegistrationSummary.
username (str) – The value to assign to the username property of this DatabaseRegistrationSummary.
connection_string (str) – The value to assign to the connection_string property of this DatabaseRegistrationSummary.
session_mode (str) – The value to assign to the session_mode property of this DatabaseRegistrationSummary. Allowed values for this property are: “DIRECT”, “REDIRECT”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
alias_name (str) – The value to assign to the alias_name property of this DatabaseRegistrationSummary.
secret_id (str) – The value to assign to the secret_id property of this DatabaseRegistrationSummary.

alias_name¶

Gets the alias_name of this DatabaseRegistrationSummary. Credential store alias.

Returns:	The alias_name of this DatabaseRegistrationSummary.
Return type:	str

compartment_id¶

[Required] Gets the compartment_id of this DatabaseRegistrationSummary. The OCID of the compartment being referenced.

Returns:	The compartment_id of this DatabaseRegistrationSummary.
Return type:	str

connection_string¶

Gets the connection_string of this DatabaseRegistrationSummary. Connect descriptor or Easy Connect Naming method used to connect to a database.

Returns:	The connection_string of this DatabaseRegistrationSummary.
Return type:	str

database_id¶

Gets the database_id of this DatabaseRegistrationSummary. The OCID of the database being referenced.

Returns:	The database_id of this DatabaseRegistrationSummary.
Return type:	str

defined_tags¶

Gets the defined_tags of this DatabaseRegistrationSummary. Tags defined for this resource. Each key is predefined and scoped to a namespace.

Example: {“foo-namespace”: {“bar-key”: “value”}}

Returns:	The defined_tags of this DatabaseRegistrationSummary.
Return type:	dict(str, dict(str, object))

description¶

Gets the description of this DatabaseRegistrationSummary. Metadata about this specific object.

Returns:	The description of this DatabaseRegistrationSummary.
Return type:	str

display_name¶

[Required] Gets the display_name of this DatabaseRegistrationSummary. An object’s Display Name.

Returns:	The display_name of this DatabaseRegistrationSummary.
Return type:	str

fqdn¶

[Required] Gets the fqdn of this DatabaseRegistrationSummary. A three-label Fully Qualified Domain Name (FQDN) for a resource.

Returns:	The fqdn of this DatabaseRegistrationSummary.
Return type:	str

freeform_tags¶

Gets the freeform_tags of this DatabaseRegistrationSummary. A simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only.

Example: {“bar-key”: “value”}

Returns:	The freeform_tags of this DatabaseRegistrationSummary.
Return type:	dict(str, str)

id¶

[Required] Gets the id of this DatabaseRegistrationSummary. The OCID of the databaseRegistration being referenced.

Returns:	The id of this DatabaseRegistrationSummary.
Return type:	str

lifecycle_details¶

Gets the lifecycle_details of this DatabaseRegistrationSummary. Describes the object’s current state in detail. For example, it can be used to provide actionable information for a resource in a Failed state.

Returns:	The lifecycle_details of this DatabaseRegistrationSummary.
Return type:	str

lifecycle_state¶

Gets the lifecycle_state of this DatabaseRegistrationSummary. Possible lifecycle states.

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

Returns:	The lifecycle_state of this DatabaseRegistrationSummary.
Return type:	str

secret_id¶

Gets the secret_id of this DatabaseRegistrationSummary. The OCID of the customer’s GoldenGate Service Secret. If provided, it references a key that customers will be required to ensure the policies are established to permit GoldenGate to use this Secret.

Returns:	The secret_id of this DatabaseRegistrationSummary.
Return type:	str

session_mode¶

Gets the session_mode of this DatabaseRegistrationSummary. The mode of the database connection session to be established by the data client. ‘REDIRECT’ - for a RAC database, ‘DIRECT’ - for a non-RAC database. Connection to a RAC database involves a redirection received from the SCAN listeners to the database node to connect to. By default the mode would be DIRECT.

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

Returns:	The session_mode of this DatabaseRegistrationSummary.
Return type:	str

subnet_id¶

Gets the subnet_id of this DatabaseRegistrationSummary. The OCID of the target subnet of the dedicated connection.

Returns:	The subnet_id of this DatabaseRegistrationSummary.
Return type:	str

system_tags¶

Gets the system_tags of this DatabaseRegistrationSummary. The system tags associated with this resource, if any. The system tags are set by Oracle Cloud Infrastructure services. Each key is predefined and scoped to namespaces. For more information, see Resource Tags.

Example: {orcl-cloud: {free-tier-retain: true}}

Returns:	The system_tags of this DatabaseRegistrationSummary.
Return type:	dict(str, dict(str, object))

time_created¶

Gets the time_created of this DatabaseRegistrationSummary. The time the resource was created. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.

Returns:	The time_created of this DatabaseRegistrationSummary.
Return type:	datetime

time_updated¶

Gets the time_updated of this DatabaseRegistrationSummary. The time the resource was last updated. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.

Returns:	The time_updated of this DatabaseRegistrationSummary.
Return type:	datetime

username¶

Gets the username of this DatabaseRegistrationSummary. The username Oracle GoldenGate uses to connect the associated system of the given technology. This username must already exist and be available by the system/application to be connected to and must conform to the case sensitivty requirments defined in it.

Returns:	The username of this DatabaseRegistrationSummary.
Return type:	str