Class DatabaseRegistration
- java.lang.Object
-
- com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
-
- com.oracle.bmc.goldengate.model.DatabaseRegistration
-
@Generated(value="OracleSDKGenerator", comments="API Version: 20200407") public final class DatabaseRegistration extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModelRepresents the metadata description of a database used by deployments in the same compartment.
Note: Objects should always be created or deserialized using theDatabaseRegistration.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 theDatabaseRegistration.Builder, which maintain a set of all explicitly set fields calledDatabaseRegistration.Builder.__explicitlySet__. ThehashCode()andequals(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).
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classDatabaseRegistration.Builderstatic classDatabaseRegistration.SessionModeThe mode of the database connection session to be established by the data client.
-
Constructor Summary
Constructors Constructor 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.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static DatabaseRegistration.Builderbuilder()Create a new builder.booleanequals(Object o)StringgetAliasName()Credential store alias.StringgetCompartmentId()The OCID of the compartment being referenced.StringgetConnectionString()Connect descriptor or Easy Connect Naming method used to connect to a database.StringgetDatabaseId()The OCID of the database being referenced.Map<String,Map<String,Object>>getDefinedTags()Tags defined for this resource.StringgetDescription()Metadata about this specific object.StringgetDisplayName()An object’s Display Name.StringgetFqdn()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.StringgetId()The OCID of the databaseRegistration being referenced.StringgetIpAddress()The private IP address in the customer’s VCN of the customer’s endpoint, typically a database.StringgetKeyId()Refers to the customer’s master key OCID.StringgetLifecycleDetails()Describes the object’s current state in detail.LifecycleStategetLifecycleState()Possible lifecycle states.StringgetRcePrivateIp()A Private Endpoint IP address created in the customer’s subnet.StringgetSecretCompartmentId()The OCID of the compartment where the GoldenGate Secret will be created.StringgetSecretId()The OCID of the customer’s GoldenGate Service Secret.DatabaseRegistration.SessionModegetSessionMode()The mode of the database connection session to be established by the data client.StringgetSubnetId()The OCID of the target subnet of the dedicated connection.Map<String,Map<String,Object>>getSystemTags()The system tags associated with this resource, if any.DategetTimeCreated()The time the resource was created.DategetTimeUpdated()The time the resource was last updated.StringgetUsername()The username Oracle GoldenGate uses to connect the associated system of the given technology.StringgetVaultId()Refers to the customer’s vault OCID.inthashCode()DatabaseRegistration.BuildertoBuilder()StringtoString()StringtoString(boolean includeByteArrayContents)Return a string representation of the object.
-
-
-
Constructor Detail
-
DatabaseRegistration
@Deprecated @ConstructorProperties({"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)
Deprecated.
-
-
Method Detail
-
builder
public static DatabaseRegistration.Builder builder()
Create a new builder.
-
toBuilder
public DatabaseRegistration.Builder toBuilder()
-
getId
public String getId()
The OCID of the databaseRegistration being referenced.- Returns:
- the value
-
getDisplayName
public String getDisplayName()
An object’s Display Name.- Returns:
- the value
-
getDescription
public String getDescription()
Metadata about this specific object.- Returns:
- the value
-
getCompartmentId
public String getCompartmentId()
The OCID of the compartment being referenced.- Returns:
- the value
-
getTimeCreated
public Date getTimeCreated()
The time the resource was created.The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.
- Returns:
- the value
-
getTimeUpdated
public Date getTimeUpdated()
The time the resource was last updated.The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.
- Returns:
- the value
-
getLifecycleState
public LifecycleState getLifecycleState()
Possible lifecycle states.- Returns:
- the value
-
getLifecycleDetails
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.
- Returns:
- the value
-
getFreeformTags
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"}
- Returns:
- the value
-
getDefinedTags
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"}}
- Returns:
- the value
-
getFqdn
public String getFqdn()
A three-label Fully Qualified Domain Name (FQDN) for a resource.- Returns:
- the value
-
getIpAddress
public String getIpAddress()
The private IP address in the customer’s VCN of the customer’s endpoint, typically a database.- Returns:
- the value
-
getSubnetId
public String getSubnetId()
The OCID of the target subnet of the dedicated connection.- Returns:
- the value
-
getDatabaseId
public String getDatabaseId()
The OCID of the database being referenced.- Returns:
- the value
-
getRcePrivateIp
public String getRcePrivateIp()
A Private Endpoint IP address created in the customer’s subnet.A customer database can expect network traffic initiated by GoldenGate Service from this IP address. It can also send network traffic to this IP address, typically in response to requests from GoldenGate Service. The customer may use this IP address in Security Lists or Network Security Groups (NSG) as needed.
- Returns:
- the value
-
getSystemTags
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}}
- Returns:
- the value
-
getUsername
public String getUsername()
The username Oracle GoldenGate uses to connect the associated system of the given technology.This username must already exist and be available by the system/application to be connected to and must conform to the case sensitivty requirments defined in it.
- Returns:
- the value
-
getConnectionString
public String getConnectionString()
Connect descriptor or Easy Connect Naming method used to connect to a database.- Returns:
- the value
-
getSessionMode
public DatabaseRegistration.SessionMode getSessionMode()
The mode of the database connection session to be established by the data client.‘REDIRECT’
- for a RAC database, ‘DIRECT’ - for a non-RAC database. Connection to a RAC database involves a redirection received from the SCAN listeners to the database node to connect to. By default the mode would be DIRECT.
- Returns:
- the value
-
getAliasName
public String getAliasName()
Credential store alias.- Returns:
- the value
-
getVaultId
public String getVaultId()
Refers to the customer’s vault OCID.If provided, it references a vault where GoldenGate can manage secrets. Customers must add policies to permit GoldenGate to manage secrets contained within this vault.
- Returns:
- the value
-
getKeyId
public String getKeyId()
Refers to the customer’s master key OCID.If provided, it references a key to manage secrets. Customers must add policies to permit GoldenGate to use this key.
- Returns:
- the value
-
getSecretCompartmentId
public String getSecretCompartmentId()
The OCID of the compartment where the GoldenGate Secret will be created.If provided, it references a key to manage secrets. Customers must add policies to permit GoldenGate to use this key.
- Returns:
- the value
-
getSecretId
public String getSecretId()
The OCID of the customer’s GoldenGate Service Secret.If provided, it references a key that customers will be required to ensure the policies are established to permit GoldenGate to use this Secret.
- Returns:
- the value
-
toString
public String toString()
- Overrides:
toStringin classcom.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
-
toString
public String toString(boolean includeByteArrayContents)
Return a string representation of the object.- Parameters:
includeByteArrayContents- true to include the full contents of byte arrays- Returns:
- string representation
-
equals
public boolean equals(Object o)
- Overrides:
equalsin classcom.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
-
hashCode
public int hashCode()
- Overrides:
hashCodein classcom.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
-
-