Show / Hide Table of Contents

Class LongTermBackupSummary

Generate an on-demand backup and retain it long-term as per the LTR backup retention period specified.

Inheritance
object
LongTermBackupSummary
Inherited Members
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: Oci.RecoveryService.Models
Assembly: OCI.DotNetSDK.Recovery.dll
Syntax
public class LongTermBackupSummary

Properties

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 that contains the long term backup.

Remarks

Required

DatabaseIdentifier

Declaration
[JsonProperty(PropertyName = "databaseIdentifier")]
public string DatabaseIdentifier { get; set; }
Property Value
Type Description
string

The Oracle Database ID, which identifies an Oracle Database located outside of Oracle Cloud.

DatabaseSizeInGBs

Declaration
[JsonProperty(PropertyName = "databaseSizeInGBs")]
public int? DatabaseSizeInGBs { get; set; }
Property Value
Type Description
int?

Database size

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"}}. For more information, see Resource Tags

DisplayName

Declaration
[JsonProperty(PropertyName = "displayName")]
public string DisplayName { get; set; }
Property Value
Type Description
string

The long term backup name. You can change the displayName. Avoid entering confidential information.

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

The Long Term Backup OCID.

Remarks

Required

LifecycleDetails

Declaration
[JsonProperty(PropertyName = "lifecycleDetails")]
public string LifecycleDetails { get; set; }
Property Value
Type Description
string

Detailed description about the current lifecycle state of the long term backup. For example, it can be used to provide actionable information for a resource in a Failed state.

LifecycleState

Declaration
[Required(ErrorMessage = "LifecycleState is required.")]
[JsonProperty(PropertyName = "lifecycleState")]
[JsonConverter(typeof(StringEnumConverter))]
public LongTermBackup.LifecycleStateEnum? LifecycleState { get; set; }
Property Value
Type Description
LongTermBackup.LifecycleStateEnum?

The current state of the long term backup.

Remarks

Required

LifecycleSubstate

Declaration
[JsonProperty(PropertyName = "lifecycleSubstate")]
[JsonConverter(typeof(StringEnumConverter))]
public LongTermBackup.LifecycleSubstateEnum? LifecycleSubstate { get; set; }
Property Value
Type Description
LongTermBackup.LifecycleSubstateEnum?

More details on the state of the backup when it is in Creating lifecycleState.

ProtectedDatabaseId

Declaration
[Required(ErrorMessage = "ProtectedDatabaseId is required.")]
[JsonProperty(PropertyName = "protectedDatabaseId")]
public string ProtectedDatabaseId { get; set; }
Property Value
Type Description
string

The protected database ocid.

Remarks

Required

RetentionPeriod

Declaration
[Required(ErrorMessage = "RetentionPeriod is required.")]
[JsonProperty(PropertyName = "retentionPeriod")]
public List<RetentionPeriodValue> RetentionPeriod { get; set; }
Property Value
Type Description
List<RetentionPeriodValue>

Retain the long-term backup as per the backup retention period specified

Remarks

Required

RetentionPointInTime

Declaration
[JsonProperty(PropertyName = "retentionPointInTime")]
public DateTime? RetentionPointInTime { get; set; }
Property Value
Type Description
DateTime?

An RFC3339 formatted datetime string that indicates the time for a long term backup to be initiated.

RetentionScn

Declaration
[JsonProperty(PropertyName = "retentionScn")]
public int? RetentionScn { get; set; }
Property Value
Type Description
int?

System Change Number (SCN) to which backup is consistent.

RetentionUntilDateTime

Declaration
[Required(ErrorMessage = "RetentionUntilDateTime is required.")]
[JsonProperty(PropertyName = "retentionUntilDateTime")]
public DateTime? RetentionUntilDateTime { get; set; }
Property Value
Type Description
DateTime?

An RFC3339 formatted datetime string that indicates the time after which the long term backup will be deleted. For example '2020-05-22T21:10:29.600Z'. This timestamp has to be 95 days-10 years from the current timestamp

Remarks

Required

RmanTag

Declaration
[JsonProperty(PropertyName = "rmanTag")]
public string RmanTag { get; set; }
Property Value
Type Description
string

Recovery Manager (RMAN) assigned unique identifier for the long-term backup.

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"}}. For more information, see Resource Tags

TimeBackupCompleted

Declaration
[JsonProperty(PropertyName = "timeBackupCompleted")]
public DateTime? TimeBackupCompleted { get; set; }
Property Value
Type Description
DateTime?

An RFC3339 formatted datetime string that indicates the time when the backup was actually completed. For example '2020-05-22T21:10:29.600Z'

TimeBackupInitiated

Declaration
[JsonProperty(PropertyName = "timeBackupInitiated")]
public DateTime? TimeBackupInitiated { get; set; }
Property Value
Type Description
DateTime?

An RFC3339 formatted datetime string that indicates the time when the backup was actually taken. For example '2020-05-22T21:10:29.600Z'

TimeCreated

Declaration
[JsonProperty(PropertyName = "timeCreated")]
public DateTime? TimeCreated { get; set; }
Property Value
Type Description
DateTime?

An RFC3339 formatted datetime string that indicates the created time for the long term backup. For Example: '2020-05-22T21:10:29.600Z'.

TimeUpdated

Declaration
[JsonProperty(PropertyName = "timeUpdated")]
public DateTime? TimeUpdated { get; set; }
Property Value
Type Description
DateTime?

An RFC3339 formatted datetime string that indicates the updated time for the long term backup. For Example: '2020-05-22T21:10:29.600Z'.

In this article
Back to top