ExternalListener¶
-
class
oci.database_management.models.
ExternalListener
(**kwargs)¶ Bases:
object
The details of an external listener.
Attributes
LIFECYCLE_STATE_ACTIVE
A constant which can be used with the lifecycle_state property of a ExternalListener. LIFECYCLE_STATE_CREATING
A constant which can be used with the lifecycle_state property of a ExternalListener. LIFECYCLE_STATE_DELETED
A constant which can be used with the lifecycle_state property of a ExternalListener. LIFECYCLE_STATE_DELETING
A constant which can be used with the lifecycle_state property of a ExternalListener. LIFECYCLE_STATE_FAILED
A constant which can be used with the lifecycle_state property of a ExternalListener. LIFECYCLE_STATE_INACTIVE
A constant which can be used with the lifecycle_state property of a ExternalListener. LIFECYCLE_STATE_NOT_CONNECTED
A constant which can be used with the lifecycle_state property of a ExternalListener. LIFECYCLE_STATE_UPDATING
A constant which can be used with the lifecycle_state property of a ExternalListener. LISTENER_TYPE_ASM
A constant which can be used with the listener_type property of a ExternalListener. LISTENER_TYPE_LOCAL
A constant which can be used with the listener_type property of a ExternalListener. LISTENER_TYPE_SCAN
A constant which can be used with the listener_type property of a ExternalListener. additional_details
Gets the additional_details of this ExternalListener. adr_home_directory
Gets the adr_home_directory of this ExternalListener. compartment_id
[Required] Gets the compartment_id of this ExternalListener. component_name
[Required] Gets the component_name of this ExternalListener. defined_tags
Gets the defined_tags of this ExternalListener. display_name
[Required] Gets the display_name of this ExternalListener. endpoints
Gets the endpoints of this ExternalListener. external_connector_id
Gets the external_connector_id of this ExternalListener. external_db_home_id
Gets the external_db_home_id of this ExternalListener. external_db_node_id
Gets the external_db_node_id of this ExternalListener. external_db_system_id
[Required] Gets the external_db_system_id of this ExternalListener. freeform_tags
Gets the freeform_tags of this ExternalListener. host_name
Gets the host_name of this ExternalListener. id
[Required] Gets the id of this ExternalListener. lifecycle_details
Gets the lifecycle_details of this ExternalListener. lifecycle_state
[Required] Gets the lifecycle_state of this ExternalListener. listener_alias
Gets the listener_alias of this ExternalListener. listener_ora_location
Gets the listener_ora_location of this ExternalListener. listener_type
Gets the listener_type of this ExternalListener. log_directory
Gets the log_directory of this ExternalListener. oracle_home
Gets the oracle_home of this ExternalListener. serviced_asms
Gets the serviced_asms of this ExternalListener. serviced_databases
Gets the serviced_databases of this ExternalListener. system_tags
Gets the system_tags of this ExternalListener. time_created
[Required] Gets the time_created of this ExternalListener. time_updated
[Required] Gets the time_updated of this ExternalListener. trace_directory
Gets the trace_directory of this ExternalListener. version
Gets the version of this ExternalListener. Methods
__init__
(**kwargs)Initializes a new ExternalListener object with values from keyword arguments. -
LIFECYCLE_STATE_ACTIVE
= 'ACTIVE'¶ A constant which can be used with the lifecycle_state property of a ExternalListener. This constant has a value of “ACTIVE”
-
LIFECYCLE_STATE_CREATING
= 'CREATING'¶ A constant which can be used with the lifecycle_state property of a ExternalListener. This constant has a value of “CREATING”
-
LIFECYCLE_STATE_DELETED
= 'DELETED'¶ A constant which can be used with the lifecycle_state property of a ExternalListener. This constant has a value of “DELETED”
-
LIFECYCLE_STATE_DELETING
= 'DELETING'¶ A constant which can be used with the lifecycle_state property of a ExternalListener. This constant has a value of “DELETING”
-
LIFECYCLE_STATE_FAILED
= 'FAILED'¶ A constant which can be used with the lifecycle_state property of a ExternalListener. This constant has a value of “FAILED”
-
LIFECYCLE_STATE_INACTIVE
= 'INACTIVE'¶ A constant which can be used with the lifecycle_state property of a ExternalListener. 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 ExternalListener. 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 ExternalListener. This constant has a value of “UPDATING”
-
LISTENER_TYPE_ASM
= 'ASM'¶ A constant which can be used with the listener_type property of a ExternalListener. This constant has a value of “ASM”
-
LISTENER_TYPE_LOCAL
= 'LOCAL'¶ A constant which can be used with the listener_type property of a ExternalListener. This constant has a value of “LOCAL”
-
LISTENER_TYPE_SCAN
= 'SCAN'¶ A constant which can be used with the listener_type property of a ExternalListener. This constant has a value of “SCAN”
-
__init__
(**kwargs)¶ Initializes a new ExternalListener 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 ExternalListener.
- display_name (str) – The value to assign to the display_name property of this ExternalListener.
- component_name (str) – The value to assign to the component_name property of this ExternalListener.
- compartment_id (str) – The value to assign to the compartment_id property of this ExternalListener.
- external_db_system_id (str) – The value to assign to the external_db_system_id property of this ExternalListener.
- external_connector_id (str) – The value to assign to the external_connector_id property of this ExternalListener.
- external_db_node_id (str) – The value to assign to the external_db_node_id property of this ExternalListener.
- external_db_home_id (str) – The value to assign to the external_db_home_id property of this ExternalListener.
- listener_alias (str) – The value to assign to the listener_alias property of this ExternalListener.
- listener_type (str) – The value to assign to the listener_type property of this ExternalListener. 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 ExternalListener.
- lifecycle_state (str) – The value to assign to the lifecycle_state property of this ExternalListener. 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 ExternalListener.
- listener_ora_location (str) – The value to assign to the listener_ora_location property of this ExternalListener.
- oracle_home (str) – The value to assign to the oracle_home property of this ExternalListener.
- host_name (str) – The value to assign to the host_name property of this ExternalListener.
- adr_home_directory (str) – The value to assign to the adr_home_directory property of this ExternalListener.
- log_directory (str) – The value to assign to the log_directory property of this ExternalListener.
- trace_directory (str) – The value to assign to the trace_directory property of this ExternalListener.
- version (str) – The value to assign to the version property of this ExternalListener.
- endpoints (list[oci.database_management.models.ExternalListenerEndpoint]) – The value to assign to the endpoints property of this ExternalListener.
- serviced_databases (list[oci.database_management.models.ExternalListenerServicedDatabase]) – The value to assign to the serviced_databases property of this ExternalListener.
- serviced_asms (list[oci.database_management.models.ExternalServicedAsm]) – The value to assign to the serviced_asms property of this ExternalListener.
- time_created (datetime) – The value to assign to the time_created property of this ExternalListener.
- time_updated (datetime) – The value to assign to the time_updated property of this ExternalListener.
- freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this ExternalListener.
- defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this ExternalListener.
- system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this ExternalListener.
-
additional_details
¶ Gets the additional_details of this ExternalListener. The additional details of the external listener defined in {“key”: “value”} format. Example: {“bar-key”: “value”}
Returns: The additional_details of this ExternalListener. Return type: dict(str, str)
-
adr_home_directory
¶ Gets the adr_home_directory of this ExternalListener. The directory that stores tracing and logging incidents when Automatic Diagnostic Repository (ADR) is enabled.
Returns: The adr_home_directory of this ExternalListener. Return type: str
-
compartment_id
¶ [Required] Gets the compartment_id of this ExternalListener. The OCID of the compartment.
Returns: The compartment_id of this ExternalListener. Return type: str
-
component_name
¶ [Required] Gets the component_name of this ExternalListener. The name of the external listener.
Returns: The component_name of this ExternalListener. Return type: str
Gets the defined_tags of this ExternalListener. 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 ExternalListener. Return type: dict(str, dict(str, object))
-
display_name
¶ [Required] Gets the display_name of this ExternalListener. The user-friendly name for the external listener. The name does not have to be unique.
Returns: The display_name of this ExternalListener. Return type: str
-
endpoints
¶ Gets the endpoints of this ExternalListener. The list of protocol addresses the listener is configured to listen on.
Returns: The endpoints of this ExternalListener. Return type: list[oci.database_management.models.ExternalListenerEndpoint]
-
external_connector_id
¶ Gets the external_connector_id of this ExternalListener. The OCID of the external connector.
Returns: The external_connector_id of this ExternalListener. Return type: str
-
external_db_home_id
¶ Gets the external_db_home_id of this ExternalListener. The OCID of the external DB home.
Returns: The external_db_home_id of this ExternalListener. Return type: str
-
external_db_node_id
¶ Gets the external_db_node_id of this ExternalListener. The OCID of the external DB node.
Returns: The external_db_node_id of this ExternalListener. Return type: str
-
external_db_system_id
¶ [Required] Gets the external_db_system_id of this ExternalListener. The OCID of the external DB system that the listener is a part of.
Returns: The external_db_system_id of this ExternalListener. Return type: str
Gets the freeform_tags of this ExternalListener. 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 ExternalListener. Return type: dict(str, str)
-
host_name
¶ Gets the host_name of this ExternalListener. The name of the host on which the external listener is running.
Returns: The host_name of this ExternalListener. Return type: str
-
id
¶ [Required] Gets the id of this ExternalListener. The OCID of the external listener.
Returns: The id of this ExternalListener. Return type: str
-
lifecycle_details
¶ Gets the lifecycle_details of this ExternalListener. Additional information about the current lifecycle state.
Returns: The lifecycle_details of this ExternalListener. Return type: str
-
lifecycle_state
¶ [Required] Gets the lifecycle_state of this ExternalListener. The current lifecycle state of the external 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 ExternalListener. Return type: str
-
listener_alias
¶ Gets the listener_alias of this ExternalListener. The listener alias.
Returns: The listener_alias of this ExternalListener. Return type: str
-
listener_ora_location
¶ Gets the listener_ora_location of this ExternalListener. The location of the listener configuration file listener.ora.
Returns: The listener_ora_location of this ExternalListener. Return type: str
-
listener_type
¶ Gets the listener_type of this ExternalListener. 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 ExternalListener. Return type: str
-
log_directory
¶ Gets the log_directory of this ExternalListener. The destination directory of the listener log file.
Returns: The log_directory of this ExternalListener. Return type: str
-
oracle_home
¶ Gets the oracle_home of this ExternalListener. The Oracle home location of the listener.
Returns: The oracle_home of this ExternalListener. Return type: str
-
serviced_asms
¶ Gets the serviced_asms of this ExternalListener. The list of ASMs that are serviced by the listener.
Returns: The serviced_asms of this ExternalListener. Return type: list[oci.database_management.models.ExternalServicedAsm]
-
serviced_databases
¶ Gets the serviced_databases of this ExternalListener. The list of databases that are serviced by the listener.
Returns: The serviced_databases of this ExternalListener. Return type: list[oci.database_management.models.ExternalListenerServicedDatabase]
Gets the system_tags of this ExternalListener. 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 ExternalListener. Return type: dict(str, dict(str, object))
-
time_created
¶ [Required] Gets the time_created of this ExternalListener. The date and time the external listener was created.
Returns: The time_created of this ExternalListener. Return type: datetime
-
time_updated
¶ [Required] Gets the time_updated of this ExternalListener. The date and time the external listener was last updated.
Returns: The time_updated of this ExternalListener. Return type: datetime
-
trace_directory
¶ Gets the trace_directory of this ExternalListener. The destination directory of the listener trace file.
Returns: The trace_directory of this ExternalListener. Return type: str
-
version
¶ Gets the version of this ExternalListener. The listener version.
Returns: The version of this ExternalListener. Return type: str
-