@Generated(value="OracleSDKGenerator", comments="API Version: 20200407") public final class DatabaseRegistration extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
Represents the metadata description of a database used by deployments in the same compartment.
Note: Objects should always be created or deserialized using the DatabaseRegistration.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 DatabaseRegistration.Builder
, which maintain a
set of all explicitly set fields called ExplicitlySetBmcModel.__explicitlySet__
. The hashCode()
and
equals(Object)
methods are implemented to take ExplicitlySetBmcModel.__explicitlySet__
into account.
The constructor, on the other hand, does not set ExplicitlySetBmcModel.__explicitlySet__
(since the
constructor cannot distinguish explicit null
from unset null
).
Modifier and Type | Class and Description |
---|---|
static class |
DatabaseRegistration.Builder |
static class |
DatabaseRegistration.SessionMode
The mode of the database connection session to be established by the data client.
|
Constructor and Description |
---|
DatabaseRegistration(String id,
String displayName,
String description,
String compartmentId,
Date timeCreated,
Date timeUpdated,
LifecycleState lifecycleState,
String lifecycleDetails,
Map<String,String> freeformTags,
Map<String,Map<String,Object>> definedTags,
String fqdn,
String ipAddress,
String subnetId,
String databaseId,
String rcePrivateIp,
Map<String,Map<String,Object>> systemTags,
String username,
String connectionString,
DatabaseRegistration.SessionMode sessionMode,
String aliasName,
String vaultId,
String keyId,
String secretCompartmentId,
String secretId)
Deprecated.
|
Modifier and Type | Method and Description |
---|---|
static DatabaseRegistration.Builder |
builder()
Create a new builder.
|
boolean |
equals(Object o) |
String |
getAliasName()
Credential store alias.
|
String |
getCompartmentId()
The OCID of the
compartment being referenced.
|
String |
getConnectionString()
Connect descriptor or Easy Connect Naming method that Oracle GoldenGate uses to connect to a
database.
|
String |
getDatabaseId()
The OCID of the
database being referenced.
|
Map<String,Map<String,Object>> |
getDefinedTags()
Tags defined for this resource.
|
String |
getDescription()
Metadata about this specific object.
|
String |
getDisplayName()
An object’s Display Name.
|
String |
getFqdn()
A three-label Fully Qualified Domain Name (FQDN) for a resource.
|
Map<String,String> |
getFreeformTags()
A simple key-value pair that is applied without any predefined name, type, or scope.
|
String |
getId()
The OCID of the
databaseRegistration being referenced.
|
String |
getIpAddress()
The private IP address in the customer’s VCN of the customer’s endpoint, typically a
database.
|
String |
getKeyId()
The OCID of the
customer “Master” key being referenced.
|
String |
getLifecycleDetails()
Describes the object’s current state in detail.
|
LifecycleState |
getLifecycleState()
Possible lifecycle states.
|
String |
getRcePrivateIp()
A Private Endpoint IP Address created in the customer’s subnet.
|
String |
getSecretCompartmentId()
The OCID of the
compartment where the the GGS Secret will be created.
|
String |
getSecretId()
The OCID of the
customer GGS Secret being referenced.
|
DatabaseRegistration.SessionMode |
getSessionMode()
The mode of the database connection session to be established by the data client.
|
String |
getSubnetId()
The OCID of the
subnet being referenced.
|
Map<String,Map<String,Object>> |
getSystemTags()
The system tags associated with this resource, if any.
|
Date |
getTimeCreated()
The time the resource was created.
|
Date |
getTimeUpdated()
The time the resource was last updated.
|
String |
getUsername()
The username Oracle GoldenGate uses to connect the associated RDBMS.
|
String |
getVaultId()
The OCID of the
customer vault being referenced.
|
int |
hashCode() |
DatabaseRegistration.Builder |
toBuilder() |
String |
toString() |
String |
toString(boolean includeByteArrayContents)
Return a string representation of the object.
|
markPropertyAsExplicitlySet, wasPropertyExplicitlySet
@Deprecated @ConstructorProperties(value={"id","displayName","description","compartmentId","timeCreated","timeUpdated","lifecycleState","lifecycleDetails","freeformTags","definedTags","fqdn","ipAddress","subnetId","databaseId","rcePrivateIp","systemTags","username","connectionString","sessionMode","aliasName","vaultId","keyId","secretCompartmentId","secretId"}) public DatabaseRegistration(String id, String displayName, String description, String compartmentId, Date timeCreated, Date timeUpdated, LifecycleState lifecycleState, String lifecycleDetails, Map<String,String> freeformTags, Map<String,Map<String,Object>> definedTags, String fqdn, String ipAddress, String subnetId, String databaseId, String rcePrivateIp, Map<String,Map<String,Object>> systemTags, String username, String connectionString, DatabaseRegistration.SessionMode sessionMode, String aliasName, String vaultId, String keyId, String secretCompartmentId, String secretId)
public static DatabaseRegistration.Builder builder()
Create a new builder.
public DatabaseRegistration.Builder toBuilder()
public String getId()
The OCID of the databaseRegistration being referenced.
public String getDisplayName()
An object’s Display Name.
public String getDescription()
Metadata about this specific object.
public String getCompartmentId()
The OCID of the compartment being referenced.
public Date getTimeCreated()
The time the resource was created. The format is defined by
RFC3339, such as 2016-08-25T21:10:29.600Z
.
public Date getTimeUpdated()
The time the resource was last updated. The format is defined by
RFC3339, such as 2016-08-25T21:10:29.600Z
.
public LifecycleState getLifecycleState()
Possible lifecycle states.
public String getLifecycleDetails()
Describes the object’s current state in detail. For example, it can be used to provide actionable information for a resource in a Failed state.
public Map<String,String> getFreeformTags()
A simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only.
Example: {"bar-key": "value"}
public Map<String,Map<String,Object>> getDefinedTags()
Tags defined for this resource. Each key is predefined and scoped to a namespace.
Example: {"foo-namespace": {"bar-key": "value"}}
public String getFqdn()
A three-label Fully Qualified Domain Name (FQDN) for a resource.
public String getIpAddress()
The private IP address in the customer’s VCN of the customer’s endpoint, typically a database.
public String getDatabaseId()
The OCID of the database being referenced.
public String getRcePrivateIp()
A Private Endpoint IP Address created in the customer’s subnet. A customer database can expect network traffic initiated by GGS from this IP address and send network traffic to this IP address, typically in response to requests from GGS (OGG). The customer may utilize this IP address in Security Lists or Network Security Groups (NSG) as needed.
public Map<String,Map<String,Object>> getSystemTags()
The system tags associated with this resource, if any. The system tags are set by Oracle Cloud Infrastructure services. Each key is predefined and scoped to namespaces. For more information, see Resource Tags.
Example: {orcl-cloud: {free-tier-retain: true}}
public String getUsername()
The username Oracle GoldenGate uses to connect the associated RDBMS. This username must already exist and be available for use by the database. It must conform to the security requirements implemented by the database including length, case sensitivity, and so on.
public String getConnectionString()
Connect descriptor or Easy Connect Naming method that Oracle GoldenGate uses to connect to a database.
public DatabaseRegistration.SessionMode getSessionMode()
The mode of the database connection session to be established by the data client. ‘REDIRECT’
public String getAliasName()
Credential store alias.
public String getVaultId()
The OCID of the customer vault being referenced. If provided, this will reference a vault which the customer will be required to ensure the policies are established to permit the GoldenGate Service to manage secrets contained within this vault.
public String getKeyId()
The OCID of the customer “Master” key being referenced. If provided, this will reference a key which the customer will be required to ensure the policies are established to permit the GoldenGate Service to utilize this key to manage secrets.
public String getSecretCompartmentId()
The OCID of the compartment where the the GGS Secret will be created. If provided, this will reference a key which the customer will be required to ensure the policies are established to permit the GoldenGate Service to utilize this Compartment in which to create a Secret.
public String getSecretId()
The OCID of the customer GGS Secret being referenced. If provided, this will reference a key which the customer will be required to ensure the policies are established to permit the GoldenGate Service to utilize this Secret
public String toString()
toString
in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
public 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.ExplicitlySetBmcModel
public int hashCode()
hashCode
in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
Copyright © 2016–2023. All rights reserved.