Class DbSystemSummary

A summary of a DB System.

Inheritance

object

DbSystemSummary

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Oci.MysqlService.Models

Assembly: OCI.DotNetSDK.Mysql.dll

Syntax

public class DbSystemSummary

Properties

AvailabilityDomain

Declaration

[JsonProperty(PropertyName = "availabilityDomain")]
public string AvailabilityDomain { get; set; }

Property Value

Type	Description
string	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.

Type

Description

string

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.

BackupPolicy

Declaration

[JsonProperty(PropertyName = "backupPolicy")]
public BackupPolicy BackupPolicy { get; set; }

Property Value

Type	Description
BackupPolicy

CompartmentId

Declaration

[JsonProperty(PropertyName = "compartmentId")]
public string CompartmentId { get; set; }

Property Value

Type	Description
string	The OCID of the compartment the DB System belongs in.

CrashRecovery

Declaration

[JsonProperty(PropertyName = "crashRecovery")]
[JsonConverter(typeof(ResponseEnumConverter))]
public CrashRecoveryStatus? CrashRecovery { get; set; }

Property Value

Type	Description
CrashRecoveryStatus?	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.

CurrentPlacement

Declaration

[JsonProperty(PropertyName = "currentPlacement")]
public DbSystemPlacement CurrentPlacement { get; set; }

Property Value

Type	Description
DbSystemPlacement

DatabaseManagement

Declaration

[JsonProperty(PropertyName = "databaseManagement")]
[JsonConverter(typeof(ResponseEnumConverter))]
public DatabaseManagementStatus? DatabaseManagement { get; set; }

Property Value

Type	Description
DatabaseManagementStatus?	Whether to enable monitoring via the Database Management service.

DefinedTags

Declaration

[JsonProperty(PropertyName = "definedTags")]
public Dictionary<string, Dictionary<string, object>> DefinedTags { get; set; }

Property Value

Type	Description
Dictionary<string, Dictionary<string, object>>	Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace": {"bar-key": "value"}}

DeletionPolicy

Declaration

[JsonProperty(PropertyName = "deletionPolicy")]
public DeletionPolicyDetails DeletionPolicy { get; set; }

Property Value

Type	Description
DeletionPolicyDetails

Description

Declaration

[JsonProperty(PropertyName = "description")]
public string Description { get; set; }

Property Value

Type	Description
string	User-provided data about the DB System.

DisplayName

Declaration

[Required(ErrorMessage = "DisplayName is required.")]
[JsonProperty(PropertyName = "displayName")]
public string DisplayName { get; set; }

Property Value

Type	Description
string	The user-friendly name for the DB System. It does not have to be unique.

Remarks

Required

Endpoints

Declaration

[JsonProperty(PropertyName = "endpoints")]
public List<DbSystemEndpoint> Endpoints { get; set; }

Property Value

Type	Description
List<DbSystemEndpoint>	The network endpoints available for this DB System.

FaultDomain

Declaration

[JsonProperty(PropertyName = "faultDomain")]
public string FaultDomain { get; set; }

Property Value

Type	Description
string	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.

Type

Description

string

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.

FreeformTags

Declaration

[JsonProperty(PropertyName = "freeformTags")]
public Dictionary<string, string> FreeformTags { get; set; }

Property Value

Type	Description
Dictionary<string, string>	Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}

HeatWaveCluster

Declaration

[JsonProperty(PropertyName = "heatWaveCluster")]
public HeatWaveClusterSummary HeatWaveCluster { get; set; }

Property Value

Type	Description
HeatWaveClusterSummary

Id

Declaration

[Required(ErrorMessage = "Id is required.")]
[JsonProperty(PropertyName = "id")]
public string Id { get; set; }

Property Value

Type	Description
string	The OCID of the DB System.

Remarks

Required

IsHeatWaveClusterAttached

Declaration

[JsonProperty(PropertyName = "isHeatWaveClusterAttached")]
public bool? IsHeatWaveClusterAttached { get; set; }

Property Value

Type	Description
bool?	If the DB System has a HeatWave Cluster attached.

IsHighlyAvailable

Declaration

[JsonProperty(PropertyName = "isHighlyAvailable")]
public bool? IsHighlyAvailable { get; set; }

Property Value

Type	Description
bool?	Specifies if the DB System is highly available.

LifecycleState

Declaration

[Required(ErrorMessage = "LifecycleState is required.")]
[JsonProperty(PropertyName = "lifecycleState")]
[JsonConverter(typeof(ResponseEnumConverter))]
public DbSystem.LifecycleStateEnum? LifecycleState { get; set; }

Property Value

Type	Description
DbSystem.LifecycleStateEnum?	The current state of the DB System.

Remarks

Required

MysqlVersion

Declaration

[Required(ErrorMessage = "MysqlVersion is required.")]
[JsonProperty(PropertyName = "mysqlVersion")]
public string MysqlVersion { get; set; }

Property Value

Type	Description
string	Name of the MySQL Version in use for the DB System.

Remarks

Required

ShapeName

Declaration

[JsonProperty(PropertyName = "shapeName")]
public string ShapeName { get; set; }

Property Value

Type	Description
string	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 {@link #listShapes(ListShapesRequest) listShapes} operation.

TimeCreated

Declaration

[Required(ErrorMessage = "TimeCreated is required.")]
[JsonProperty(PropertyName = "timeCreated")]
public DateTime? TimeCreated { get; set; }

Property Value

Type	Description
DateTime?	The date and time the DB System was created.

Remarks

Required

TimeUpdated

Declaration

[Required(ErrorMessage = "TimeUpdated is required.")]
[JsonProperty(PropertyName = "timeUpdated")]
public DateTime? TimeUpdated { get; set; }

Property Value

Type	Description
DateTime?	The time the DB System was last updated.

Remarks

Required