com.solidfire.element.api

Class Snapshot

java.lang.Object

com.solidfire.element.api.Snapshot

All Implemented Interfaces:

java.io.Serializable

public class Snapshot
extends java.lang.Object
implements java.io.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(java.lang.Long snapshotID, java.lang.Long volumeID, java.lang.String name, java.lang.String checksum, java.lang.Boolean enableRemoteReplication, java.lang.String expirationReason, Optional<java.lang.String> expirationTime, Optional<SnapshotRemoteStatus[]> remoteStatuses, java.lang.String status, java.util.UUID snapshotUUID, java.lang.Long totalSize, Optional<java.lang.Long> groupID, java.util.UUID groupSnapshotUUID, java.lang.String createTime, java.lang.String instanceCreateTime, java.lang.String volumeName, java.util.UUID instanceSnapshotUUID, Optional<java.util.UUID> virtualVolumeID, Attributes attributes, Optional<java.lang.String> snapMirrorLabel)

Method Summary

Modifier and Type	Method and Description
Snapshot.Builder	asBuilder()
static Snapshot.Builder	builder()
boolean	equals(java.lang.Object o)
Attributes	getAttributes() List of Name/Value pairs in JSON object format.
java.lang.String	getChecksum() A string that represents the correct digits in the stored snapshot.
java.lang.String	getCreateTime() The time this snapshot was taken.
java.lang.Boolean	getEnableRemoteReplication() Identifies if snapshot is enabled for remote replication.
java.lang.String	getExpirationReason() Indicates how the snapshot expiration was set.
Optional<java.lang.String>	getExpirationTime() The time at which this snapshot will expire and be purged from the cluster.
Optional<java.lang.Long>	getGroupID() If present, the ID of the group this snapshot is a part of.
java.util.UUID	getGroupSnapshotUUID() Universal Unique ID of the group this snapshot is part of.
java.lang.String	getInstanceCreateTime()
java.util.UUID	getInstanceSnapshotUUID()
java.lang.String	getName() A name for this snapshot.
Optional<SnapshotRemoteStatus[]>	getRemoteStatuses() Replication status details of the snapshot as seen on the source cluster.
Optional<java.lang.String>	getSnapMirrorLabel() Label used by SnapMirror software to specify snapshot retention policy on SnapMirror endpoint.
java.lang.Long	getSnapshotID() Unique ID for this snapshot.
java.util.UUID	getSnapshotUUID() Universal Unique ID of an existing snapshot.
java.lang.String	getStatus() Current status of the snapshot Preparing: A snapshot that is being prepared for use and is not yet writable.
java.lang.Long	getTotalSize() Total size of this snapshot in bytes.
Optional<java.util.UUID>	getVirtualVolumeID() The ID of the virtual volume with which the snapshot is associated.
java.lang.Long	getVolumeID() The volume this snapshot was taken of.
java.lang.String	getVolumeName()
int	hashCode()
void	setAttributes(Attributes attributes)
void	setChecksum(java.lang.String checksum)
void	setCreateTime(java.lang.String createTime)
void	setEnableRemoteReplication(java.lang.Boolean enableRemoteReplication)
void	setExpirationReason(java.lang.String expirationReason)
void	setExpirationTime(Optional<java.lang.String> expirationTime)
void	setGroupID(Optional<java.lang.Long> groupID)
void	setGroupSnapshotUUID(java.util.UUID groupSnapshotUUID)
void	setInstanceCreateTime(java.lang.String instanceCreateTime)
void	setInstanceSnapshotUUID(java.util.UUID instanceSnapshotUUID)
void	setName(java.lang.String name)
void	setRemoteStatuses(Optional<SnapshotRemoteStatus[]> remoteStatuses)
void	setSnapMirrorLabel(Optional<java.lang.String> snapMirrorLabel)
void	setSnapshotID(java.lang.Long snapshotID)
void	setSnapshotUUID(java.util.UUID snapshotUUID)
void	setStatus(java.lang.String status)
void	setTotalSize(java.lang.Long totalSize)
void	setVirtualVolumeID(Optional<java.util.UUID> virtualVolumeID)
void	setVolumeID(java.lang.Long volumeID)
void	setVolumeName(java.lang.String volumeName)
java.util.Map<java.lang.String,java.lang.Object>	toMap()
java.lang.String	toString()

Methods inherited from class java.lang.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(java.lang.Long snapshotID,
                                    java.lang.Long volumeID,
                                    java.lang.String name,
                                    java.lang.String checksum,
                                    java.lang.Boolean enableRemoteReplication,
                                    java.lang.String expirationReason,
                                    Optional<java.lang.String> expirationTime,
                                    Optional<SnapshotRemoteStatus[]> remoteStatuses,
                                    java.lang.String status,
                                    java.util.UUID snapshotUUID,
                                    java.lang.Long totalSize,
                                    Optional<java.lang.Long> groupID,
                                    java.util.UUID groupSnapshotUUID,
                                    java.lang.String createTime,
                                    java.lang.String instanceCreateTime,
                                    java.lang.String volumeName,
                                    java.util.UUID instanceSnapshotUUID,
                                    Optional<java.util.UUID> virtualVolumeID,
                                    Attributes attributes,
                                    Optional<java.lang.String> snapMirrorLabel)

Method Detail

getSnapshotID

public java.lang.Long getSnapshotID()

Unique ID for this snapshot.

setSnapshotID

public void setSnapshotID(java.lang.Long snapshotID)

getVolumeID

public java.lang.Long getVolumeID()

The volume this snapshot was taken of.

setVolumeID

public void setVolumeID(java.lang.Long volumeID)

getName

public java.lang.String getName()

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

setName

public void setName(java.lang.String name)

getChecksum

public java.lang.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(java.lang.String checksum)

getEnableRemoteReplication

public java.lang.Boolean getEnableRemoteReplication()

Identifies if snapshot is enabled for remote replication.

setEnableRemoteReplication

public void setEnableRemoteReplication(java.lang.Boolean enableRemoteReplication)

getExpirationReason

public java.lang.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. fifo: expiration occurs on first in first out basis. Warning: This member is returned but may have an incorrect value. Do not use.

setExpirationReason

public void setExpirationReason(java.lang.String expirationReason)

getExpirationTime

public Optional<java.lang.String> getExpirationTime()

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

setExpirationTime

public void setExpirationTime(Optional<java.lang.String> expirationTime)

getRemoteStatuses

public Optional<SnapshotRemoteStatus[]> getRemoteStatuses()

Replication status details of the snapshot as seen on the source cluster.

setRemoteStatuses

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

getStatus

public java.lang.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(java.lang.String status)

getSnapshotUUID

public java.util.UUID getSnapshotUUID()

Universal Unique ID of an existing snapshot.

setSnapshotUUID

public void setSnapshotUUID(java.util.UUID snapshotUUID)

getTotalSize

public java.lang.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(java.lang.Long totalSize)

getGroupID

public Optional<java.lang.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<java.lang.Long> groupID)

getGroupSnapshotUUID

public java.util.UUID getGroupSnapshotUUID()

Universal Unique ID of the group this snapshot is part of.

setGroupSnapshotUUID

public void setGroupSnapshotUUID(java.util.UUID groupSnapshotUUID)

getCreateTime

public java.lang.String getCreateTime()

The time this snapshot was taken.

setCreateTime

public void setCreateTime(java.lang.String createTime)

getInstanceCreateTime

public java.lang.String getInstanceCreateTime()

setInstanceCreateTime

public void setInstanceCreateTime(java.lang.String instanceCreateTime)

getVolumeName

public java.lang.String getVolumeName()

setVolumeName

public void setVolumeName(java.lang.String volumeName)

getInstanceSnapshotUUID

public java.util.UUID getInstanceSnapshotUUID()

setInstanceSnapshotUUID

public void setInstanceSnapshotUUID(java.util.UUID instanceSnapshotUUID)

getVirtualVolumeID

public Optional<java.util.UUID> getVirtualVolumeID()

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

setVirtualVolumeID

public void setVirtualVolumeID(Optional<java.util.UUID> virtualVolumeID)

getAttributes

public Attributes getAttributes()

List of Name/Value pairs in JSON object format.

setAttributes

public void setAttributes(Attributes attributes)

getSnapMirrorLabel

public Optional<java.lang.String> getSnapMirrorLabel()

Label used by SnapMirror software to specify snapshot retention policy on SnapMirror endpoint.

setSnapMirrorLabel

public void setSnapMirrorLabel(Optional<java.lang.String> snapMirrorLabel)

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toMap

public java.util.Map<java.lang.String,java.lang.Object> toMap()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

builder

public static Snapshot.Builder builder()

asBuilder

public final Snapshot.Builder asBuilder()