ExternalMacsConnector¶

class oci.database.models.ExternalMacsConnector(**kwargs)¶

Bases: oci.database.models.external_database_connector.ExternalDatabaseConnector

An Oracle Cloud Infrastructure resource that uses the Management Agent cloud service (MACS) to connect to an external Oracle Database.

Attributes

`CONNECTOR_TYPE_MACS`	str(object=’’) -> str
`LIFECYCLE_STATE_AVAILABLE`	str(object=’’) -> str
`LIFECYCLE_STATE_FAILED`	str(object=’’) -> str
`LIFECYCLE_STATE_PROVISIONING`	str(object=’’) -> str
`LIFECYCLE_STATE_TERMINATED`	str(object=’’) -> str
`LIFECYCLE_STATE_TERMINATING`	str(object=’’) -> str
`LIFECYCLE_STATE_UPDATING`	str(object=’’) -> str
`compartment_id`	[Required] Gets the compartment_id of this ExternalDatabaseConnector.
`connection_credentials`	[Required] Gets the connection_credentials of this ExternalMacsConnector.
`connection_status`	[Required] Gets the connection_status of this ExternalDatabaseConnector.
`connection_string`	[Required] Gets the connection_string of this ExternalMacsConnector.
`connector_agent_id`	[Required] Gets the connector_agent_id of this ExternalMacsConnector.
`connector_type`	[Required] Gets the connector_type of this ExternalDatabaseConnector.
`defined_tags`	Gets the defined_tags of this ExternalDatabaseConnector.
`display_name`	[Required] Gets the display_name of this ExternalDatabaseConnector.
`external_database_id`	[Required] Gets the external_database_id of this ExternalDatabaseConnector.
`freeform_tags`	Gets the freeform_tags of this ExternalDatabaseConnector.
`id`	[Required] Gets the id of this ExternalDatabaseConnector.
`lifecycle_details`	Gets the lifecycle_details of this ExternalDatabaseConnector.
`lifecycle_state`	[Required] Gets the lifecycle_state of this ExternalDatabaseConnector.
`time_connection_status_last_updated`	[Required] Gets the time_connection_status_last_updated of this ExternalDatabaseConnector.
`time_created`	[Required] Gets the time_created of this ExternalDatabaseConnector.

Methods

`__init__`(**kwargs)	Initializes a new ExternalMacsConnector 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_AVAILABLE = 'AVAILABLE'¶

LIFECYCLE_STATE_FAILED = 'FAILED'¶

LIFECYCLE_STATE_PROVISIONING = 'PROVISIONING'¶

LIFECYCLE_STATE_TERMINATED = 'TERMINATED'¶

LIFECYCLE_STATE_TERMINATING = 'TERMINATING'¶

LIFECYCLE_STATE_UPDATING = 'UPDATING'¶

__init__(**kwargs)¶

Initializes a new ExternalMacsConnector 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:

compartment_id (str) – The value to assign to the compartment_id property of this ExternalMacsConnector.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this ExternalMacsConnector.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this ExternalMacsConnector.
display_name (str) – The value to assign to the display_name property of this ExternalMacsConnector.
id (str) – The value to assign to the id property of this ExternalMacsConnector.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this ExternalMacsConnector. Allowed values for this property are: “PROVISIONING”, “AVAILABLE”, “UPDATING”, “TERMINATING”, “TERMINATED”, “FAILED”
lifecycle_details (str) – The value to assign to the lifecycle_details property of this ExternalMacsConnector.
time_created (datetime) – The value to assign to the time_created property of this ExternalMacsConnector.
connector_type (str) – The value to assign to the connector_type property of this ExternalMacsConnector. Allowed values for this property are: “MACS”
external_database_id (str) – The value to assign to the external_database_id property of this ExternalMacsConnector.
connection_status (str) – The value to assign to the connection_status property of this ExternalMacsConnector.
time_connection_status_last_updated (datetime) – The value to assign to the time_connection_status_last_updated property of this ExternalMacsConnector.
connection_string (oci.database.models.DatabaseConnectionString) – The value to assign to the connection_string property of this ExternalMacsConnector.
connection_credentials (oci.database.models.DatabaseConnectionCredentials) – The value to assign to the connection_credentials property of this ExternalMacsConnector.
connector_agent_id (str) – The value to assign to the connector_agent_id property of this ExternalMacsConnector.

compartment_id¶

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

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

connection_credentials¶

[Required] Gets the connection_credentials of this ExternalMacsConnector.

Returns:	The connection_credentials of this ExternalMacsConnector.
Return type:	oci.database.models.DatabaseConnectionCredentials

connection_status¶

[Required] Gets the connection_status of this ExternalDatabaseConnector. The status of connectivity to the external database.

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

connection_string¶

[Required] Gets the connection_string of this ExternalMacsConnector.

Returns:	The connection_string of this ExternalMacsConnector.
Return type:	oci.database.models.DatabaseConnectionString

connector_agent_id¶

[Required] Gets the connector_agent_id of this ExternalMacsConnector. The ID of the agent used for the create_external_database_connector_details().

Returns:	The connector_agent_id of this ExternalMacsConnector.
Return type:	str

connector_type¶

[Required] Gets the connector_type of this ExternalDatabaseConnector. The type of connector used by the external database resource.

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 ExternalDatabaseConnector.
Return type:	str

defined_tags¶

Gets the defined_tags of this ExternalDatabaseConnector. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

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

display_name¶

[Required] Gets the display_name of this ExternalDatabaseConnector. The user-friendly name for the create_external_database_connector_details(). The name does not have to be unique.

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

external_database_id¶

[Required] Gets the external_database_id of this ExternalDatabaseConnector. The OCID of the external database resource.

Returns:	The external_database_id of this ExternalDatabaseConnector.
Return type:	str

freeform_tags¶

Gets the freeform_tags of this ExternalDatabaseConnector. 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 ExternalDatabaseConnector.
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 ExternalDatabaseConnector. The OCID of the create_external_database_connector_details().

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

lifecycle_details¶

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

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

lifecycle_state¶

[Required] Gets the lifecycle_state of this ExternalDatabaseConnector. The current lifecycle state of the external database connector resource.

Allowed values for this property are: “PROVISIONING”, “AVAILABLE”, “UPDATING”, “TERMINATING”, “TERMINATED”, “FAILED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

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

time_connection_status_last_updated¶

[Required] Gets the time_connection_status_last_updated of this ExternalDatabaseConnector. The date and time the connectionStatus of this external connector was last updated.

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

time_created¶

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

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