@Generated(value="OracleSDKGenerator",
comments="API Version: 20201101")
public final class ExternalListener
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
The details of an external listener.
Note: Objects should always be created or deserialized using the ExternalListener.Builder. This model
distinguishes fields that are null because they are unset from fields that are explicitly
set to null. This is done in the setter methods of the ExternalListener.Builder, which maintain a
set of all explicitly set fields called ExternalListener.Builder.__explicitlySet__. The hashCode() and equals(Object) methods are implemented to take the explicitly set
fields into account. The constructor, on the other hand, does not take the explicitly set fields
into account (since the constructor cannot distinguish explicit null from unset null).
| Modifier and Type | Class and Description |
|---|---|
static class |
ExternalListener.Builder |
static class |
ExternalListener.LifecycleState
The current lifecycle state of the external listener.
|
static class |
ExternalListener.ListenerType
The type of listener.
|
EXPLICITLY_SET_FILTER_NAME, EXPLICITLY_SET_PROPERTY_NAME| Constructor and Description |
|---|
ExternalListener(String id,
String displayName,
String componentName,
String compartmentId,
String externalDbSystemId,
String externalConnectorId,
String externalDbNodeId,
String externalDbHomeId,
String listenerAlias,
ExternalListener.ListenerType listenerType,
Map<String,String> additionalDetails,
ExternalListener.LifecycleState lifecycleState,
String lifecycleDetails,
String listenerOraLocation,
String oracleHome,
String hostName,
String adrHomeDirectory,
String logDirectory,
String traceDirectory,
String version,
List<ExternalListenerEndpoint> endpoints,
List<ExternalListenerServicedDatabase> servicedDatabases,
List<ExternalServicedAsm> servicedAsms,
Date timeCreated,
Date timeUpdated,
Map<String,String> freeformTags,
Map<String,Map<String,Object>> definedTags,
Map<String,Map<String,Object>> systemTags)
Deprecated.
|
| Modifier and Type | Method and Description |
|---|---|
static ExternalListener.Builder |
builder()
Create a new builder.
|
boolean |
equals(Object o) |
Map<String,String> |
getAdditionalDetails()
The additional details of the external listener defined in
{"key": "value"} format. |
String |
getAdrHomeDirectory()
The directory that stores tracing and logging incidents when Automatic Diagnostic Repository
(ADR) is enabled.
|
String |
getCompartmentId()
The OCID of the
compartment.
|
String |
getComponentName()
The name of the external listener.
|
Map<String,Map<String,Object>> |
getDefinedTags()
Defined tags for this resource.
|
String |
getDisplayName()
The user-friendly name for the external listener.
|
List<ExternalListenerEndpoint> |
getEndpoints()
The list of protocol addresses the listener is configured to listen on.
|
String |
getExternalConnectorId()
The OCID of the
external connector.
|
String |
getExternalDbHomeId()
The OCID of the
external DB home.
|
String |
getExternalDbNodeId()
The OCID of the
external DB node.
|
String |
getExternalDbSystemId()
The OCID of the
external DB system that the listener is a part of.
|
Map<String,String> |
getFreeformTags()
Free-form tags for this resource.
|
String |
getHostName()
The name of the host on which the external listener is running.
|
String |
getId()
The OCID of the
external listener.
|
String |
getLifecycleDetails()
Additional information about the current lifecycle state.
|
ExternalListener.LifecycleState |
getLifecycleState()
The current lifecycle state of the external listener.
|
String |
getListenerAlias()
The listener alias.
|
String |
getListenerOraLocation()
The location of the listener configuration file listener.ora.
|
ExternalListener.ListenerType |
getListenerType()
The type of listener.
|
String |
getLogDirectory()
The destination directory of the listener log file.
|
String |
getOracleHome()
The Oracle home location of the listener.
|
List<ExternalServicedAsm> |
getServicedAsms()
The list of ASMs that are serviced by the listener.
|
List<ExternalListenerServicedDatabase> |
getServicedDatabases()
The list of databases that are serviced by the listener.
|
Map<String,Map<String,Object>> |
getSystemTags()
System tags for this resource.
|
Date |
getTimeCreated()
The date and time the external listener was created.
|
Date |
getTimeUpdated()
The date and time the external listener was last updated.
|
String |
getTraceDirectory()
The destination directory of the listener trace file.
|
String |
getVersion()
The listener version.
|
int |
hashCode() |
ExternalListener.Builder |
toBuilder() |
String |
toString() |
String |
toString(boolean includeByteArrayContents)
Return a string representation of the object.
|
markPropertyAsExplicitlySet, wasPropertyExplicitlySet@Deprecated @ConstructorProperties(value={"id","displayName","componentName","compartmentId","externalDbSystemId","externalConnectorId","externalDbNodeId","externalDbHomeId","listenerAlias","listenerType","additionalDetails","lifecycleState","lifecycleDetails","listenerOraLocation","oracleHome","hostName","adrHomeDirectory","logDirectory","traceDirectory","version","endpoints","servicedDatabases","servicedAsms","timeCreated","timeUpdated","freeformTags","definedTags","systemTags"}) public ExternalListener(String id, String displayName, String componentName, String compartmentId, String externalDbSystemId, String externalConnectorId, String externalDbNodeId, String externalDbHomeId, String listenerAlias, ExternalListener.ListenerType listenerType, Map<String,String> additionalDetails, ExternalListener.LifecycleState lifecycleState, String lifecycleDetails, String listenerOraLocation, String oracleHome, String hostName, String adrHomeDirectory, String logDirectory, String traceDirectory, String version, List<ExternalListenerEndpoint> endpoints, List<ExternalListenerServicedDatabase> servicedDatabases, List<ExternalServicedAsm> servicedAsms, Date timeCreated, Date timeUpdated, Map<String,String> freeformTags, Map<String,Map<String,Object>> definedTags, Map<String,Map<String,Object>> systemTags)
public static ExternalListener.Builder builder()
Create a new builder.
public ExternalListener.Builder toBuilder()
public String getDisplayName()
The user-friendly name for the external listener. The name does not have to be unique.
public String getComponentName()
The name of the external listener.
public String getExternalDbSystemId()
The OCID of the external DB system that the listener is a part of.
public String getExternalConnectorId()
The OCID of the external connector.
public String getExternalDbNodeId()
The OCID of the external DB node.
public String getExternalDbHomeId()
The OCID of the external DB home.
public String getListenerAlias()
The listener alias.
public ExternalListener.ListenerType getListenerType()
The type of listener.
public Map<String,String> getAdditionalDetails()
The additional details of the external listener defined in {"key": "value"} format.
Example: {"bar-key": "value"}
public ExternalListener.LifecycleState getLifecycleState()
The current lifecycle state of the external listener.
public String getLifecycleDetails()
Additional information about the current lifecycle state.
public String getListenerOraLocation()
The location of the listener configuration file listener.ora.
public String getOracleHome()
The Oracle home location of the listener.
public String getHostName()
The name of the host on which the external listener is running.
public String getAdrHomeDirectory()
The directory that stores tracing and logging incidents when Automatic Diagnostic Repository (ADR) is enabled.
public String getLogDirectory()
The destination directory of the listener log file.
public String getTraceDirectory()
The destination directory of the listener trace file.
public String getVersion()
The listener version.
public List<ExternalListenerEndpoint> getEndpoints()
The list of protocol addresses the listener is configured to listen on.
public List<ExternalListenerServicedDatabase> getServicedDatabases()
The list of databases that are serviced by the listener.
public List<ExternalServicedAsm> getServicedAsms()
The list of ASMs that are serviced by the listener.
public Date getTimeCreated()
The date and time the external listener was created.
public Date getTimeUpdated()
The date and time the external listener was last updated.
public Map<String,String> getFreeformTags()
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"}
public Map<String,Map<String,Object>> getDefinedTags()
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more
information, see Resource
Tags. Example:
{"Operations": {"CostCenter": "42"}}
public Map<String,Map<String,Object>> getSystemTags()
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"}}
public String toString()
toString in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModelpublic String toString(boolean includeByteArrayContents)
Return a string representation of the object.
includeByteArrayContents - true to include the full contents of byte arrayspublic boolean equals(Object o)
equals in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModelpublic int hashCode()
hashCode in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModelCopyright © 2016–2024. All rights reserved.