Class Backup
Assembly: OCI.DotNetSDK.Database.dll
Syntax
Properties
AvailabilityDomain
Declaration
[JsonProperty(PropertyName = "availabilityDomain")]
public string AvailabilityDomain { get; set; }
Property Value
Type |
Description |
string |
The name of the availability domain where the database backup is stored.
|
BackupDestinationType
Declaration
[JsonProperty(PropertyName = "backupDestinationType")]
[JsonConverter(typeof(ResponseEnumConverter))]
public Backup.BackupDestinationTypeEnum? BackupDestinationType { get; set; }
Property Value
CompartmentId
Declaration
[JsonProperty(PropertyName = "compartmentId")]
public string CompartmentId { get; set; }
Property Value
Type |
Description |
string |
The OCID of the compartment.
|
DatabaseEdition
Declaration
[JsonProperty(PropertyName = "databaseEdition")]
[JsonConverter(typeof(ResponseEnumConverter))]
public Backup.DatabaseEditionEnum? DatabaseEdition { get; set; }
Property Value
Type |
Description |
Backup.DatabaseEditionEnum? |
The Oracle Database Edition that applies to all the databases on the DB system.
Exadata DB systems and 2-node RAC DB systems require ENTERPRISE_EDITION_EXTREME_PERFORMANCE.
|
DatabaseId
Declaration
[JsonProperty(PropertyName = "databaseId")]
public string DatabaseId { get; set; }
Property Value
DatabaseSizeInGBs
Declaration
[JsonProperty(PropertyName = "databaseSizeInGBs")]
public double DatabaseSizeInGBs { get; set; }
Property Value
Type |
Description |
double |
The size of the database in gigabytes at the time the backup was taken.
|
DisplayName
Declaration
[JsonProperty(PropertyName = "displayName")]
public string DisplayName { get; set; }
Property Value
Type |
Description |
string |
The user-friendly name for the backup. The name does not have to be unique.
|
EncryptionKeyLocationDetails
Declaration
[JsonProperty(PropertyName = "encryptionKeyLocationDetails")]
public EncryptionKeyLocationDetails EncryptionKeyLocationDetails { get; set; }
Property Value
Id
Declaration
[JsonProperty(PropertyName = "id")]
public string Id { get; set; }
Property Value
IsUsingOracleManagedKeys
Declaration
[JsonProperty(PropertyName = "isUsingOracleManagedKeys")]
public bool? IsUsingOracleManagedKeys { get; set; }
Property Value
Type |
Description |
bool? |
True if Oracle Managed Keys is required for restore of the backup.
|
KeyStoreId
Declaration
[JsonProperty(PropertyName = "keyStoreId")]
public string KeyStoreId { get; set; }
Property Value
Type |
Description |
string |
The OCID of the key store of Oracle Vault.
|
KeyStoreWalletName
Declaration
[JsonProperty(PropertyName = "keyStoreWalletName")]
public string KeyStoreWalletName { get; set; }
Property Value
Type |
Description |
string |
The wallet name for Oracle Key Vault.
|
KmsKeyId
Declaration
[JsonProperty(PropertyName = "kmsKeyId")]
public string KmsKeyId { get; set; }
Property Value
Type |
Description |
string |
The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.
|
KmsKeyVersionId
Declaration
[JsonProperty(PropertyName = "kmsKeyVersionId")]
public string KmsKeyVersionId { get; set; }
Property Value
Type |
Description |
string |
The OCID of the key container version that is used in database transparent data encryption (TDE) operations KMS Key can have multiple key versions. If none is specified, the current key version (latest) of the Key Id is used for the operation. Autonomous Database Serverless does not use key versions, hence is not applicable for Autonomous Database Serverless instances.
|
LifecycleDetails
Declaration
[JsonProperty(PropertyName = "lifecycleDetails")]
public string LifecycleDetails { get; set; }
Property Value
Type |
Description |
string |
Additional information about the current lifecycle state.
|
LifecycleState
Declaration
[JsonProperty(PropertyName = "lifecycleState")]
[JsonConverter(typeof(ResponseEnumConverter))]
public Backup.LifecycleStateEnum? LifecycleState { get; set; }
Property Value
RetentionPeriodInDays
Declaration
[JsonProperty(PropertyName = "retentionPeriodInDays")]
public int? RetentionPeriodInDays { get; set; }
Property Value
Type |
Description |
int? |
The retention period of the long term backup in days.
|
RetentionPeriodInYears
Declaration
[JsonProperty(PropertyName = "retentionPeriodInYears")]
public int? RetentionPeriodInYears { get; set; }
Property Value
Type |
Description |
int? |
The retention period of the long term backup in years.
|
SecondaryKmsKeyIds
Declaration
[JsonProperty(PropertyName = "secondaryKmsKeyIds")]
public List<string> SecondaryKmsKeyIds { get; set; }
Property Value
Type |
Description |
List<string> |
List of OCIDs of the key containers used as the secondary encryption key in database transparent data encryption (TDE) operations.
|
Shape
Declaration
[JsonProperty(PropertyName = "shape")]
public string Shape { get; set; }
Property Value
Type |
Description |
string |
Shape of the backup's source database.
|
TimeEnded
Declaration
[JsonProperty(PropertyName = "timeEnded")]
public DateTime? TimeEnded { get; set; }
Property Value
Type |
Description |
DateTime? |
The date and time the backup was completed.
|
TimeExpiryScheduled
Declaration
[JsonProperty(PropertyName = "timeExpiryScheduled")]
public DateTime? TimeExpiryScheduled { get; set; }
Property Value
Type |
Description |
DateTime? |
Expiration time of the long term database backup.
|
TimeStarted
Declaration
[JsonProperty(PropertyName = "timeStarted")]
public DateTime? TimeStarted { get; set; }
Property Value
Type |
Description |
DateTime? |
The date and time the backup started.
|
Type
Declaration
[JsonProperty(PropertyName = "type")]
[JsonConverter(typeof(ResponseEnumConverter))]
public Backup.TypeEnum? Type { get; set; }
Property Value
VaultId
Declaration
[JsonProperty(PropertyName = "vaultId")]
public string VaultId { get; set; }
Property Value
Type |
Description |
string |
The OCID of the Oracle Cloud Infrastructure vault. This parameter and secretId are required for Customer Managed Keys.
|
Version
Declaration
[JsonProperty(PropertyName = "version")]
public string Version { get; set; }
Property Value
Type |
Description |
string |
Version of the backup's source database
|