@Generated(value="OracleSDKGenerator",
comments="API Version: 20190415")
public final class DbSystem
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
A DB System is the core logical unit of MySQL Database Service.
Note: Objects should always be created or deserialized using the DbSystem.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 DbSystem.Builder, which maintain a
set of all explicitly set fields called DbSystem.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 |
DbSystem.Builder |
static class |
DbSystem.LifecycleState
The current state of the DB System.
|
EXPLICITLY_SET_FILTER_NAME, EXPLICITLY_SET_PROPERTY_NAME| Constructor and Description |
|---|
DbSystem(String id,
String displayName,
String description,
String compartmentId,
String subnetId,
Boolean isHighlyAvailable,
DbSystemPlacement currentPlacement,
Boolean isHeatWaveClusterAttached,
HeatWaveClusterSummary heatWaveCluster,
String availabilityDomain,
String faultDomain,
String shapeName,
String mysqlVersion,
BackupPolicy backupPolicy,
DbSystemSource source,
String configurationId,
Integer dataStorageSizeInGBs,
DataStorage dataStorage,
String hostnameLabel,
String ipAddress,
Integer port,
Integer portX,
List<DbSystemEndpoint> endpoints,
List<ChannelSummary> channels,
DbSystem.LifecycleState lifecycleState,
String lifecycleDetails,
MaintenanceDetails maintenance,
DeletionPolicyDetails deletionPolicy,
Date timeCreated,
Date timeUpdated,
Map<String,String> freeformTags,
Map<String,Map<String,Object>> definedTags,
CrashRecoveryStatus crashRecovery,
PointInTimeRecoveryDetails pointInTimeRecoveryDetails,
DatabaseManagementStatus databaseManagement,
SecureConnectionDetails secureConnections,
List<CustomerContact> customerContacts)
Deprecated.
|
| Modifier and Type | Method and Description |
|---|---|
static DbSystem.Builder |
builder()
Create a new builder.
|
boolean |
equals(Object o) |
String |
getAvailabilityDomain()
The availability domain on which to deploy the Read/Write endpoint.
|
BackupPolicy |
getBackupPolicy() |
List<ChannelSummary> |
getChannels()
A list with a summary of all the Channels attached to the DB System.
|
String |
getCompartmentId()
The OCID of the compartment the DB System belongs in.
|
String |
getConfigurationId()
The OCID of the Configuration to be used for Instances in this DB System.
|
CrashRecoveryStatus |
getCrashRecovery()
Whether to run the DB System with InnoDB Redo Logs and the Double Write Buffer enabled or
disabled, and whether to enable or disable syncing of the Binary Logs.
|
DbSystemPlacement |
getCurrentPlacement() |
List<CustomerContact> |
getCustomerContacts()
The list of customer email addresses that receive information from Oracle about the specified
OCI DB System resource.
|
DatabaseManagementStatus |
getDatabaseManagement()
Whether to enable monitoring via the Database Management service.
|
DataStorage |
getDataStorage() |
Integer |
getDataStorageSizeInGBs()
DEPRECATED: User specified size of the data volume.
|
Map<String,Map<String,Object>> |
getDefinedTags()
Defined tags for this resource.
|
DeletionPolicyDetails |
getDeletionPolicy() |
String |
getDescription()
User-provided data about the DB System.
|
String |
getDisplayName()
The user-friendly name for the DB System.
|
List<DbSystemEndpoint> |
getEndpoints()
The network endpoints available for this DB System.
|
String |
getFaultDomain()
The fault domain on which to deploy the Read/Write endpoint.
|
Map<String,String> |
getFreeformTags()
Simple key-value pair that is applied without any predefined name, type or scope.
|
HeatWaveClusterSummary |
getHeatWaveCluster() |
String |
getHostnameLabel()
The hostname for the primary endpoint of the DB System.
|
String |
getId()
The OCID of the DB System.
|
String |
getIpAddress()
The IP address the DB System is configured to listen on.
|
Boolean |
getIsHeatWaveClusterAttached()
If the DB System has a HeatWave Cluster attached.
|
Boolean |
getIsHighlyAvailable()
Specifies if the DB System is highly available.
|
String |
getLifecycleDetails()
Additional information about the current lifecycleState.
|
DbSystem.LifecycleState |
getLifecycleState()
The current state of the DB System.
|
MaintenanceDetails |
getMaintenance() |
String |
getMysqlVersion()
Name of the MySQL Version in use for the DB System.
|
PointInTimeRecoveryDetails |
getPointInTimeRecoveryDetails() |
Integer |
getPort()
The port for primary endpoint of the DB System to listen on.
|
Integer |
getPortX()
The network port on which X Plugin listens for TCP/IP connections.
|
SecureConnectionDetails |
getSecureConnections() |
String |
getShapeName()
The shape of the primary instances of the DB System.
|
DbSystemSource |
getSource() |
String |
getSubnetId()
The OCID of the subnet the DB System is associated with.
|
Date |
getTimeCreated()
The date and time the DB System was created.
|
Date |
getTimeUpdated()
The time the DB System was last updated.
|
int |
hashCode() |
DbSystem.Builder |
toBuilder() |
String |
toString() |
String |
toString(boolean includeByteArrayContents)
Return a string representation of the object.
|
markPropertyAsExplicitlySet, wasPropertyExplicitlySet@Deprecated @ConstructorProperties(value={"id","displayName","description","compartmentId","subnetId","isHighlyAvailable","currentPlacement","isHeatWaveClusterAttached","heatWaveCluster","availabilityDomain","faultDomain","shapeName","mysqlVersion","backupPolicy","source","configurationId","dataStorageSizeInGBs","dataStorage","hostnameLabel","ipAddress","port","portX","endpoints","channels","lifecycleState","lifecycleDetails","maintenance","deletionPolicy","timeCreated","timeUpdated","freeformTags","definedTags","crashRecovery","pointInTimeRecoveryDetails","databaseManagement","secureConnections","customerContacts"}) public DbSystem(String id, String displayName, String description, String compartmentId, String subnetId, Boolean isHighlyAvailable, DbSystemPlacement currentPlacement, Boolean isHeatWaveClusterAttached, HeatWaveClusterSummary heatWaveCluster, String availabilityDomain, String faultDomain, String shapeName, String mysqlVersion, BackupPolicy backupPolicy, DbSystemSource source, String configurationId, Integer dataStorageSizeInGBs, DataStorage dataStorage, String hostnameLabel, String ipAddress, Integer port, Integer portX, List<DbSystemEndpoint> endpoints, List<ChannelSummary> channels, DbSystem.LifecycleState lifecycleState, String lifecycleDetails, MaintenanceDetails maintenance, DeletionPolicyDetails deletionPolicy, Date timeCreated, Date timeUpdated, Map<String,String> freeformTags, Map<String,Map<String,Object>> definedTags, CrashRecoveryStatus crashRecovery, PointInTimeRecoveryDetails pointInTimeRecoveryDetails, DatabaseManagementStatus databaseManagement, SecureConnectionDetails secureConnections, List<CustomerContact> customerContacts)
public static DbSystem.Builder builder()
Create a new builder.
public DbSystem.Builder toBuilder()
public String getId()
The OCID of the DB System.
public String getDisplayName()
The user-friendly name for the DB System. It does not have to be unique.
public String getDescription()
User-provided data about the DB System.
public String getCompartmentId()
The OCID of the compartment the DB System belongs in.
public String getSubnetId()
The OCID of the subnet the DB System is associated with.
public Boolean getIsHighlyAvailable()
Specifies if the DB System is highly available.
public DbSystemPlacement getCurrentPlacement()
public Boolean getIsHeatWaveClusterAttached()
If the DB System has a HeatWave Cluster attached.
public HeatWaveClusterSummary getHeatWaveCluster()
public String getAvailabilityDomain()
The availability domain on which to deploy the Read/Write endpoint. This defines the preferred primary instance.
In a failover scenario, the Read/Write endpoint is redirected to one of the other availability domains and the MySQL instance in that domain is promoted to the primary instance. This redirection does not affect the IP address of the DB System in any way.
For a standalone DB System, this defines the availability domain in which the DB System is placed.
public String getFaultDomain()
The fault domain on which to deploy the Read/Write endpoint. This defines the preferred primary instance.
In a failover scenario, the Read/Write endpoint is redirected to one of the other fault domains and the MySQL instance in that domain is promoted to the primary instance. This redirection does not affect the IP address of the DB System in any way.
For a standalone DB System, this defines the fault domain in which the DB System is placed.
public String getShapeName()
The shape of the primary instances of the DB System. The shape determines resources allocated
to a DB System - CPU cores and memory for VM shapes; CPU cores, memory and storage for non-VM
(or bare metal) shapes. To get a list of shapes, use (the listShapes operation.
public String getMysqlVersion()
Name of the MySQL Version in use for the DB System.
public BackupPolicy getBackupPolicy()
public DbSystemSource getSource()
public String getConfigurationId()
The OCID of the Configuration to be used for Instances in this DB System.
public Integer getDataStorageSizeInGBs()
DEPRECATED: User specified size of the data volume. May be less than current allocatedStorageSizeInGBs. Replaced by dataStorage.dataStorageSizeInGBs.
public DataStorage getDataStorage()
public String getHostnameLabel()
The hostname for the primary endpoint of the DB System. Used for DNS. The value is the hostname portion of the primary private IP’s fully qualified domain name (FQDN) (for example, “dbsystem-1” in FQDN “dbsystem-1.subnet123.vcn1.oraclevcn.com”). Must be unique across all VNICs in the subnet and comply with RFC 952 and RFC 1123.
public String getIpAddress()
The IP address the DB System is configured to listen on. A private IP address of the primary endpoint of the DB System. Must be an available IP address within the subnet’s CIDR. This will be a “dotted-quad” style IPv4 address.
public Integer getPort()
The port for primary endpoint of the DB System to listen on.
public Integer getPortX()
The network port on which X Plugin listens for TCP/IP connections. This is the X Plugin equivalent of port.
public List<DbSystemEndpoint> getEndpoints()
The network endpoints available for this DB System.
public List<ChannelSummary> getChannels()
A list with a summary of all the Channels attached to the DB System.
public DbSystem.LifecycleState getLifecycleState()
The current state of the DB System.
public String getLifecycleDetails()
Additional information about the current lifecycleState.
public MaintenanceDetails getMaintenance()
public DeletionPolicyDetails getDeletionPolicy()
public Date getTimeCreated()
The date and time the DB System was created.
public Date getTimeUpdated()
The time the DB System was last updated.
public Map<String,String> getFreeformTags()
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()
Defined tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace": {"bar-key": "value"}}
public CrashRecoveryStatus getCrashRecovery()
Whether to run the DB System with InnoDB Redo Logs and the Double Write Buffer enabled or disabled, and whether to enable or disable syncing of the Binary Logs.
public PointInTimeRecoveryDetails getPointInTimeRecoveryDetails()
public DatabaseManagementStatus getDatabaseManagement()
Whether to enable monitoring via the Database Management service.
public SecureConnectionDetails getSecureConnections()
public List<CustomerContact> getCustomerContacts()
The list of customer email addresses that receive information from Oracle about the specified OCI DB System resource. Oracle uses these email addresses to send notifications about planned and unplanned software maintenance updates, information about system hardware, and other information needed by administrators. Up to 10 email addresses can be added to the customer contacts for a DB System.
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.