Class BackupSummary

Details of Backups such as OCID, description, backupType, and so on.
To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see Getting Started with Policies.

Inheritance

object

BackupSummary

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 BackupSummary

Properties

BackupPreparationStatus

Declaration

[JsonProperty(PropertyName = "backupPreparationStatus")]
[JsonConverter(typeof(ResponseEnumConverter))]
public BackupValidationDetails.BackupPreparationStatusEnum? BackupPreparationStatus { get; set; }

Property Value

Type	Description
BackupValidationDetails.BackupPreparationStatusEnum?	Indicates whether the backup has been prepared successfully.

BackupSizeInGBs

Declaration

[JsonProperty(PropertyName = "backupSizeInGBs")]
public int? BackupSizeInGBs { get; set; }

Property Value

Type	Description
int?	The size of the backup in GiBs.

BackupType

Declaration

[Required(ErrorMessage = "BackupType is required.")]
[JsonProperty(PropertyName = "backupType")]
[JsonConverter(typeof(ResponseEnumConverter))]
public Backup.BackupTypeEnum? BackupType { get; set; }

Property Value

Type	Description
Backup.BackupTypeEnum?	The type of backup.

Remarks

Required

CompartmentId

Declaration

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

Property Value

Type	Description
string	The OCID of the compartment the backup exists in.

Remarks

Required

CreationType

Declaration

[Required(ErrorMessage = "CreationType is required.")]
[JsonProperty(PropertyName = "creationType")]
[JsonConverter(typeof(ResponseEnumConverter))]
public Backup.CreationTypeEnum? CreationType { get; set; }

Property Value

Type	Description
Backup.CreationTypeEnum?	If the backup was created automatically, or by a manual request.

Remarks

Required

DataStorageSizeInGBs

Declaration

[JsonProperty(PropertyName = "dataStorageSizeInGBs")]
public int? DataStorageSizeInGBs { get; set; }

Property Value

Type	Description
int?	Size of the data volume in GiBs.

DbSystemId

Declaration

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

Property Value

Type	Description
string	The OCID of the DB System the Backup is associated with.

Remarks

Required

DbSystemSnapshotSummary

Declaration

[JsonProperty(PropertyName = "dbSystemSnapshotSummary")]
public DbSystemSnapshotSummary DbSystemSnapshotSummary { get; set; }

Property Value

Type	Description
DbSystemSnapshotSummary

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"}}

Description

Declaration

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

Property Value

Type	Description
string	A user-supplied description of the backup.

DisplayName

Declaration

[JsonProperty(PropertyName = "displayName")]
public string DisplayName { get; set; }

Property Value

Type	Description
string	A user-supplied display name for the backup.

EncryptData

Declaration

[JsonProperty(PropertyName = "encryptData")]
public EncryptDataDetails EncryptData { get; set; }

Property Value

Type	Description
EncryptDataDetails

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"}

Id

Declaration

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

Property Value

Type	Description
string	OCID of the backup.

Remarks

Required

ImmediateSourceBackupId

Declaration

[JsonProperty(PropertyName = "immediateSourceBackupId")]
public string ImmediateSourceBackupId { get; set; }

Property Value

Type	Description
string	The OCID of the immediate source DB system backup from which this DB system backup was copied.

LifecycleDetails

Declaration

[JsonProperty(PropertyName = "lifecycleDetails")]
public string LifecycleDetails { get; set; }

Property Value

Type	Description
string	Additional information about the current lifecycleState.

LifecycleState

Declaration

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

Property Value

Type	Description
Backup.LifecycleStateEnum?	The state of the backup.

Remarks

Required

MysqlVersion

Declaration

[JsonProperty(PropertyName = "mysqlVersion")]
public string MysqlVersion { get; set; }

Property Value

Type	Description
string	The version of the DB System used for backup.

OriginalSourceBackupId

Declaration

[JsonProperty(PropertyName = "originalSourceBackupId")]
public string OriginalSourceBackupId { get; set; }

Property Value

Type	Description
string	The OCID of the original source DB system backup from which this DB system backup was copied.

RetentionInDays

Declaration

[JsonProperty(PropertyName = "retentionInDays")]
public int? RetentionInDays { get; set; }

Property Value

Type	Description
int?	Number of days to retain this backup.

ShapeName

Declaration

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

Property Value

Type	Description
string	The shape of the DB System instance used for backup.

SoftDelete

Declaration

[JsonProperty(PropertyName = "softDelete")]
[JsonConverter(typeof(ResponseEnumConverter))]
public SoftDelete? SoftDelete { get; set; }

Property Value

Type	Description
SoftDelete?	Retains the backup to be deleted due to the retention policy in DELETE SCHEDULED state for 7 days before permanently deleting it.

SystemTags

Declaration

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

Property Value

Type	Description
Dictionary<string, Dictionary<string, object>>	Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud": {"free-tier-retained": "true"}}

TimeCopyCreated

Declaration

[JsonProperty(PropertyName = "timeCopyCreated")]
public DateTime? TimeCopyCreated { get; set; }

Property Value

Type	Description
DateTime?	The date and time the DB system backup copy was created, as described by RFC 3339.

TimeCreated

Declaration

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

Property Value

Type	Description
DateTime?	The time the backup was created.

Remarks

Required

ValidationStatus

Declaration

[JsonProperty(PropertyName = "validationStatus")]
[JsonConverter(typeof(ResponseEnumConverter))]
public BackupValidationDetails.ValidationStatusEnum? ValidationStatus { get; set; }

Property Value

Type	Description
BackupValidationDetails.ValidationStatusEnum?	Status of the backup validation.