Class VolumeBackup

A point-in-time copy of a volume that can then be used to create a new block volume or recover a block volume. For more information, see Overview of Cloud Volume Storage.
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.
Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.

Inheritance

object

VolumeBackup

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Oci.CoreService.Models

Assembly: OCI.DotNetSDK.Core.dll

Syntax

public class VolumeBackup

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 volume backup.

Remarks

Required

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. For more information, see Resource Tags. Example: {"Operations": {"CostCenter": "42"}}

DisplayName

Declaration

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

Property Value

Type	Description
string	A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.

Remarks

Required

ExpirationTime

Declaration

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

Property Value

Type	Description
DateTime?	The date and time the volume backup will expire and be automatically deleted. Format defined by RFC3339. This parameter will always be present for backups that were created automatically by a scheduled-backup policy. For manually created backups, it will be absent, signifying that there is no expiration time and the backup will last forever until manually deleted.

FreeformTags

Declaration

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

Property Value

Type	Description
Dictionary<string, string>	Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}

Id

Declaration

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

Property Value

Type	Description
string	The OCID of the volume backup.

Remarks

Required

IsIndefiniteRetentionEnabled

Declaration

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

Property Value

Type	Description
bool?	feature that preserves backup data from modification or deletion to ensure it remains available for legal or regulatory investigations or litigation, regardless of standard retention policies. This is an optional field. If it is not specified, it is set to null, no legal hold will be applied to the backups.

IsPreventDeletionEnabled

Declaration

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

Property Value

Type	Description
bool?	Prevent backups from being deleted during the configured retention period. This is an optional field. If it is not specified, it is set to null, prevent deletion will not be applied to the backups.

IsRetentionLockEnabled

Declaration

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

Property Value

Type	Description
bool?	feature that prevents deletion or alteration of backup data for a specified period to ensure data protection and regulatory compliance. This is an optional field. If it is not specified, it is set to null, no retention lock will be applied to the backups. This feature should be used in conjunction with the retention-period field.

KmsKeyId

Declaration

[JsonProperty(PropertyName = "kmsKeyId")]
public string KmsKeyId { get; set; }

Property Value

Type	Description
string	The OCID of the Vault service key which is the master encryption key for the volume backup. For more information about the Vault service and encryption keys, see Overview of Vault service and Using Keys.

LifecycleState

Declaration

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

Property Value

Type	Description
VolumeBackup.LifecycleStateEnum?	The current state of a volume backup.

Remarks

Required

RetentionPeriod

Declaration

[JsonProperty(PropertyName = "retentionPeriod")]
public RetentionDuration RetentionPeriod { get; set; }

Property Value

Type	Description
RetentionDuration

SizeInGBs

Declaration

[JsonProperty(PropertyName = "sizeInGBs")]
public long? SizeInGBs { get; set; }

Property Value

Type	Description
long?	The size of the volume, in GBs.

SizeInMBs

Declaration

[JsonProperty(PropertyName = "sizeInMBs")]
public long? SizeInMBs { get; set; }

Property Value

Type	Description
long?	The size of the volume in MBs. The value must be a multiple of 1024. This field is deprecated. Please use sizeInGBs.

SourceType

Declaration

[JsonProperty(PropertyName = "sourceType")]
[JsonConverter(typeof(ResponseEnumConverter))]
public VolumeBackup.SourceTypeEnum? SourceType { get; set; }

Property Value

Type	Description
VolumeBackup.SourceTypeEnum?	Specifies whether the backup was created manually, or via scheduled backup policy.

SourceVolumeBackupId

Declaration

[JsonProperty(PropertyName = "sourceVolumeBackupId")]
public string SourceVolumeBackupId { get; set; }

Property Value

Type	Description
string	The OCID of the source volume backup.

SystemTags

Declaration

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

Property Value

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

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 volume backup was created. This is the time the actual point-in-time image of the volume data was taken. Format defined by RFC3339.

Remarks

Required

TimeRequestReceived

Declaration

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

Property Value

Type	Description
DateTime?	The date and time the request to create the volume backup was received. Format defined by [RFC3339]https://tools.ietf.org/html/rfc3339.

TimeRetentionExpiresAt

Declaration

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

Property Value

Type	Description
DateTime?	The date and time when a backup\u2019s retention period ends and it is set to expire. This is an optional field. If it is not specified, it is set to null, no retention period will be applied to the backups.

Type

Declaration

[Required(ErrorMessage = "Type is required.")]
[JsonProperty(PropertyName = "type")]
[JsonConverter(typeof(ResponseEnumConverter))]
public VolumeBackup.TypeEnum? Type { get; set; }

Property Value

Type	Description
VolumeBackup.TypeEnum?	The type of a volume backup.

Remarks

Required

UniqueSizeInGBs

Declaration

[JsonProperty(PropertyName = "uniqueSizeInGBs")]
public long? UniqueSizeInGBs { get; set; }

Property Value

Type	Description
long?	The size used by the backup, in GBs. It is typically smaller than sizeInGBs, depending on the space consumed on the volume and whether the backup is full or incremental.

UniqueSizeInMbs

Declaration

[JsonProperty(PropertyName = "uniqueSizeInMbs")]
public long? UniqueSizeInMbs { get; set; }

Property Value

Type	Description
long?	The size used by the backup, in MBs. It is typically smaller than sizeInMBs, depending on the space consumed on the volume and whether the backup is full or incremental. This field is deprecated. Please use uniqueSizeInGBs.

VolumeGroupBackupId

Declaration

[JsonProperty(PropertyName = "volumeGroupBackupId")]
public string VolumeGroupBackupId { get; set; }

Property Value

Type	Description
string	The OCID of the volume group backup associated with the backup. This is an optional field. If it is not present in the response, the backup does not belong to a volume group.

VolumeId

Declaration

[JsonProperty(PropertyName = "volumeId")]
public string VolumeId { get; set; }

Property Value

Type	Description
string	The OCID of the volume.