Class UpdateDbSystemDetails
- java.lang.Object
-
- com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
-
- com.oracle.bmc.mysql.model.UpdateDbSystemDetails
-
@Generated(value="OracleSDKGenerator", comments="API Version: 20190415") public final class UpdateDbSystemDetails extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
Details required to update a DB System.
Note: Objects should always be created or deserialized using theUpdateDbSystemDetails.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 theUpdateDbSystemDetails.Builder
, which maintain a set of all explicitly set fields calledUpdateDbSystemDetails.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
UpdateDbSystemDetails.Builder
-
Constructor Summary
Constructors Constructor Description UpdateDbSystemDetails(String displayName, String description, String subnetId, DbSystem.DatabaseMode databaseMode, DbSystem.AccessMode accessMode, Boolean isHighlyAvailable, String availabilityDomain, String faultDomain, String shapeName, String mysqlVersion, String configurationId, String adminUsername, String adminPassword, Integer dataStorageSizeInGBs, DataStorageDetails dataStorage, String hostnameLabel, String ipAddress, Integer port, Integer portX, UpdateBackupPolicyDetails backupPolicy, UpdateMaintenanceDetails maintenance, Map<String,String> freeformTags, Map<String,Map<String,Object>> definedTags, UpdateDeletionPolicyDetails deletionPolicy, CrashRecoveryStatus crashRecovery, DatabaseManagementStatus databaseManagement, SecureConnectionDetails secureConnections, List<CustomerContact> customerContacts, UpdateReadEndpointDetails readEndpoint)
Deprecated.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static UpdateDbSystemDetails.Builder
builder()
Create a new builder.boolean
equals(Object o)
DbSystem.AccessMode
getAccessMode()
The access mode indicating if the database access will be restricted only to administrators or not: - UNRESTRICTED: the access to the database is not restricted; - RESTRICTED: the access will be allowed only to users with specific privileges; RESTRICTED will correspond to setting the MySQL system variable offline_mode to ON.String
getAdminPassword()
The password for the administrative user.String
getAdminUsername()
The username for the administrative user for the MySQL Instance.String
getAvailabilityDomain()
The availability domain on which to deploy the Read/Write endpoint.UpdateBackupPolicyDetails
getBackupPolicy()
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.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.DbSystem.DatabaseMode
getDatabaseMode()
The database mode indicating the types of statements that will be allowed to run in the DB system.DataStorageDetails
getDataStorage()
Integer
getDataStorageSizeInGBs()
Expands the DB System’s storage to the specified value.Map<String,Map<String,Object>>
getDefinedTags()
Usage of predefined tag keys.UpdateDeletionPolicyDetails
getDeletionPolicy()
String
getDescription()
User-provided data about the DB System.String
getDisplayName()
The user-friendly name for the DB System.String
getFaultDomain()
The fault domain on which to deploy the Read/Write endpoint.Map<String,String>
getFreeformTags()
Simple key-value pair applied without any predefined name, type or scope.String
getHostnameLabel()
The hostname for the primary endpoint of the DB System.String
getIpAddress()
The IP address the DB System should be configured to listen on the provided subnet.Boolean
getIsHighlyAvailable()
Specifies if the DB System is highly available.UpdateMaintenanceDetails
getMaintenance()
String
getMysqlVersion()
The specific MySQL version identifier.Integer
getPort()
The port for primary endpoint of the DB System to listen on.Integer
getPortX()
The TCP network port on which X Plugin listens for connections.UpdateReadEndpointDetails
getReadEndpoint()
SecureConnectionDetails
getSecureConnections()
String
getShapeName()
The shape of the DB System.String
getSubnetId()
The OCID of the subnet the DB System is associated with.int
hashCode()
UpdateDbSystemDetails.Builder
toBuilder()
String
toString()
String
toString(boolean includeByteArrayContents)
Return a string representation of the object.
-
-
-
Constructor Detail
-
UpdateDbSystemDetails
@Deprecated @ConstructorProperties({"displayName","description","subnetId","databaseMode","accessMode","isHighlyAvailable","availabilityDomain","faultDomain","shapeName","mysqlVersion","configurationId","adminUsername","adminPassword","dataStorageSizeInGBs","dataStorage","hostnameLabel","ipAddress","port","portX","backupPolicy","maintenance","freeformTags","definedTags","deletionPolicy","crashRecovery","databaseManagement","secureConnections","customerContacts","readEndpoint"}) public UpdateDbSystemDetails(String displayName, String description, String subnetId, DbSystem.DatabaseMode databaseMode, DbSystem.AccessMode accessMode, Boolean isHighlyAvailable, String availabilityDomain, String faultDomain, String shapeName, String mysqlVersion, String configurationId, String adminUsername, String adminPassword, Integer dataStorageSizeInGBs, DataStorageDetails dataStorage, String hostnameLabel, String ipAddress, Integer port, Integer portX, UpdateBackupPolicyDetails backupPolicy, UpdateMaintenanceDetails maintenance, Map<String,String> freeformTags, Map<String,Map<String,Object>> definedTags, UpdateDeletionPolicyDetails deletionPolicy, CrashRecoveryStatus crashRecovery, DatabaseManagementStatus databaseManagement, SecureConnectionDetails secureConnections, List<CustomerContact> customerContacts, UpdateReadEndpointDetails readEndpoint)
Deprecated.
-
-
Method Detail
-
builder
public static UpdateDbSystemDetails.Builder builder()
Create a new builder.
-
toBuilder
public UpdateDbSystemDetails.Builder toBuilder()
-
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
-
getSubnetId
public String getSubnetId()
The OCID of the subnet the DB System is associated with.- Returns:
- the value
-
getDatabaseMode
public DbSystem.DatabaseMode getDatabaseMode()
The database mode indicating the types of statements that will be allowed to run in the DB system.This mode will apply only to statements run by user connections. Replicated write statements will 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 will be restricted only to administrators or not: - UNRESTRICTED: the access to the database is not restricted; - RESTRICTED: the access will be allowed only to users with specific privileges; RESTRICTED will correspond to setting the MySQL system variable offline_mode to ON.- Returns:
- the value
-
getIsHighlyAvailable
public Boolean getIsHighlyAvailable()
Specifies if the DB System is highly available.Set to true to enable high availability. Two secondary MySQL instances are created and placed in the unused availability or fault domains, depending on your region and subnet type. Set to false to disable high availability. The secondary MySQL instances are removed and the MySQL instance in the preferred location is used.
- Returns:
- the value
-
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
-
getShapeName
public String getShapeName()
The shape of the DB System.The shape determines resources allocated to the 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.Changes in Shape will result in a downtime as the MySQL DB System is migrated to the new Compute instance.
- Returns:
- the value
-
getMysqlVersion
public String getMysqlVersion()
The specific MySQL version identifier.- Returns:
- the value
-
getConfigurationId
public String getConfigurationId()
The OCID of the Configuration to be used for Instances in this DB System.- Returns:
- the value
-
getAdminUsername
public String getAdminUsername()
The username for the administrative user for the MySQL Instance.- Returns:
- the value
-
getAdminPassword
public String getAdminPassword()
The password for the administrative user.The password must be between 8 and 32 characters long, and must contain at least 1 numeric character, 1 lowercase character, 1 uppercase character, and 1 special (nonalphanumeric) character.
- Returns:
- the value
-
getDataStorageSizeInGBs
public Integer getDataStorageSizeInGBs()
Expands the DB System’s storage to the specified value.Only supports values larger than the current DB System’s storage size.
DB Systems with an initial storage size of 400 GB or less can be expanded up to 32 TB. DB Systems with an initial storage size between 401-800 GB can be expanded up to 64 TB. DB Systems with an initial storage size between 801-1200 GB can be expanded up to 96 TB. DB Systems with an initial storage size of 1201 GB or more can be expanded up to 128 TB.
It is not possible to decrease data storage size.
- Returns:
- the value
-
getDataStorage
public DataStorageDetails getDataStorage()
-
getHostnameLabel
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.
- Returns:
- the value
-
getIpAddress
public String getIpAddress()
The IP address the DB System should be configured to listen on the provided subnet.It must be a free private IP address within the subnet’s CIDR. If you don’t specify a value, Oracle automatically assigns a private IP address from the subnet. This should be a “dotted-quad” style IPv4 address.
- Returns:
- the value
-
getPort
public Integer getPort()
The port for primary endpoint of the DB System to listen on.- Returns:
- the value
-
getPortX
public Integer getPortX()
The TCP network port on which X Plugin listens for connections.This is the X Plugin equivalent of port.
- Returns:
- the value
-
getBackupPolicy
public UpdateBackupPolicyDetails getBackupPolicy()
-
getMaintenance
public UpdateMaintenanceDetails getMaintenance()
-
getFreeformTags
public Map<String,String> getFreeformTags()
Simple key-value pair 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()
Usage of predefined tag keys.These predefined keys are scoped to namespaces. Example: {“foo-namespace”: {“bar-key”: “value”}}
- Returns:
- the value
-
getDeletionPolicy
public UpdateDeletionPolicyDetails getDeletionPolicy()
-
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
-
getSecureConnections
public SecureConnectionDetails getSecureConnections()
-
getCustomerContacts
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.
- Returns:
- the value
-
getReadEndpoint
public UpdateReadEndpointDetails 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
-
-