ExternalDbSystemMacsConnector¶

class oci.database_management.models.ExternalDbSystemMacsConnector(**kwargs)¶

Bases: oci.database_management.models.external_db_system_connector.ExternalDbSystemConnector

The details of an external DB system connector that uses the Management Agent Cloud Service (MACS) to connect to an external DB system component.

Attributes

`CONNECTOR_TYPE_MACS`	str(object=’’) -> str
`LIFECYCLE_STATE_ACTIVE`	str(object=’’) -> str
`LIFECYCLE_STATE_CREATING`	str(object=’’) -> str
`LIFECYCLE_STATE_DELETED`	str(object=’’) -> str
`LIFECYCLE_STATE_DELETING`	str(object=’’) -> str
`LIFECYCLE_STATE_FAILED`	str(object=’’) -> str
`LIFECYCLE_STATE_INACTIVE`	str(object=’’) -> str
`LIFECYCLE_STATE_NOT_CONNECTED`	str(object=’’) -> str
`LIFECYCLE_STATE_UPDATING`	str(object=’’) -> str
`agent_id`	[Required] Gets the agent_id of this ExternalDbSystemMacsConnector.
`compartment_id`	[Required] Gets the compartment_id of this ExternalDbSystemConnector.
`connection_failure_message`	Gets the connection_failure_message of this ExternalDbSystemConnector.
`connection_info`	Gets the connection_info of this ExternalDbSystemMacsConnector.
`connection_status`	Gets the connection_status of this ExternalDbSystemConnector.
`connector_type`	[Required] Gets the connector_type of this ExternalDbSystemConnector.
`defined_tags`	Gets the defined_tags of this ExternalDbSystemMacsConnector.
`display_name`	[Required] Gets the display_name of this ExternalDbSystemConnector.
`external_db_system_id`	[Required] Gets the external_db_system_id of this ExternalDbSystemConnector.
`freeform_tags`	Gets the freeform_tags of this ExternalDbSystemMacsConnector.
`id`	[Required] Gets the id of this ExternalDbSystemConnector.
`lifecycle_details`	Gets the lifecycle_details of this ExternalDbSystemConnector.
`lifecycle_state`	[Required] Gets the lifecycle_state of this ExternalDbSystemConnector.
`system_tags`	Gets the system_tags of this ExternalDbSystemMacsConnector.
`time_connection_status_last_updated`	Gets the time_connection_status_last_updated of this ExternalDbSystemConnector.
`time_created`	[Required] Gets the time_created of this ExternalDbSystemConnector.
`time_updated`	[Required] Gets the time_updated of this ExternalDbSystemConnector.

Methods

`__init__`(**kwargs)	Initializes a new ExternalDbSystemMacsConnector 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.

CONNECTOR_TYPE_MACS = 'MACS'¶

LIFECYCLE_STATE_ACTIVE = 'ACTIVE'¶

LIFECYCLE_STATE_CREATING = 'CREATING'¶

LIFECYCLE_STATE_DELETED = 'DELETED'¶

LIFECYCLE_STATE_DELETING = 'DELETING'¶

LIFECYCLE_STATE_FAILED = 'FAILED'¶

LIFECYCLE_STATE_INACTIVE = 'INACTIVE'¶

LIFECYCLE_STATE_NOT_CONNECTED = 'NOT_CONNECTED'¶

LIFECYCLE_STATE_UPDATING = 'UPDATING'¶

__init__(**kwargs)¶

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

Parameters:

connector_type (str) – The value to assign to the connector_type property of this ExternalDbSystemMacsConnector. Allowed values for this property are: “MACS”
id (str) – The value to assign to the id property of this ExternalDbSystemMacsConnector.
display_name (str) – The value to assign to the display_name property of this ExternalDbSystemMacsConnector.
compartment_id (str) – The value to assign to the compartment_id property of this ExternalDbSystemMacsConnector.
external_db_system_id (str) – The value to assign to the external_db_system_id property of this ExternalDbSystemMacsConnector.
connection_status (str) – The value to assign to the connection_status property of this ExternalDbSystemMacsConnector.
connection_failure_message (str) – The value to assign to the connection_failure_message property of this ExternalDbSystemMacsConnector.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this ExternalDbSystemMacsConnector. Allowed values for this property are: “CREATING”, “NOT_CONNECTED”, “ACTIVE”, “INACTIVE”, “UPDATING”, “DELETING”, “DELETED”, “FAILED”
lifecycle_details (str) – The value to assign to the lifecycle_details property of this ExternalDbSystemMacsConnector.
time_connection_status_last_updated (datetime) – The value to assign to the time_connection_status_last_updated property of this ExternalDbSystemMacsConnector.
time_created (datetime) – The value to assign to the time_created property of this ExternalDbSystemMacsConnector.
time_updated (datetime) – The value to assign to the time_updated property of this ExternalDbSystemMacsConnector.
agent_id (str) – The value to assign to the agent_id property of this ExternalDbSystemMacsConnector.
connection_info (oci.database_management.models.ExternalDbSystemConnectionInfo) – The value to assign to the connection_info property of this ExternalDbSystemMacsConnector.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this ExternalDbSystemMacsConnector.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this ExternalDbSystemMacsConnector.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this ExternalDbSystemMacsConnector.

agent_id¶

[Required] Gets the agent_id of this ExternalDbSystemMacsConnector. The OCID of the management agent used for the external DB system connector.

Returns:	The agent_id of this ExternalDbSystemMacsConnector.
Return type:	str

compartment_id¶

[Required] Gets the compartment_id of this ExternalDbSystemConnector. The OCID of the compartment.

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

connection_failure_message¶

Gets the connection_failure_message of this ExternalDbSystemConnector. The error message indicating the reason for connection failure or null if the connection was successful.

Returns:	The connection_failure_message of this ExternalDbSystemConnector.
Return type:	str

connection_info¶

Gets the connection_info of this ExternalDbSystemMacsConnector.

Returns:	The connection_info of this ExternalDbSystemMacsConnector.
Return type:	oci.database_management.models.ExternalDbSystemConnectionInfo

connection_status¶

Gets the connection_status of this ExternalDbSystemConnector. The status of connectivity to the external DB system component.

Returns:	The connection_status of this ExternalDbSystemConnector.
Return type:	str

connector_type¶

[Required] Gets the connector_type of this ExternalDbSystemConnector. The type of connector.

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

Returns:	The connector_type of this ExternalDbSystemConnector.
Return type:	str

defined_tags¶

Gets the defined_tags of this ExternalDbSystemMacsConnector. 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 ExternalDbSystemMacsConnector.
Return type:	dict(str, dict(str, object))

display_name¶

[Required] Gets the display_name of this ExternalDbSystemConnector. The user-friendly name for the external connector. The name does not have to be unique.

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

external_db_system_id¶

[Required] Gets the external_db_system_id of this ExternalDbSystemConnector. The OCID of the external DB system that the connector is a part of.

Returns:	The external_db_system_id of this ExternalDbSystemConnector.
Return type:	str

freeform_tags¶

Gets the freeform_tags of this ExternalDbSystemMacsConnector. 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 ExternalDbSystemMacsConnector.
Return type:	dict(str, 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.

id¶

[Required] Gets the id of this ExternalDbSystemConnector. The OCID of the external DB system connector.

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

lifecycle_details¶

Gets the lifecycle_details of this ExternalDbSystemConnector. Additional information about the current lifecycle state.

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

lifecycle_state¶

[Required] Gets the lifecycle_state of this ExternalDbSystemConnector. The current lifecycle state of the external DB system connector.

Allowed values for this property are: “CREATING”, “NOT_CONNECTED”, “ACTIVE”, “INACTIVE”, “UPDATING”, “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 ExternalDbSystemConnector.
Return type:	str

system_tags¶

Gets the system_tags of this ExternalDbSystemMacsConnector. 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 ExternalDbSystemMacsConnector.
Return type:	dict(str, dict(str, object))

time_connection_status_last_updated¶

Gets the time_connection_status_last_updated of this ExternalDbSystemConnector. The date and time the connectionStatus of the external DB system connector was last updated.

Returns:	The time_connection_status_last_updated of this ExternalDbSystemConnector.
Return type:	datetime

time_created¶

[Required] Gets the time_created of this ExternalDbSystemConnector. The date and time the external DB system connector was created.

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

time_updated¶

[Required] Gets the time_updated of this ExternalDbSystemConnector. The date and time the external DB system connector was last updated.

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