Class Snapshot

A point-in-time snapshot of a specified file system.

Inheritance

object

Snapshot

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Oci.FilestorageService.Models

Assembly: OCI.DotNetSDK.Filestorage.dll

Syntax

public class Snapshot

Properties

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

ExpirationTime

Declaration

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

Property Value

Type	Description
DateTime?	The time when this snapshot will be deleted.

FileSystemId

Declaration

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

Property Value

Type	Description
string	The OCID of the file system from which the snapshot was created.

Remarks

Required

FilesystemSnapshotPolicyId

Declaration

[JsonProperty(PropertyName = "filesystemSnapshotPolicyId")]
public string FilesystemSnapshotPolicyId { get; set; }

Property Value

Type	Description
string	The OCID of the file system snapshot policy that created this snapshot.

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 snapshot.

Remarks

Required

IsCloneSource

Declaration

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

Property Value

Type	Description
bool?	Specifies whether the snapshot has been cloned. See Cloning a File System.

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 Snapshot.LifecycleStateEnum? LifecycleState { get; set; }

Property Value

Type	Description
Snapshot.LifecycleStateEnum?	The current state of the snapshot.

Remarks

Required

Locks

Declaration

[JsonProperty(PropertyName = "locks")]
public List<ResourceLock> Locks { get; set; }

Property Value

Type	Description
List<ResourceLock>	Locks associated with this resource.

Name

Declaration

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

Property Value

Type	Description
string	Name of the snapshot. This value is immutable. Avoid entering confidential information. Example: Sunday

Remarks

Required

ProvenanceId

Declaration

[JsonProperty(PropertyName = "provenanceId")]
public string ProvenanceId { get; set; }

Property Value

Type	Description
string	An OCID identifying the parent from which this snapshot was cloned. If this snapshot was not cloned, then the `provenanceId` is the same as the snapshot `id` value. If this snapshot was cloned, then the `provenanceId` value is the parent's `provenanceId`. See Cloning a File System.

SnapshotTime

Declaration

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

Property Value

Type Description

Type	Description
DateTime?	The date and time the snapshot was taken, expressed in RFC 3339 timestamp format. This value might be the same or different from `timeCreated` depending on the following factors: If the snapshot is created in the original file system directory. If the snapshot is cloned from a file system. If the snapshot is replicated from a file system. Example: 2020-08-25T21:10:29.600Z

DateTime?

The date and time the snapshot was taken, expressed in RFC 3339 timestamp format. This value might be the same or different from timeCreated depending on the following factors:

If the snapshot is created in the original file system directory.
If the snapshot is cloned from a file system.
If the snapshot is replicated from a file system.
Example: 2020-08-25T21:10:29.600Z

SnapshotType

Declaration

[JsonProperty(PropertyName = "snapshotType")]
[JsonConverter(typeof(ResponseEnumConverter))]
public Snapshot.SnapshotTypeEnum? SnapshotType { get; set; }

Property Value

Type	Description
Snapshot.SnapshotTypeEnum?	Specifies generation type of the snapshot.

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 snapshot was created, expressed in RFC 3339 timestamp format. Example: 2016-08-25T21:10:29.600Z

Remarks

Required