Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace ExternalListener

The details of an external listener.

Properties

Optional additionalDetails

additionalDetails: undefined | object

The additional details of the external listener defined in {@code {"key": "value"}} format. Example: {@code {"bar-key": "value"}}

Optional adrHomeDirectory

adrHomeDirectory: undefined | string

The directory that stores tracing and logging incidents when Automatic Diagnostic Repository (ADR) is enabled.

compartmentId

compartmentId: string

The OCID of the compartment.

componentName

componentName: string

The name of the external listener.

Optional definedTags

definedTags: undefined | object

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {@code {"Operations": {"CostCenter": "42"}}}

displayName

displayName: string

The user-friendly name for the external listener. The name does not have to be unique.

Optional endpoints

The list of protocol addresses the listener is configured to listen on.

Optional externalConnectorId

externalConnectorId: undefined | string

The OCID of the external connector.

Optional externalDbHomeId

externalDbHomeId: undefined | string

The OCID of the external DB home.

Optional externalDbNodeId

externalDbNodeId: undefined | string

The OCID of the external DB node.

externalDbSystemId

externalDbSystemId: string

The OCID of the external DB system that the listener is a part of.

Optional freeformTags

freeformTags: undefined | object

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: {@code {"Department": "Finance"}}

Optional hostName

hostName: undefined | string

The name of the host on which the external listener is running.

id

id: string

The OCID of the external listener.

Optional lifecycleDetails

lifecycleDetails: undefined | string

Additional information about the current lifecycle state.

lifecycleState

lifecycleState: LifecycleState

The current lifecycle state of the external listener.

Optional listenerAlias

listenerAlias: undefined | string

The listener alias.

Optional listenerOraLocation

listenerOraLocation: undefined | string

The location of the listener configuration file listener.ora.

Optional listenerType

listenerType: ListenerType

The type of listener.

Optional logDirectory

logDirectory: undefined | string

The destination directory of the listener log file.

Optional oracleHome

oracleHome: undefined | string

The Oracle home location of the listener.

Optional servicedAsms

servicedAsms: Array<ExternalServicedAsm>

The list of ASMs that are serviced by the listener.

Optional servicedDatabases

The list of databases that are serviced by the listener.

timeCreated

timeCreated: Date

The date and time the external listener was created.

timeUpdated

timeUpdated: Date

The date and time the external listener was last updated.

Optional traceDirectory

traceDirectory: undefined | string

The destination directory of the listener trace file.

Optional version

version: undefined | string

The listener version.

Functions

getDeserializedJsonObj

getJsonObj