Class CreateDbSystemDetails
- java.lang.Object
-
- com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
-
- com.oracle.bmc.mysql.model.CreateDbSystemDetails
-
@Generated(value="OracleSDKGenerator", comments="API Version: 20190415") public final class CreateDbSystemDetails extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
Details required to create a DB System.
Note: Objects should always be created or deserialized using theCreateDbSystemDetails.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 theCreateDbSystemDetails.Builder
, which maintain a set of all explicitly set fields calledCreateDbSystemDetails.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
CreateDbSystemDetails.Builder
-
Constructor Summary
Constructors Constructor Description CreateDbSystemDetails(String displayName, String description, String compartmentId, Boolean isHighlyAvailable, String availabilityDomain, String faultDomain, String configurationId, String shapeName, String mysqlVersion, String subnetId, String adminUsername, String adminPassword, Integer dataStorageSizeInGBs, DataStorageDetails dataStorage, String hostnameLabel, String ipAddress, Integer port, Integer portX, CreateBackupPolicyDetails backupPolicy, CreateDbSystemSourceDetails source, CreateMaintenanceDetails maintenance, Map<String,String> freeformTags, Map<String,Map<String,Object>> definedTags, CreateDeletionPolicyDetails deletionPolicy, CrashRecoveryStatus crashRecovery, DatabaseManagementStatus databaseManagement, SecureConnectionDetails secureConnections, DbSystem.DatabaseMode databaseMode, DbSystem.AccessMode accessMode, List<CustomerContact> customerContacts, CreateReadEndpointDetails readEndpoint)
Deprecated.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static CreateDbSystemDetails.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 (default): 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.String
getAvailabilityDomain()
The availability domain on which to deploy the Read/Write endpoint.CreateBackupPolicyDetails
getBackupPolicy()
String
getCompartmentId()
The OCID of the compartment.String
getConfigurationId()
The OCID of the Configuration to be used for 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()
Initial size of the data volume in GBs that will be created and attached.Map<String,Map<String,Object>>
getDefinedTags()
Usage of predefined tag keys.CreateDeletionPolicyDetails
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 is configured to listen on.Boolean
getIsHighlyAvailable()
Specifies if the DB System is highly available.CreateMaintenanceDetails
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.CreateReadEndpointDetails
getReadEndpoint()
SecureConnectionDetails
getSecureConnections()
String
getShapeName()
The name of the shape.CreateDbSystemSourceDetails
getSource()
String
getSubnetId()
The OCID of the subnet the DB System is associated with.int
hashCode()
CreateDbSystemDetails.Builder
toBuilder()
String
toString()
String
toString(boolean includeByteArrayContents)
Return a string representation of the object.
-
-
-
Constructor Detail
-
CreateDbSystemDetails
@Deprecated @ConstructorProperties({"displayName","description","compartmentId","isHighlyAvailable","availabilityDomain","faultDomain","configurationId","shapeName","mysqlVersion","subnetId","adminUsername","adminPassword","dataStorageSizeInGBs","dataStorage","hostnameLabel","ipAddress","port","portX","backupPolicy","source","maintenance","freeformTags","definedTags","deletionPolicy","crashRecovery","databaseManagement","secureConnections","databaseMode","accessMode","customerContacts","readEndpoint"}) public CreateDbSystemDetails(String displayName, String description, String compartmentId, Boolean isHighlyAvailable, String availabilityDomain, String faultDomain, String configurationId, String shapeName, String mysqlVersion, String subnetId, String adminUsername, String adminPassword, Integer dataStorageSizeInGBs, DataStorageDetails dataStorage, String hostnameLabel, String ipAddress, Integer port, Integer portX, CreateBackupPolicyDetails backupPolicy, CreateDbSystemSourceDetails source, CreateMaintenanceDetails maintenance, Map<String,String> freeformTags, Map<String,Map<String,Object>> definedTags, CreateDeletionPolicyDetails deletionPolicy, CrashRecoveryStatus crashRecovery, DatabaseManagementStatus databaseManagement, SecureConnectionDetails secureConnections, DbSystem.DatabaseMode databaseMode, DbSystem.AccessMode accessMode, List<CustomerContact> customerContacts, CreateReadEndpointDetails readEndpoint)
Deprecated.
-
-
Method Detail
-
builder
public static CreateDbSystemDetails.Builder builder()
Create a new builder.
-
toBuilder
public CreateDbSystemDetails.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
-
getCompartmentId
public String getCompartmentId()
The OCID of the compartment.- Returns:
- the value
-
getIsHighlyAvailable
public Boolean getIsHighlyAvailable()
Specifies if the DB System is highly available.When creating a DB System with High Availability, three instances are created and placed according to your region- and subnet-type. The secondaries are placed automatically in the other two availability or fault domains. You can choose the preferred location of your primary instance, only.
- 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
-
getConfigurationId
public String getConfigurationId()
The OCID of the Configuration to be used for this DB System.- Returns:
- the value
-
getShapeName
public String getShapeName()
The name of the shape.The shape determines the resources allocated - 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
-
getMysqlVersion
public String getMysqlVersion()
The specific MySQL version identifier.- Returns:
- the value
-
getSubnetId
public String getSubnetId()
The OCID of the subnet the DB System is associated with.- Returns:
- the value
-
getAdminUsername
public String getAdminUsername()
The username for the administrative user.- 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()
Initial size of the data volume in GBs that will be created and attached.Keep in mind that this only specifies the size of the database data volume, the log volume for the database will be scaled appropriately with its shape.
- 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 is configured to listen on.A private IP address of your choice to assign to the primary endpoint of the DB System. Must be an available 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 CreateBackupPolicyDetails getBackupPolicy()
-
getSource
public CreateDbSystemSourceDetails getSource()
-
getMaintenance
public CreateMaintenanceDetails 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 CreateDeletionPolicyDetails 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()
-
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 (default): 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 (default): 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
-
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 CreateReadEndpointDetails 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
-
-