Class ExternalListener

The details of an external listener.

Inheritance
object
ExternalListener
Inherited Members
Namespace: Oci.DatabasemanagementService.Models
Assembly: OCI.DotNetSDK.Databasemanagement.dll
Syntax
public class ExternalListener

Properties

AdditionalDetails

Declaration
[JsonProperty(PropertyName = "additionalDetails")]
public Dictionary<string, string> AdditionalDetails { get; set; }
Property Value
Type Description
Dictionary<string, string>

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

AdrHomeDirectory

Declaration
[JsonProperty(PropertyName = "adrHomeDirectory")]
public string AdrHomeDirectory { get; set; }
Property Value
Type Description
string

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

CompartmentId

Declaration
[Required(ErrorMessage = "CompartmentId is required.")]
[JsonProperty(PropertyName = "compartmentId")]
public string CompartmentId { get; set; }
Property Value
Type Description
string

The OCID of the compartment.
Remarks

Required

ComponentName

Declaration
[Required(ErrorMessage = "ComponentName is required.")]
[JsonProperty(PropertyName = "componentName")]
public string ComponentName { get; set; }
Property Value
Type Description
string

The name of the external listener.
Remarks

Required

DefinedTags

Declaration
[JsonProperty(PropertyName = "definedTags")]
public Dictionary<string, Dictionary<string, object>> DefinedTags { get; set; }
Property Value
Type Description
Dictionary<string, Dictionary<string, object>>

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

DisplayName

Declaration
[Required(ErrorMessage = "DisplayName is required.")]
[JsonProperty(PropertyName = "displayName")]
public string DisplayName { get; set; }
Property Value
Type Description
string

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

Required

Endpoints

Declaration
[JsonProperty(PropertyName = "endpoints")]
public List<ExternalListenerEndpoint> Endpoints { get; set; }
Property Value
Type Description
List<ExternalListenerEndpoint>

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

ExternalConnectorId

Declaration
[JsonProperty(PropertyName = "externalConnectorId")]
public string ExternalConnectorId { get; set; }
Property Value
Type Description
string

The OCID of the external connector.

ExternalDbHomeId

Declaration
[JsonProperty(PropertyName = "externalDbHomeId")]
public string ExternalDbHomeId { get; set; }
Property Value
Type Description
string

The OCID of the external DB home.

ExternalDbNodeId

Declaration
[JsonProperty(PropertyName = "externalDbNodeId")]
public string ExternalDbNodeId { get; set; }
Property Value
Type Description
string

The OCID of the external DB node.

ExternalDbSystemId

Declaration
[Required(ErrorMessage = "ExternalDbSystemId is required.")]
[JsonProperty(PropertyName = "externalDbSystemId")]
public string ExternalDbSystemId { get; set; }
Property Value
Type Description
string

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

Required

FreeformTags

Declaration
[JsonProperty(PropertyName = "freeformTags")]
public Dictionary<string, string> FreeformTags { get; set; }
Property Value
Type Description
Dictionary<string, string>

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"}

HostName

Declaration
[JsonProperty(PropertyName = "hostName")]
public string HostName { get; set; }
Property Value
Type Description
string

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

Id

Declaration
[Required(ErrorMessage = "Id is required.")]
[JsonProperty(PropertyName = "id")]
public string Id { get; set; }
Property Value
Type Description
string

The OCID of the external listener.
Remarks

Required

LifecycleDetails

Declaration
[JsonProperty(PropertyName = "lifecycleDetails")]
public string LifecycleDetails { get; set; }
Property Value
Type Description
string

Additional information about the current lifecycle state.

LifecycleState

Declaration
[Required(ErrorMessage = "LifecycleState is required.")]
[JsonProperty(PropertyName = "lifecycleState")]
[JsonConverter(typeof(ResponseEnumConverter))]
public ExternalListener.LifecycleStateEnum? LifecycleState { get; set; }
Property Value
Type Description
ExternalListener.LifecycleStateEnum?

The current lifecycle state of the external listener.
Remarks

Required

ListenerAlias

Declaration
[JsonProperty(PropertyName = "listenerAlias")]
public string ListenerAlias { get; set; }
Property Value
Type Description
string

The listener alias.

ListenerOraLocation

Declaration
[JsonProperty(PropertyName = "listenerOraLocation")]
public string ListenerOraLocation { get; set; }
Property Value
Type Description
string

The location of the listener configuration file listener.ora.

ListenerType

Declaration
[JsonProperty(PropertyName = "listenerType")]
[JsonConverter(typeof(ResponseEnumConverter))]
public ExternalListener.ListenerTypeEnum? ListenerType { get; set; }
Property Value
Type Description
ExternalListener.ListenerTypeEnum?

The type of listener.

LogDirectory

Declaration
[JsonProperty(PropertyName = "logDirectory")]
public string LogDirectory { get; set; }
Property Value
Type Description
string

The destination directory of the listener log file.

OracleHome

Declaration
[JsonProperty(PropertyName = "oracleHome")]
public string OracleHome { get; set; }
Property Value
Type Description
string

The Oracle home location of the listener.

ServicedAsms

Declaration
[JsonProperty(PropertyName = "servicedAsms")]
public List<ExternalServicedAsm> ServicedAsms { get; set; }
Property Value
Type Description
List<ExternalServicedAsm>

The list of ASMs that are serviced by the listener.

ServicedDatabases

Declaration
[JsonProperty(PropertyName = "servicedDatabases")]
public List<ExternalListenerServicedDatabase> ServicedDatabases { get; set; }
Property Value
Type Description
List<ExternalListenerServicedDatabase>

The list of databases that are serviced by the listener.

SystemTags

Declaration
[JsonProperty(PropertyName = "systemTags")]
public Dictionary<string, Dictionary<string, object>> SystemTags { get; set; }
Property Value
Type Description
Dictionary<string, Dictionary<string, object>>

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"}}

TimeCreated

Declaration
[Required(ErrorMessage = "TimeCreated is required.")]
[JsonProperty(PropertyName = "timeCreated")]
public DateTime? TimeCreated { get; set; }
Property Value
Type Description
DateTime?

The date and time the external listener was created.
Remarks

Required

TimeUpdated

Declaration
[Required(ErrorMessage = "TimeUpdated is required.")]
[JsonProperty(PropertyName = "timeUpdated")]
public DateTime? TimeUpdated { get; set; }
Property Value
Type Description
DateTime?

The date and time the external listener was last updated.
Remarks

Required

TraceDirectory

Declaration
[JsonProperty(PropertyName = "traceDirectory")]
public string TraceDirectory { get; set; }
Property Value
Type Description
string

The destination directory of the listener trace file.

Version

Declaration
[JsonProperty(PropertyName = "version")]
public string Version { get; set; }
Property Value
Type Description
string

The listener version.