CloudDbSystemMacsConnector¶
- class oci.database_management.models.CloudDbSystemMacsConnector(**kwargs)¶
Bases:
CloudDbSystemConnectorThe details of a cloud DB system connector that uses the Management Agent Cloud Service (MACS) to connect to a cloud DB system component.
Attributes:
A constant which can be used with the connector_type property of a CloudDbSystemConnector.
A constant which can be used with the lifecycle_state property of a CloudDbSystemConnector.
A constant which can be used with the lifecycle_state property of a CloudDbSystemConnector.
A constant which can be used with the lifecycle_state property of a CloudDbSystemConnector.
A constant which can be used with the lifecycle_state property of a CloudDbSystemConnector.
A constant which can be used with the lifecycle_state property of a CloudDbSystemConnector.
A constant which can be used with the lifecycle_state property of a CloudDbSystemConnector.
A constant which can be used with the lifecycle_state property of a CloudDbSystemConnector.
A constant which can be used with the lifecycle_state property of a CloudDbSystemConnector.
[Required] Gets the agent_id of this CloudDbSystemMacsConnector.
[Required] Gets the cloud_db_system_id of this CloudDbSystemConnector.
[Required] Gets the compartment_id of this CloudDbSystemConnector.
Gets the connection_failure_message of this CloudDbSystemConnector.
Gets the connection_info of this CloudDbSystemMacsConnector.
Gets the connection_status of this CloudDbSystemConnector.
[Required] Gets the connector_type of this CloudDbSystemConnector.
Gets the defined_tags of this CloudDbSystemMacsConnector.
[Required] Gets the display_name of this CloudDbSystemConnector.
Gets the freeform_tags of this CloudDbSystemMacsConnector.
[Required] Gets the id of this CloudDbSystemConnector.
Gets the lifecycle_details of this CloudDbSystemConnector.
[Required] Gets the lifecycle_state of this CloudDbSystemConnector.
Gets the system_tags of this CloudDbSystemMacsConnector.
Gets the time_connection_status_last_updated of this CloudDbSystemConnector.
[Required] Gets the time_created of this CloudDbSystemConnector.
[Required] Gets the time_updated of this CloudDbSystemConnector.
Methods:
__init__(**kwargs)Initializes a new CloudDbSystemMacsConnector 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'¶
A constant which can be used with the connector_type property of a CloudDbSystemConnector. This constant has a value of “MACS”
- LIFECYCLE_STATE_ACTIVE = 'ACTIVE'¶
A constant which can be used with the lifecycle_state property of a CloudDbSystemConnector. This constant has a value of “ACTIVE”
- LIFECYCLE_STATE_CREATING = 'CREATING'¶
A constant which can be used with the lifecycle_state property of a CloudDbSystemConnector. This constant has a value of “CREATING”
- LIFECYCLE_STATE_DELETED = 'DELETED'¶
A constant which can be used with the lifecycle_state property of a CloudDbSystemConnector. This constant has a value of “DELETED”
- LIFECYCLE_STATE_DELETING = 'DELETING'¶
A constant which can be used with the lifecycle_state property of a CloudDbSystemConnector. This constant has a value of “DELETING”
- LIFECYCLE_STATE_FAILED = 'FAILED'¶
A constant which can be used with the lifecycle_state property of a CloudDbSystemConnector. This constant has a value of “FAILED”
- LIFECYCLE_STATE_INACTIVE = 'INACTIVE'¶
A constant which can be used with the lifecycle_state property of a CloudDbSystemConnector. This constant has a value of “INACTIVE”
- LIFECYCLE_STATE_NOT_CONNECTED = 'NOT_CONNECTED'¶
A constant which can be used with the lifecycle_state property of a CloudDbSystemConnector. This constant has a value of “NOT_CONNECTED”
- LIFECYCLE_STATE_UPDATING = 'UPDATING'¶
A constant which can be used with the lifecycle_state property of a CloudDbSystemConnector. This constant has a value of “UPDATING”
- __init__(**kwargs)¶
Initializes a new CloudDbSystemMacsConnector object with values from keyword arguments. The default value of the
connector_typeattribute of this class isMACSand 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 CloudDbSystemMacsConnector. Allowed values for this property are: “MACS”
id (str) – The value to assign to the id property of this CloudDbSystemMacsConnector.
display_name (str) – The value to assign to the display_name property of this CloudDbSystemMacsConnector.
compartment_id (str) – The value to assign to the compartment_id property of this CloudDbSystemMacsConnector.
cloud_db_system_id (str) – The value to assign to the cloud_db_system_id property of this CloudDbSystemMacsConnector.
connection_status (str) – The value to assign to the connection_status property of this CloudDbSystemMacsConnector.
connection_failure_message (str) – The value to assign to the connection_failure_message property of this CloudDbSystemMacsConnector.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this CloudDbSystemMacsConnector. 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 CloudDbSystemMacsConnector.
time_connection_status_last_updated (datetime) – The value to assign to the time_connection_status_last_updated property of this CloudDbSystemMacsConnector.
time_created (datetime) – The value to assign to the time_created property of this CloudDbSystemMacsConnector.
time_updated (datetime) – The value to assign to the time_updated property of this CloudDbSystemMacsConnector.
agent_id (str) – The value to assign to the agent_id property of this CloudDbSystemMacsConnector.
connection_info (oci.database_management.models.CloudDbSystemConnectionInfo) – The value to assign to the connection_info property of this CloudDbSystemMacsConnector.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this CloudDbSystemMacsConnector.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this CloudDbSystemMacsConnector.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this CloudDbSystemMacsConnector.
- property agent_id¶
[Required] Gets the agent_id of this CloudDbSystemMacsConnector. The OCID of the management agent used for the cloud DB system connector.
- Returns
The agent_id of this CloudDbSystemMacsConnector.
- Return type
str
- property cloud_db_system_id¶
[Required] Gets the cloud_db_system_id of this CloudDbSystemConnector. The OCID of the cloud DB system that the connector is a part of.
- Returns
The cloud_db_system_id of this CloudDbSystemConnector.
- Return type
str
- property compartment_id¶
[Required] Gets the compartment_id of this CloudDbSystemConnector. The OCID of the compartment.
- Returns
The compartment_id of this CloudDbSystemConnector.
- Return type
str
- property connection_failure_message¶
Gets the connection_failure_message of this CloudDbSystemConnector. The error message indicating the reason for connection failure or null if the connection was successful.
- Returns
The connection_failure_message of this CloudDbSystemConnector.
- Return type
str
- property connection_info¶
Gets the connection_info of this CloudDbSystemMacsConnector.
- Returns
The connection_info of this CloudDbSystemMacsConnector.
- Return type
- property connection_status¶
Gets the connection_status of this CloudDbSystemConnector. The status of connectivity to the cloud DB system component.
- Returns
The connection_status of this CloudDbSystemConnector.
- Return type
str
- property connector_type¶
[Required] Gets the connector_type of this CloudDbSystemConnector. 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 CloudDbSystemConnector.
- Return type
str
- property defined_tags¶
Gets the defined_tags of this CloudDbSystemMacsConnector. 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 CloudDbSystemMacsConnector.
- Return type
dict(str, dict(str, object))
- property display_name¶
[Required] Gets the display_name of this CloudDbSystemConnector. The user-friendly name for the cloud connector. The name does not have to be unique.
- Returns
The display_name of this CloudDbSystemConnector.
- Return type
str
- property freeform_tags¶
Gets the freeform_tags of this CloudDbSystemMacsConnector. 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 CloudDbSystemMacsConnector.
- 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.
- property id¶
[Required] Gets the id of this CloudDbSystemConnector. The OCID of the cloud DB system connector.
- Returns
The id of this CloudDbSystemConnector.
- Return type
str
- property lifecycle_details¶
Gets the lifecycle_details of this CloudDbSystemConnector. Additional information about the current lifecycle state.
- Returns
The lifecycle_details of this CloudDbSystemConnector.
- Return type
str
- property lifecycle_state¶
[Required] Gets the lifecycle_state of this CloudDbSystemConnector. The current lifecycle state of the cloud 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 CloudDbSystemConnector.
- Return type
str
- property system_tags¶
Gets the system_tags of this CloudDbSystemMacsConnector. 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 CloudDbSystemMacsConnector.
- Return type
dict(str, dict(str, object))
- property time_connection_status_last_updated¶
Gets the time_connection_status_last_updated of this CloudDbSystemConnector. The date and time the connectionStatus of the cloud DB system connector was last updated.
- Returns
The time_connection_status_last_updated of this CloudDbSystemConnector.
- Return type
datetime
- property time_created¶
[Required] Gets the time_created of this CloudDbSystemConnector. The date and time the cloud DB system connector was created.
- Returns
The time_created of this CloudDbSystemConnector.
- Return type
datetime
- property time_updated¶
[Required] Gets the time_updated of this CloudDbSystemConnector. The date and time the cloud DB system connector was last updated.
- Returns
The time_updated of this CloudDbSystemConnector.
- Return type
datetime