Show / Hide Table of Contents

Class VolumeGroupBackup

A point-in-time copy of a volume group that can then be used to create a new volume group or restore a volume group. For more information, see Volume Groups.
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
VolumeGroupBackup
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 VolumeGroupBackup

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 group 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 group backup will expire and be automatically deleted. Format defined by RFC3339. This parameter will always be present for volume group backups that were created automatically by a scheduled-backup policy. For manually created volume group 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 group backup.

Remarks

Required

LifecycleState

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

The current state of a volume group backup.

Remarks

Required

SizeInGBs

Declaration
[JsonProperty(PropertyName = "sizeInGBs")]
public long? SizeInGBs { get; set; }
Property Value
Type Description
long?

The aggregate size of the volume group backup, in GBs.

SizeInMBs

Declaration
[JsonProperty(PropertyName = "sizeInMBs")]
public long? SizeInMBs { get; set; }
Property Value
Type Description
long?

The aggregate size of the volume group backup, in MBs.

SourceType

Declaration
[JsonProperty(PropertyName = "sourceType")]
[JsonConverter(typeof(ResponseEnumConverter))]
public VolumeGroupBackup.SourceTypeEnum? SourceType { get; set; }
Property Value
Type Description
VolumeGroupBackup.SourceTypeEnum?

Specifies whether the volume group backup was created manually, or via scheduled backup policy.

SourceVolumeGroupBackupId

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

The OCID of the source volume group backup.

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

Type

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

The type of backup.

Remarks

Required

UniqueSizeInGbs

Declaration
[JsonProperty(PropertyName = "uniqueSizeInGbs")]
public long? UniqueSizeInGbs { get; set; }
Property Value
Type Description
long?

The aggregate size used by the volume group backup, in GBs.
It is typically smaller than sizeInGBs, depending on the spaceconsumed on the volume group and whether the volume backup is full or incremental.

UniqueSizeInMbs

Declaration
[JsonProperty(PropertyName = "uniqueSizeInMbs")]
public long? UniqueSizeInMbs { get; set; }
Property Value
Type Description
long?

The aggregate size used by the volume group backup, in MBs.
It is typically smaller than sizeInMBs, depending on the spaceconsumed on the volume group and whether the volume backup is full or incremental.

VolumeBackupIds

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

OCIDs for the volume backups in this volume group backup.

Remarks

Required

VolumeGroupId

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

The OCID of the source volume group.

In this article
Back to top