Class DbSystemSummary
- java.lang.Object
-
- com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
-
- com.oracle.bmc.mysql.model.DbSystemSummary
-
@Generated(value="OracleSDKGenerator", comments="API Version: 20190415") public final class DbSystemSummary extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
A summary of a DB System.
Note: Objects should always be created or deserialized using theDbSystemSummary.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 theDbSystemSummary.Builder
, which maintain a set of all explicitly set fields calledDbSystemSummary.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 class
DbSystemSummary.Builder
-
Constructor Summary
Constructors Constructor Description DbSystemSummary(String id, String displayName, String description, String compartmentId, Boolean isHighlyAvailable, DbSystemPlacement currentPlacement, Boolean isHeatWaveClusterAttached, HeatWaveClusterSummary heatWaveCluster, String availabilityDomain, String faultDomain, List<DbSystemEndpoint> endpoints, DbSystem.LifecycleState lifecycleState, String mysqlVersion, Date timeCreated, Date timeUpdated, DeletionPolicyDetails deletionPolicy, Map<String,String> freeformTags, Map<String,Map<String,Object>> definedTags, Map<String,Map<String,Object>> systemTags, BackupPolicy backupPolicy, String shapeName, CrashRecoveryStatus crashRecovery, DatabaseManagementStatus databaseManagement, DbSystem.DatabaseMode databaseMode, DbSystem.AccessMode accessMode, ReadEndpointDetails readEndpoint)
Deprecated.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static DbSystemSummary.Builder
builder()
Create a new builder.boolean
equals(Object o)
DbSystem.AccessMode
getAccessMode()
The access mode indicating if the database access is unrestricted (to all MySQL user accounts), or restricted (to only certain users with specific privileges): - UNRESTRICTED: the access to the database is not restricted; - RESTRICTED: the access is allowed only to users with specific privileges; RESTRICTED will correspond to setting the MySQL system variable offline_mode to ON.String
getAvailabilityDomain()
The availability domain on which to deploy the Read/Write endpoint.BackupPolicy
getBackupPolicy()
String
getCompartmentId()
The OCID of the compartment the DB System belongs in.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()
DatabaseManagementStatus
getDatabaseManagement()
Whether to enable monitoring via the Database Management service.DbSystem.DatabaseMode
getDatabaseMode()
The database mode indicating the types of statements that are allowed to run in the DB system.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
getId()
The OCID of the DB System.Boolean
getIsHeatWaveClusterAttached()
If the DB System has a HeatWave Cluster attached.Boolean
getIsHighlyAvailable()
Specifies if the DB System is highly available.DbSystem.LifecycleState
getLifecycleState()
The current state of the DB System.String
getMysqlVersion()
Name of the MySQL Version in use for the DB System.ReadEndpointDetails
getReadEndpoint()
String
getShapeName()
The shape of the primary instances of the DB System.Map<String,Map<String,Object>>
getSystemTags()
Usage of system tag keys.Date
getTimeCreated()
The date and time the DB System was created.Date
getTimeUpdated()
The time the DB System was last updated.int
hashCode()
DbSystemSummary.Builder
toBuilder()
String
toString()
String
toString(boolean includeByteArrayContents)
Return a string representation of the object.
-
-
-
Constructor Detail
-
DbSystemSummary
@Deprecated @ConstructorProperties({"id","displayName","description","compartmentId","isHighlyAvailable","currentPlacement","isHeatWaveClusterAttached","heatWaveCluster","availabilityDomain","faultDomain","endpoints","lifecycleState","mysqlVersion","timeCreated","timeUpdated","deletionPolicy","freeformTags","definedTags","systemTags","backupPolicy","shapeName","crashRecovery","databaseManagement","databaseMode","accessMode","readEndpoint"}) public DbSystemSummary(String id, String displayName, String description, String compartmentId, Boolean isHighlyAvailable, DbSystemPlacement currentPlacement, Boolean isHeatWaveClusterAttached, HeatWaveClusterSummary heatWaveCluster, String availabilityDomain, String faultDomain, List<DbSystemEndpoint> endpoints, DbSystem.LifecycleState lifecycleState, String mysqlVersion, Date timeCreated, Date timeUpdated, DeletionPolicyDetails deletionPolicy, Map<String,String> freeformTags, Map<String,Map<String,Object>> definedTags, Map<String,Map<String,Object>> systemTags, BackupPolicy backupPolicy, String shapeName, CrashRecoveryStatus crashRecovery, DatabaseManagementStatus databaseManagement, DbSystem.DatabaseMode databaseMode, DbSystem.AccessMode accessMode, ReadEndpointDetails readEndpoint)
Deprecated.
-
-
Method Detail
-
builder
public static DbSystemSummary.Builder builder()
Create a new builder.
-
toBuilder
public DbSystemSummary.Builder toBuilder()
-
getId
public String getId()
The OCID of the DB System.- Returns:
- the value
-
getDisplayName
public String getDisplayName()
The user-friendly name for the DB System.It does not have to be unique.
- Returns:
- the value
-
getDescription
public String getDescription()
User-provided data about the DB System.- Returns:
- the value
-
getCompartmentId
public String getCompartmentId()
The OCID of the compartment the DB System belongs in.- Returns:
- the value
-
getIsHighlyAvailable
public Boolean getIsHighlyAvailable()
Specifies if the DB System is highly available.- Returns:
- the value
-
getCurrentPlacement
public DbSystemPlacement getCurrentPlacement()
-
getIsHeatWaveClusterAttached
public Boolean getIsHeatWaveClusterAttached()
If the DB System has a HeatWave Cluster attached.- Returns:
- the value
-
getHeatWaveCluster
public HeatWaveClusterSummary getHeatWaveCluster()
-
getAvailabilityDomain
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.
- Returns:
- the value
-
getFaultDomain
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.
- Returns:
- the value
-
getEndpoints
public List<DbSystemEndpoint> getEndpoints()
The network endpoints available for this DB System.- Returns:
- the value
-
getLifecycleState
public DbSystem.LifecycleState getLifecycleState()
The current state of the DB System.- Returns:
- the value
-
getMysqlVersion
public String getMysqlVersion()
Name of the MySQL Version in use for the DB System.- Returns:
- the value
-
getTimeCreated
public Date getTimeCreated()
The date and time the DB System was created.- Returns:
- the value
-
getTimeUpdated
public Date getTimeUpdated()
The time the DB System was last updated.- Returns:
- the value
-
getDeletionPolicy
public DeletionPolicyDetails getDeletionPolicy()
-
getFreeformTags
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”}
- Returns:
- the value
-
getDefinedTags
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”}}
- Returns:
- the value
-
getSystemTags
public Map<String,Map<String,Object>> getSystemTags()
Usage of system tag keys.These predefined keys are scoped to namespaces. Example: {“orcl-cloud”: {“free-tier-retained”: “true”}}
- Returns:
- the value
-
getBackupPolicy
public BackupPolicy getBackupPolicy()
-
getShapeName
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.- Returns:
- the value
-
getCrashRecovery
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.- Returns:
- the value
-
getDatabaseManagement
public DatabaseManagementStatus getDatabaseManagement()
Whether to enable monitoring via the Database Management service.- Returns:
- the value
-
getDatabaseMode
public DbSystem.DatabaseMode getDatabaseMode()
The database mode indicating the types of statements that are allowed to run in the DB system.This mode applies only to statements run by user connections. Replicated write statements continue to be allowed regardless of the DatabaseMode. - READ_WRITE: allow running read and write statements on the DB system; - READ_ONLY: only allow running read statements on the DB system.
- Returns:
- the value
-
getAccessMode
public DbSystem.AccessMode getAccessMode()
The access mode indicating if the database access is unrestricted (to all MySQL user accounts), or restricted (to only certain users with specific privileges): - UNRESTRICTED: the access to the database is not restricted; - RESTRICTED: the access is allowed only to users with specific privileges; RESTRICTED will correspond to setting the MySQL system variable offline_mode to ON.- Returns:
- the value
-
getReadEndpoint
public ReadEndpointDetails getReadEndpoint()
-
toString
public String toString()
- Overrides:
toString
in 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:
equals
in classcom.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classcom.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
-
-