ConnectionSummary¶

class oci.database_migration.models.ConnectionSummary(**kwargs)¶

Bases: object

Represents the parameters common for all connections in list operation.

Attributes

`CONNECTION_TYPE_MYSQL`	A constant which can be used with the connection_type property of a ConnectionSummary.
`CONNECTION_TYPE_ORACLE`	A constant which can be used with the connection_type property of a ConnectionSummary.
`compartment_id`	[Required] Gets the compartment_id of this ConnectionSummary.
`connection_type`	[Required] Gets the connection_type of this ConnectionSummary.
`defined_tags`	Gets the defined_tags of this ConnectionSummary.
`description`	Gets the description of this ConnectionSummary.
`display_name`	[Required] Gets the display_name of this ConnectionSummary.
`freeform_tags`	Gets the freeform_tags of this ConnectionSummary.
`id`	[Required] Gets the id of this ConnectionSummary.
`ingress_ips`	Gets the ingress_ips of this ConnectionSummary.
`key_id`	Gets the key_id of this ConnectionSummary.
`lifecycle_details`	Gets the lifecycle_details of this ConnectionSummary.
`lifecycle_state`	[Required] Gets the lifecycle_state of this ConnectionSummary.
`nsg_ids`	Gets the nsg_ids of this ConnectionSummary.
`subnet_id`	Gets the subnet_id of this ConnectionSummary.
`system_tags`	Gets the system_tags of this ConnectionSummary.
`time_created`	[Required] Gets the time_created of this ConnectionSummary.
`time_updated`	[Required] Gets the time_updated of this ConnectionSummary.
`vault_id`	Gets the vault_id of this ConnectionSummary.

Methods

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

CONNECTION_TYPE_MYSQL = 'MYSQL'¶: A constant which can be used with the connection_type property of a ConnectionSummary. This constant has a value of “MYSQL”

CONNECTION_TYPE_ORACLE = 'ORACLE'¶: A constant which can be used with the connection_type property of a ConnectionSummary. This constant has a value of “ORACLE”

__init__(**kwargs)¶

Initializes a new ConnectionSummary object with values from keyword arguments. This class has the following subclasses and if you are using this class as input to a service operations then you should favor using a subclass over the base class:

The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:

connection_type (str) – The value to assign to the connection_type property of this ConnectionSummary. Allowed values for this property are: “MYSQL”, “ORACLE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
id (str) – The value to assign to the id property of this ConnectionSummary.
display_name (str) – The value to assign to the display_name property of this ConnectionSummary.
description (str) – The value to assign to the description property of this ConnectionSummary.
compartment_id (str) – The value to assign to the compartment_id property of this ConnectionSummary.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this ConnectionSummary.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this ConnectionSummary.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this ConnectionSummary.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this ConnectionSummary.
lifecycle_details (str) – The value to assign to the lifecycle_details property of this ConnectionSummary.
time_created (datetime) – The value to assign to the time_created property of this ConnectionSummary.
time_updated (datetime) – The value to assign to the time_updated property of this ConnectionSummary.
vault_id (str) – The value to assign to the vault_id property of this ConnectionSummary.
key_id (str) – The value to assign to the key_id property of this ConnectionSummary.
subnet_id (str) – The value to assign to the subnet_id property of this ConnectionSummary.
ingress_ips (list[oci.database_migration.models.IngressIpDetails]) – The value to assign to the ingress_ips property of this ConnectionSummary.
nsg_ids (list[str]) – The value to assign to the nsg_ids property of this ConnectionSummary.

compartment_id¶

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

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

connection_type¶

[Required] Gets the connection_type of this ConnectionSummary. Defines the type of connection. For example, ORACLE.

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

Returns:	The connection_type of this ConnectionSummary.
Return type:	str

defined_tags¶

Gets the defined_tags of this ConnectionSummary. Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {“foo-namespace”: {“bar-key”: “value”}}

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

description¶

Gets the description of this ConnectionSummary. A user-friendly description. Does not have to be unique, and it’s changeable. Avoid entering confidential information.

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

display_name¶

[Required] Gets the display_name of this ConnectionSummary. A user-friendly name. Does not have to be unique, and it’s changeable. Avoid entering confidential information.

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

freeform_tags¶

Gets the freeform_tags of this ConnectionSummary. 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 ConnectionSummary.
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 ConnectionSummary. The OCID of the connection being referenced.

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

ingress_ips¶

Gets the ingress_ips of this ConnectionSummary. List of ingress IP addresses from where to connect to this connection’s privateIp.

Returns:	The ingress_ips of this ConnectionSummary.
Return type:	list[oci.database_migration.models.IngressIpDetails]

key_id¶

Gets the key_id of this ConnectionSummary. The OCID of the key used in cryptographic operations.

Returns:	The key_id of this ConnectionSummary.
Return type:	str

lifecycle_details¶

Gets the lifecycle_details of this ConnectionSummary. A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.

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

lifecycle_state¶

[Required] Gets the lifecycle_state of this ConnectionSummary. Lifecycle state for connection.

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

nsg_ids¶

Gets the nsg_ids of this ConnectionSummary. An array of Network Security Group OCIDs used to define network access for Connections.

Returns:	The nsg_ids of this ConnectionSummary.
Return type:	list[str]

subnet_id¶

Gets the subnet_id of this ConnectionSummary. OCI resource ID.

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

system_tags¶

Gets the system_tags of this ConnectionSummary. Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {“orcl-cloud”: {“free-tier-retained”: “true”}}

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

time_created¶

[Required] Gets the time_created of this ConnectionSummary. The time when this resource was created. An RFC3339 formatted datetime string such as 2016-08-25T21:10:29.600Z.

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

time_updated¶

[Required] Gets the time_updated of this ConnectionSummary. The time when this resource was updated. An RFC3339 formatted datetime string such as 2016-08-25T21:10:29.600Z.

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

vault_id¶

Gets the vault_id of this ConnectionSummary. OCI resource ID.

Returns:	The vault_id of this ConnectionSummary.
Return type:	str