CloudListener¶

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

Bases: object

The details of a cloud listener.

Attributes

`LIFECYCLE_STATE_ACTIVE`	A constant which can be used with the lifecycle_state property of a CloudListener.
`LIFECYCLE_STATE_CREATING`	A constant which can be used with the lifecycle_state property of a CloudListener.
`LIFECYCLE_STATE_DELETED`	A constant which can be used with the lifecycle_state property of a CloudListener.
`LIFECYCLE_STATE_DELETING`	A constant which can be used with the lifecycle_state property of a CloudListener.
`LIFECYCLE_STATE_FAILED`	A constant which can be used with the lifecycle_state property of a CloudListener.
`LIFECYCLE_STATE_INACTIVE`	A constant which can be used with the lifecycle_state property of a CloudListener.
`LIFECYCLE_STATE_NOT_CONNECTED`	A constant which can be used with the lifecycle_state property of a CloudListener.
`LIFECYCLE_STATE_UPDATING`	A constant which can be used with the lifecycle_state property of a CloudListener.
`LISTENER_TYPE_ASM`	A constant which can be used with the listener_type property of a CloudListener.
`LISTENER_TYPE_LOCAL`	A constant which can be used with the listener_type property of a CloudListener.
`LISTENER_TYPE_SCAN`	A constant which can be used with the listener_type property of a CloudListener.
`additional_details`	Gets the additional_details of this CloudListener.
`adr_home_directory`	Gets the adr_home_directory of this CloudListener.
`cloud_connector_id`	Gets the cloud_connector_id of this CloudListener.
`cloud_db_home_id`	Gets the cloud_db_home_id of this CloudListener.
`cloud_db_node_id`	Gets the cloud_db_node_id of this CloudListener.
`cloud_db_system_id`	[Required] Gets the cloud_db_system_id of this CloudListener.
`compartment_id`	[Required] Gets the compartment_id of this CloudListener.
`component_name`	[Required] Gets the component_name of this CloudListener.
`dbaas_id`	Gets the dbaas_id of this CloudListener.
`defined_tags`	Gets the defined_tags of this CloudListener.
`display_name`	[Required] Gets the display_name of this CloudListener.
`endpoints`	Gets the endpoints of this CloudListener.
`freeform_tags`	Gets the freeform_tags of this CloudListener.
`host_name`	Gets the host_name of this CloudListener.
`id`	[Required] Gets the id of this CloudListener.
`lifecycle_details`	Gets the lifecycle_details of this CloudListener.
`lifecycle_state`	[Required] Gets the lifecycle_state of this CloudListener.
`listener_alias`	Gets the listener_alias of this CloudListener.
`listener_ora_location`	Gets the listener_ora_location of this CloudListener.
`listener_type`	Gets the listener_type of this CloudListener.
`log_directory`	Gets the log_directory of this CloudListener.
`oracle_home`	Gets the oracle_home of this CloudListener.
`serviced_asms`	Gets the serviced_asms of this CloudListener.
`serviced_databases`	Gets the serviced_databases of this CloudListener.
`system_tags`	Gets the system_tags of this CloudListener.
`time_created`	[Required] Gets the time_created of this CloudListener.
`time_updated`	[Required] Gets the time_updated of this CloudListener.
`trace_directory`	Gets the trace_directory of this CloudListener.
`version`	Gets the version of this CloudListener.

Methods

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

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

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

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

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

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

LIFECYCLE_STATE_INACTIVE = 'INACTIVE'¶: A constant which can be used with the lifecycle_state property of a CloudListener. 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 CloudListener. 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 CloudListener. This constant has a value of “UPDATING”

LISTENER_TYPE_ASM = 'ASM'¶: A constant which can be used with the listener_type property of a CloudListener. This constant has a value of “ASM”

LISTENER_TYPE_LOCAL = 'LOCAL'¶: A constant which can be used with the listener_type property of a CloudListener. This constant has a value of “LOCAL”

LISTENER_TYPE_SCAN = 'SCAN'¶: A constant which can be used with the listener_type property of a CloudListener. This constant has a value of “SCAN”

__init__(**kwargs)¶

Initializes a new CloudListener 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 CloudListener.
dbaas_id (str) – The value to assign to the dbaas_id property of this CloudListener.
display_name (str) – The value to assign to the display_name property of this CloudListener.
component_name (str) – The value to assign to the component_name property of this CloudListener.
compartment_id (str) – The value to assign to the compartment_id property of this CloudListener.
cloud_db_system_id (str) – The value to assign to the cloud_db_system_id property of this CloudListener.
cloud_connector_id (str) – The value to assign to the cloud_connector_id property of this CloudListener.
cloud_db_node_id (str) – The value to assign to the cloud_db_node_id property of this CloudListener.
cloud_db_home_id (str) – The value to assign to the cloud_db_home_id property of this CloudListener.
listener_alias (str) – The value to assign to the listener_alias property of this CloudListener.
listener_type (str) – The value to assign to the listener_type property of this CloudListener. Allowed values for this property are: “ASM”, “LOCAL”, “SCAN”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
additional_details (dict(str, str)) – The value to assign to the additional_details property of this CloudListener.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this CloudListener. 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’.
lifecycle_details (str) – The value to assign to the lifecycle_details property of this CloudListener.
listener_ora_location (str) – The value to assign to the listener_ora_location property of this CloudListener.
oracle_home (str) – The value to assign to the oracle_home property of this CloudListener.
host_name (str) – The value to assign to the host_name property of this CloudListener.
adr_home_directory (str) – The value to assign to the adr_home_directory property of this CloudListener.
log_directory (str) – The value to assign to the log_directory property of this CloudListener.
trace_directory (str) – The value to assign to the trace_directory property of this CloudListener.
version (str) – The value to assign to the version property of this CloudListener.
endpoints (list[oci.database_management.models.CloudListenerEndpoint]) – The value to assign to the endpoints property of this CloudListener.
serviced_databases (list[oci.database_management.models.CloudListenerServicedDatabase]) – The value to assign to the serviced_databases property of this CloudListener.
serviced_asms (list[oci.database_management.models.CloudServicedAsm]) – The value to assign to the serviced_asms property of this CloudListener.
time_created (datetime) – The value to assign to the time_created property of this CloudListener.
time_updated (datetime) – The value to assign to the time_updated property of this CloudListener.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this CloudListener.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this CloudListener.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this CloudListener.

additional_details¶

Gets the additional_details of this CloudListener. The additional details of the cloud listener defined in {“key”: “value”} format. Example: {“bar-key”: “value”}

Returns:	The additional_details of this CloudListener.
Return type:	dict(str, str)

adr_home_directory¶

Gets the adr_home_directory of this CloudListener. The directory that stores tracing and logging incidents when Automatic Diagnostic Repository (ADR) is enabled.

Returns:	The adr_home_directory of this CloudListener.
Return type:	str

cloud_connector_id¶

Gets the cloud_connector_id of this CloudListener. The OCID of the cloud connector.

Returns:	The cloud_connector_id of this CloudListener.
Return type:	str

cloud_db_home_id¶

Gets the cloud_db_home_id of this CloudListener. The OCID of the cloud DB home.

Returns:	The cloud_db_home_id of this CloudListener.
Return type:	str

cloud_db_node_id¶

Gets the cloud_db_node_id of this CloudListener. The OCID of the cloud DB node.

Returns:	The cloud_db_node_id of this CloudListener.
Return type:	str

cloud_db_system_id¶

[Required] Gets the cloud_db_system_id of this CloudListener. The OCID of the cloud DB system that the listener is a part of.

Returns:	The cloud_db_system_id of this CloudListener.
Return type:	str

compartment_id¶

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

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

component_name¶

[Required] Gets the component_name of this CloudListener. The name of the cloud listener.

Returns:	The component_name of this CloudListener.
Return type:	str

dbaas_id¶

Gets the dbaas_id of this CloudListener. The OCID in DBaas service.

Returns:	The dbaas_id of this CloudListener.
Return type:	str

defined_tags¶

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

display_name¶

[Required] Gets the display_name of this CloudListener. The user-friendly name for the cloud listener. The name does not have to be unique.

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

endpoints¶

Gets the endpoints of this CloudListener. The list of protocol addresses the listener is configured to listen on.

Returns:	The endpoints of this CloudListener.
Return type:	list[oci.database_management.models.CloudListenerEndpoint]

freeform_tags¶

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

host_name¶

Gets the host_name of this CloudListener. The name of the host on which the cloud listener is running.

Returns:	The host_name of this CloudListener.
Return type:	str

id¶

[Required] Gets the id of this CloudListener. The OCID of the cloud listener.

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

lifecycle_details¶

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

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

lifecycle_state¶

[Required] Gets the lifecycle_state of this CloudListener. The current lifecycle state of the cloud listener.

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

listener_alias¶

Gets the listener_alias of this CloudListener. The listener alias.

Returns:	The listener_alias of this CloudListener.
Return type:	str

listener_ora_location¶

Gets the listener_ora_location of this CloudListener. The location of the listener configuration file listener.ora.

Returns:	The listener_ora_location of this CloudListener.
Return type:	str

listener_type¶

Gets the listener_type of this CloudListener. The type of listener.

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

Returns:	The listener_type of this CloudListener.
Return type:	str

log_directory¶

Gets the log_directory of this CloudListener. The destination directory of the listener log file.

Returns:	The log_directory of this CloudListener.
Return type:	str

oracle_home¶

Gets the oracle_home of this CloudListener. The Oracle home location of the listener.

Returns:	The oracle_home of this CloudListener.
Return type:	str

serviced_asms¶

Gets the serviced_asms of this CloudListener. The list of ASMs that are serviced by the listener.

Returns:	The serviced_asms of this CloudListener.
Return type:	list[oci.database_management.models.CloudServicedAsm]

serviced_databases¶

Gets the serviced_databases of this CloudListener. The list of databases that are serviced by the listener.

Returns:	The serviced_databases of this CloudListener.
Return type:	list[oci.database_management.models.CloudListenerServicedDatabase]

system_tags¶

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

time_created¶

[Required] Gets the time_created of this CloudListener. The date and time the cloud listener was created.

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

time_updated¶

[Required] Gets the time_updated of this CloudListener. The date and time the cloud listener was last updated.

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

trace_directory¶

Gets the trace_directory of this CloudListener. The destination directory of the listener trace file.

Returns:	The trace_directory of this CloudListener.
Return type:	str

version¶

Gets the version of this CloudListener. The listener version.

Returns:	The version of this CloudListener.
Return type:	str