DiscoveredExternalListener¶

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

Bases: oci.database_management.models.discovered_external_db_system_component.DiscoveredExternalDbSystemComponent

The details of an Oracle listener discovered in an external DB system discovery run.

Attributes

`COMPONENT_TYPE_ASM`	str(object=’’) -> str
`COMPONENT_TYPE_ASM_INSTANCE`	str(object=’’) -> str
`COMPONENT_TYPE_CLUSTER`	str(object=’’) -> str
`COMPONENT_TYPE_CLUSTER_INSTANCE`	str(object=’’) -> str
`COMPONENT_TYPE_DATABASE`	str(object=’’) -> str
`COMPONENT_TYPE_DATABASE_HOME`	str(object=’’) -> str
`COMPONENT_TYPE_DATABASE_INSTANCE`	str(object=’’) -> str
`COMPONENT_TYPE_DATABASE_NODE`	str(object=’’) -> str
`COMPONENT_TYPE_DBSYSTEM`	str(object=’’) -> str
`COMPONENT_TYPE_LISTENER`	str(object=’’) -> str
`COMPONENT_TYPE_PLUGGABLE_DATABASE`	str(object=’’) -> str
`LISTENER_TYPE_ASM`	A constant which can be used with the listener_type property of a DiscoveredExternalListener.
`LISTENER_TYPE_LOCAL`	A constant which can be used with the listener_type property of a DiscoveredExternalListener.
`LISTENER_TYPE_SCAN`	A constant which can be used with the listener_type property of a DiscoveredExternalListener.
`STATUS_EXISTING`	str(object=’’) -> str
`STATUS_MARKED_FOR_DELETION`	str(object=’’) -> str
`STATUS_NEW`	str(object=’’) -> str
`STATUS_UNKNOWN`	str(object=’’) -> str
`adr_home_directory`	Gets the adr_home_directory of this DiscoveredExternalListener.
`associated_components`	Gets the associated_components of this DiscoveredExternalDbSystemComponent.
`component_id`	[Required] Gets the component_id of this DiscoveredExternalDbSystemComponent.
`component_name`	[Required] Gets the component_name of this DiscoveredExternalDbSystemComponent.
`component_type`	[Required] Gets the component_type of this DiscoveredExternalDbSystemComponent.
`connector`	Gets the connector of this DiscoveredExternalListener.
`db_node_name`	Gets the db_node_name of this DiscoveredExternalListener.
`display_name`	[Required] Gets the display_name of this DiscoveredExternalDbSystemComponent.
`endpoints`	Gets the endpoints of this DiscoveredExternalListener.
`host_name`	Gets the host_name of this DiscoveredExternalListener.
`is_selected_for_monitoring`	Gets the is_selected_for_monitoring of this DiscoveredExternalDbSystemComponent.
`listener_alias`	Gets the listener_alias of this DiscoveredExternalListener.
`listener_type`	Gets the listener_type of this DiscoveredExternalListener.
`log_directory`	Gets the log_directory of this DiscoveredExternalListener.
`oracle_home`	Gets the oracle_home of this DiscoveredExternalListener.
`resource_id`	Gets the resource_id of this DiscoveredExternalDbSystemComponent.
`status`	Gets the status of this DiscoveredExternalDbSystemComponent.
`trace_directory`	Gets the trace_directory of this DiscoveredExternalListener.
`version`	Gets the version of this DiscoveredExternalListener.

Methods

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

COMPONENT_TYPE_ASM = 'ASM'¶

COMPONENT_TYPE_ASM_INSTANCE = 'ASM_INSTANCE'¶

COMPONENT_TYPE_CLUSTER = 'CLUSTER'¶

COMPONENT_TYPE_CLUSTER_INSTANCE = 'CLUSTER_INSTANCE'¶

COMPONENT_TYPE_DATABASE = 'DATABASE'¶

COMPONENT_TYPE_DATABASE_HOME = 'DATABASE_HOME'¶

COMPONENT_TYPE_DATABASE_INSTANCE = 'DATABASE_INSTANCE'¶

COMPONENT_TYPE_DATABASE_NODE = 'DATABASE_NODE'¶

COMPONENT_TYPE_DBSYSTEM = 'DBSYSTEM'¶

COMPONENT_TYPE_LISTENER = 'LISTENER'¶

COMPONENT_TYPE_PLUGGABLE_DATABASE = 'PLUGGABLE_DATABASE'¶

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

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

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

STATUS_EXISTING = 'EXISTING'¶

STATUS_MARKED_FOR_DELETION = 'MARKED_FOR_DELETION'¶

STATUS_NEW = 'NEW'¶

STATUS_UNKNOWN = 'UNKNOWN'¶

__init__(**kwargs)¶

Initializes a new DiscoveredExternalListener object with values from keyword arguments. The default value of the component_type attribute of this class is LISTENER and it should not be changed. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:

component_id (str) – The value to assign to the component_id property of this DiscoveredExternalListener.
display_name (str) – The value to assign to the display_name property of this DiscoveredExternalListener.
component_name (str) – The value to assign to the component_name property of this DiscoveredExternalListener.
component_type (str) – The value to assign to the component_type property of this DiscoveredExternalListener. Allowed values for this property are: “ASM”, “ASM_INSTANCE”, “CLUSTER”, “CLUSTER_INSTANCE”, “DATABASE”, “DATABASE_INSTANCE”, “DATABASE_HOME”, “DATABASE_NODE”, “DBSYSTEM”, “LISTENER”, “PLUGGABLE_DATABASE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
resource_id (str) – The value to assign to the resource_id property of this DiscoveredExternalListener.
is_selected_for_monitoring (bool) – The value to assign to the is_selected_for_monitoring property of this DiscoveredExternalListener.
status (str) – The value to assign to the status property of this DiscoveredExternalListener. Allowed values for this property are: “NEW”, “EXISTING”, “MARKED_FOR_DELETION”, “UNKNOWN”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
associated_components (list[oci.database_management.models.AssociatedComponent]) – The value to assign to the associated_components property of this DiscoveredExternalListener.
db_node_name (str) – The value to assign to the db_node_name property of this DiscoveredExternalListener.
oracle_home (str) – The value to assign to the oracle_home property of this DiscoveredExternalListener.
listener_alias (str) – The value to assign to the listener_alias property of this DiscoveredExternalListener.
adr_home_directory (str) – The value to assign to the adr_home_directory property of this DiscoveredExternalListener.
log_directory (str) – The value to assign to the log_directory property of this DiscoveredExternalListener.
trace_directory (str) – The value to assign to the trace_directory property of this DiscoveredExternalListener.
version (str) – The value to assign to the version property of this DiscoveredExternalListener.
listener_type (str) – The value to assign to the listener_type property of this DiscoveredExternalListener. 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’.
host_name (str) – The value to assign to the host_name property of this DiscoveredExternalListener.
endpoints (list[oci.database_management.models.ExternalListenerEndpoint]) – The value to assign to the endpoints property of this DiscoveredExternalListener.
connector (oci.database_management.models.ExternalDbSystemDiscoveryConnector) – The value to assign to the connector property of this DiscoveredExternalListener.

adr_home_directory¶

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

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

associated_components¶

Gets the associated_components of this DiscoveredExternalDbSystemComponent. The list of associated components.

Returns:	The associated_components of this DiscoveredExternalDbSystemComponent.
Return type:	list[oci.database_management.models.AssociatedComponent]

component_id¶

[Required] Gets the component_id of this DiscoveredExternalDbSystemComponent. The identifier of the discovered DB system component.

Returns:	The component_id of this DiscoveredExternalDbSystemComponent.
Return type:	str

component_name¶

[Required] Gets the component_name of this DiscoveredExternalDbSystemComponent. The name of the discovered DB system component.

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

component_type¶

[Required] Gets the component_type of this DiscoveredExternalDbSystemComponent. The external DB system component type.

Allowed values for this property are: “ASM”, “ASM_INSTANCE”, “CLUSTER”, “CLUSTER_INSTANCE”, “DATABASE”, “DATABASE_INSTANCE”, “DATABASE_HOME”, “DATABASE_NODE”, “DBSYSTEM”, “LISTENER”, “PLUGGABLE_DATABASE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The component_type of this DiscoveredExternalDbSystemComponent.
Return type:	str

connector¶

Gets the connector of this DiscoveredExternalListener.

Returns:	The connector of this DiscoveredExternalListener.
Return type:	oci.database_management.models.ExternalDbSystemDiscoveryConnector

db_node_name¶

Gets the db_node_name of this DiscoveredExternalListener. The name of the DB node.

Returns:	The db_node_name of this DiscoveredExternalListener.
Return type:	str

display_name¶

[Required] Gets the display_name of this DiscoveredExternalDbSystemComponent. The user-friendly name for the discovered DB system component. The name does not have to be unique.

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

endpoints¶

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

Returns:	The endpoints of this DiscoveredExternalListener.
Return type:	list[oci.database_management.models.ExternalListenerEndpoint]

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.

host_name¶

Gets the host_name of this DiscoveredExternalListener. The name of the host on which the external listener is running.

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

is_selected_for_monitoring¶

Gets the is_selected_for_monitoring of this DiscoveredExternalDbSystemComponent. Indicates whether the DB system component should be provisioned as an OCI resource or not.

Returns:	The is_selected_for_monitoring of this DiscoveredExternalDbSystemComponent.
Return type:	bool

listener_alias¶

Gets the listener_alias of this DiscoveredExternalListener. The listener alias.

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

listener_type¶

Gets the listener_type of this DiscoveredExternalListener. 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 DiscoveredExternalListener.
Return type:	str

log_directory¶

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

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

oracle_home¶

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

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

resource_id¶

Gets the resource_id of this DiscoveredExternalDbSystemComponent. The OCID of the existing OCI resource matching the discovered DB system component.

Returns:	The resource_id of this DiscoveredExternalDbSystemComponent.
Return type:	str

status¶

Gets the status of this DiscoveredExternalDbSystemComponent. The state of the discovered DB system component.

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

Returns:	The status of this DiscoveredExternalDbSystemComponent.
Return type:	str

trace_directory¶

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

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

version¶

Gets the version of this DiscoveredExternalListener. The listener version.

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