Click or drag to resize

Snapshot Class

Snapshot Snapshots is an object containing information about each snapshot made for a volume. The return object includes information for the active snapshot as well as each snapshot created for the volume.
Inheritance Hierarchy
SystemObject
  SolidFire.CoreRpcBase
    SolidFire.Element.ApiSnapshot

Namespace:  SolidFire.Element.Api
Assembly:  SolidFire.SDK (in SolidFire.SDK.dll) Version: 12.3.0.0
Syntax
C#
Copy
public class Snapshot : RpcBase

The Snapshot type exposes the following members.

Constructors
  NameDescription
Public methodSnapshot
Initializes a new instance of the Snapshot class
Top
Properties
  NameDescription
Public propertyAttributes
List of Name/Value pairs in JSON object format.
Public propertyChecksum
A string that represents the correct digits in the stored snapshot. This checksum can be used later to compare other snapshots to detect errors in the data.
Public propertyCreateTime
The time this snapshot was taken.
Public propertyEnableRemoteReplication
Identifies if snapshot is enabled for remote replication.
Public propertyExpirationReason
Indicates how the snapshot expiration was set. Possible values: api: expiration time was set by using the API. none: there is no expiration time set. test: expiration time was set for testing. fifo: expiration occurs on first in first out basis. Warning: This member is returned but may have an incorrect value. Do not use.
Public propertyExpirationTime
The time at which this snapshot will expire and be purged from the cluster.
Public propertyGroupID
If present, the ID of the group this snapshot is a part of. If not present, this snapshot is not part of a group.
Public propertyGroupSnapshotUUID
Universal Unique ID of the group this snapshot is part of.
Public propertyInstanceCreateTime
Public propertyInstanceSnapshotUUID
Public propertyName
A name for this snapshot. It is not necessarily unique.
Public propertyRemoteStatuses
Replication status details of the snapshot as seen on the source cluster.
Public propertySnapMirrorLabel
Label used by SnapMirror software to specify snapshot retention policy on SnapMirror endpoint.
Public propertySnapshotID
Unique ID for this snapshot.
Public propertySnapshotUUID
Universal Unique ID of an existing snapshot.
Public propertyStatus
Current status of the snapshot Preparing: A snapshot that is being prepared for use and is not yet writable. Done: A snapshot that has finished being prepared and is now usable. Active: This snapshot is the active branch.
Public propertyTotalSize
Total size of this snapshot in bytes. It is equivalent to totalSize of the volume when this snapshot was taken.
Public propertyVirtualVolumeID
The ID of the virtual volume with which the snapshot is associated.
Public propertyVolumeID
The volume this snapshot was taken of.
Public propertyVolumeName
Top
Methods
  NameDescription
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodToString
Builds a json-enabled string of all the properties and their values in this class.
(Inherited from RpcBase.)
Top
See Also