com.solidfire.element.api

Class Snapshot

Object

Snapshot

All Implemented Interfaces:

Serializable

public class Snapshot
extends Object
implements Serializable

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.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Snapshot.Builder

Field Summary

Fields

Modifier and Type	Field and Description
static long	serialVersionUID

Constructor Summary

Constructors

Constructor and Description
Snapshot()
Snapshot(Long snapshotID, Long volumeID, String name, String checksum, Boolean enableRemoteReplication, String expirationReason, String expirationTime, Optional<SnapshotRemoteStatus[]> remoteStatuses, String status, UUID snapshotUUID, Long totalSize, Optional<Long> groupID, UUID groupSnapshotUUID, String createTime, UUID virtualVolumeID, Map<String,Object> attributes)
Snapshot(Long snapshotID, Long volumeID, String name, String checksum, String status, Long totalSize, Optional<Long> groupID, String createTime, UUID virtualVolumeID, Map<String,Object> attributes)

Method Summary

Methods

Modifier and Type	Method and Description
Snapshot.Builder	asBuilder()
static Snapshot.Builder	builder()
boolean	equals(Object o)
Map<String,Object>	getAttributes() List of Name/Value pairs in JSON object format.
String	getChecksum() A string that represents the correct digits in the stored snapshot.
String	getCreateTime() The time this snapshot was taken.
Boolean	getEnableRemoteReplication() Identifies if snapshot is enabled for remote replication.
String	getExpirationReason() Indicates how the snapshot expiration was set.
String	getExpirationTime() The time at which this snapshot will expire and be purged from the cluster.
Optional<Long>	getGroupID() If present, the ID of the group this snapshot is a part of.
UUID	getGroupSnapshotUUID() The current "members" results contains information about each snapshot in the group.
String	getName() A name for this snapshot.
Optional<SnapshotRemoteStatus[]>	getRemoteStatuses() Current remote status of the snapshot remoteStatus: Possible values: Present: Snapshot exists on a remote cluster Not Present: Snapshot does not exist on remote cluster Syncing: This is a target cluster and it is currently replicating the snapshot Deleted: This is a target cluster, the snapshot has been deleted, and it still exists on the source.
Long	getSnapshotID() Unique ID for this snapshot.
UUID	getSnapshotUUID() Universal Unique ID of an existing snapshot.
String	getStatus() Current status of the snapshot Preparing: A snapshot that is being prepared for use and is not yet writable.
Long	getTotalSize() Total size of this snapshot in bytes.
UUID	getVirtualVolumeID() The ID of the virtual volume with which the snapshot is associated.
Long	getVolumeID() The volume this snapshot was taken of.
int	hashCode()
void	setAttributes(Map<String,Object> attributes)
void	setChecksum(String checksum)
void	setCreateTime(String createTime)
void	setEnableRemoteReplication(Boolean enableRemoteReplication)
void	setExpirationReason(String expirationReason)
void	setExpirationTime(String expirationTime)
void	setGroupID(Optional<Long> groupID)
void	setGroupSnapshotUUID(UUID groupSnapshotUUID)
void	setName(String name)
void	setRemoteStatuses(Optional<SnapshotRemoteStatus[]> remoteStatuses)
void	setSnapshotID(Long snapshotID)
void	setSnapshotUUID(UUID snapshotUUID)
void	setStatus(String status)
void	setTotalSize(Long totalSize)
void	setVirtualVolumeID(UUID virtualVolumeID)
void	setVolumeID(Long volumeID)
Map<String,Object>	toMap()
String	toString()

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

serialVersionUID

public static final long serialVersionUID

See Also:

Constant Field Values

Constructor Detail

Snapshot

@Since(value="7.0")
public Snapshot()

Snapshot

@Since(value="7.0")
public Snapshot(Long snapshotID,
                   Long volumeID,
                   String name,
                   String checksum,
                   String status,
                   Long totalSize,
                   Optional<Long> groupID,
                   String createTime,
                   UUID virtualVolumeID,
                   Map<String,Object> attributes)

Snapshot

@Since(value="8.0")
public Snapshot(Long snapshotID,
                   Long volumeID,
                   String name,
                   String checksum,
                   Boolean enableRemoteReplication,
                   String expirationReason,
                   String expirationTime,
                   Optional<SnapshotRemoteStatus[]> remoteStatuses,
                   String status,
                   UUID snapshotUUID,
                   Long totalSize,
                   Optional<Long> groupID,
                   UUID groupSnapshotUUID,
                   String createTime,
                   UUID virtualVolumeID,
                   Map<String,Object> attributes)

Method Detail

getSnapshotID

public Long getSnapshotID()

Unique ID for this snapshot.

setSnapshotID

public void setSnapshotID(Long snapshotID)

getVolumeID

public Long getVolumeID()

The volume this snapshot was taken of.

setVolumeID

public void setVolumeID(Long volumeID)

getName

public String getName()

A name for this snapshot. It is not necessarily unique.

setName

public void setName(String name)

getChecksum

public String getChecksum()

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.

setChecksum

public void setChecksum(String checksum)

getEnableRemoteReplication

public Boolean getEnableRemoteReplication()

Identifies if snapshot is enabled for remote replication.

setEnableRemoteReplication

public void setEnableRemoteReplication(Boolean enableRemoteReplication)

getExpirationReason

public String getExpirationReason()

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.

setExpirationReason

public void setExpirationReason(String expirationReason)

getExpirationTime

public String getExpirationTime()

The time at which this snapshot will expire and be purged from the cluster.

setExpirationTime

public void setExpirationTime(String expirationTime)

getRemoteStatuses

public Optional<SnapshotRemoteStatus[]> getRemoteStatuses()

Current remote status of the snapshot remoteStatus: Possible values: Present: Snapshot exists on a remote cluster Not Present: Snapshot does not exist on remote cluster Syncing: This is a target cluster and it is currently replicating the snapshot Deleted: This is a target cluster, the snapshot has been deleted, and it still exists on the source. volumePairUUID: universal identifier of the volume pair

setRemoteStatuses

public void setRemoteStatuses(Optional<SnapshotRemoteStatus[]> remoteStatuses)

getStatus

public String getStatus()

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.

setStatus

public void setStatus(String status)

getSnapshotUUID

public UUID getSnapshotUUID()

Universal Unique ID of an existing snapshot.

setSnapshotUUID

public void setSnapshotUUID(UUID snapshotUUID)

getTotalSize

public Long getTotalSize()

Total size of this snapshot in bytes. It is equivalent to totalSize of the volume when this snapshot was taken.

setTotalSize

public void setTotalSize(Long totalSize)

getGroupID

public Optional<Long> getGroupID()

If present, the ID of the group this snapshot is a part of. If not present, this snapshot is not part of a group.

setGroupID

public void setGroupID(Optional<Long> groupID)

getGroupSnapshotUUID

public UUID getGroupSnapshotUUID()

The current "members" results contains information about each snapshot in the group. Each of these members will have a "uuid" parameter for the snapshot's UUID.

setGroupSnapshotUUID

public void setGroupSnapshotUUID(UUID groupSnapshotUUID)

getCreateTime

public String getCreateTime()

The time this snapshot was taken.

setCreateTime

public void setCreateTime(String createTime)

getVirtualVolumeID

public UUID getVirtualVolumeID()

The ID of the virtual volume with which the snapshot is associated.

setVirtualVolumeID

public void setVirtualVolumeID(UUID virtualVolumeID)

getAttributes

public Map<String,Object> getAttributes()

List of Name/Value pairs in JSON object format.

setAttributes

public void setAttributes(Map<String,Object> attributes)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toMap

public Map<String,Object> toMap()

toString

public String toString()

Overrides:

toString in class Object

builder

public static Snapshot.Builder builder()

asBuilder

public final Snapshot.Builder asBuilder()