com.solidfire.element.api

Class CreateSnapshotRequest

java.lang.Object

com.solidfire.element.api.CreateSnapshotRequest

All Implemented Interfaces:

java.io.Serializable

public class CreateSnapshotRequest
extends java.lang.Object
implements java.io.Serializable

CreateSnapshotRequest CreateSnapshot enables you to create a point-in-time copy of a volume. You can create a snapshot from any volume or from an existing snapshot. If you do not provide a SnapshotID with this API method, a snapshot is created from the volume's active branch. If the volume from which the snapshot is created is being replicated to a remote cluster, the snapshot can also be replicated to the same target. Use the enableRemoteReplication parameter to enable snapshot replication. Note: Creating a snapshot is allowed if cluster fullness is at stage 2 or 3. Snapshots are not created when cluster fullness is at stage 4 or 5.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CreateSnapshotRequest.Builder

Field Summary

Fields

Modifier and Type	Field and Description
static long	serialVersionUID

Constructor Summary

Constructors

Constructor and Description
CreateSnapshotRequest()
CreateSnapshotRequest(java.lang.Long volumeID, Optional<java.lang.Long> snapshotID, Optional<java.lang.String> name, Optional<java.lang.Boolean> enableRemoteReplication, Optional<java.lang.String> expirationTime, Optional<java.lang.String> retention, Optional<Attributes> attributes)
CreateSnapshotRequest(java.lang.Long volumeID, Optional<java.lang.Long> snapshotID, Optional<java.lang.String> name, Optional<java.lang.Boolean> enableRemoteReplication, Optional<java.lang.String> expirationTime, Optional<java.lang.String> retention, Optional<Attributes> attributes, Optional<java.lang.String> snapMirrorLabel)
CreateSnapshotRequest(java.lang.Long volumeID, Optional<java.lang.Long> snapshotID, Optional<java.lang.String> name, Optional<java.lang.Boolean> enableRemoteReplication, Optional<java.lang.String> expirationTime, Optional<java.lang.String> retention, Optional<Attributes> attributes, Optional<java.lang.String> snapMirrorLabel, Optional<java.lang.Boolean> ensureSerialCreation)
CreateSnapshotRequest(java.lang.Long volumeID, Optional<java.lang.Long> snapshotID, Optional<java.lang.String> name, Optional<java.lang.String> expirationTime, Optional<Attributes> attributes)

Method Summary

Modifier and Type	Method and Description
CreateSnapshotRequest.Builder	asBuilder()
static CreateSnapshotRequest.Builder	builder()
boolean	equals(java.lang.Object o)
Optional<Attributes>	getAttributes() List of name-value pairs in JSON object format.
Optional<java.lang.Boolean>	getEnableRemoteReplication() Replicates the snapshot created to a remote cluster.
Optional<java.lang.Boolean>	getEnsureSerialCreation() Specify if the snapshot creation should be failed if a previous snapshot replication is in progress.
Optional<java.lang.String>	getExpirationTime() Specify the time after which the snapshot can be removed.
Optional<java.lang.String>	getName() Specifies a name for the snapshot.
Optional<java.lang.String>	getRetention() This operates the same as the expirationTime option, except the time format is HH:MM:SS.
Optional<java.lang.String>	getSnapMirrorLabel() Label used by SnapMirror software to specify snapshot retention policy on SnapMirror endpoint.
Optional<java.lang.Long>	getSnapshotID() Specifies the unique ID of a snapshot from which the new snapshot is made.
java.lang.Long	getVolumeID() Specifies the unique ID of the volume image from which to copy.
int	hashCode()
void	setAttributes(Optional<Attributes> attributes)
void	setEnableRemoteReplication(Optional<java.lang.Boolean> enableRemoteReplication)
void	setEnsureSerialCreation(Optional<java.lang.Boolean> ensureSerialCreation)
void	setExpirationTime(Optional<java.lang.String> expirationTime)
void	setName(Optional<java.lang.String> name)
void	setRetention(Optional<java.lang.String> retention)
void	setSnapMirrorLabel(Optional<java.lang.String> snapMirrorLabel)
void	setSnapshotID(Optional<java.lang.Long> snapshotID)
void	setVolumeID(java.lang.Long volumeID)
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

CreateSnapshotRequest

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

CreateSnapshotRequest

@Since(value="7.0")
public CreateSnapshotRequest(java.lang.Long volumeID,
                                                 Optional<java.lang.Long> snapshotID,
                                                 Optional<java.lang.String> name,
                                                 Optional<java.lang.String> expirationTime,
                                                 Optional<Attributes> attributes)

CreateSnapshotRequest

@Since(value="8.0")
public CreateSnapshotRequest(java.lang.Long volumeID,
                                                 Optional<java.lang.Long> snapshotID,
                                                 Optional<java.lang.String> name,
                                                 Optional<java.lang.Boolean> enableRemoteReplication,
                                                 Optional<java.lang.String> expirationTime,
                                                 Optional<java.lang.String> retention,
                                                 Optional<Attributes> attributes)

CreateSnapshotRequest

@Since(value="10.0")
public CreateSnapshotRequest(java.lang.Long volumeID,
                                                  Optional<java.lang.Long> snapshotID,
                                                  Optional<java.lang.String> name,
                                                  Optional<java.lang.Boolean> enableRemoteReplication,
                                                  Optional<java.lang.String> expirationTime,
                                                  Optional<java.lang.String> retention,
                                                  Optional<Attributes> attributes,
                                                  Optional<java.lang.String> snapMirrorLabel)

CreateSnapshotRequest

@Since(value="12.0")
public CreateSnapshotRequest(java.lang.Long volumeID,
                                                  Optional<java.lang.Long> snapshotID,
                                                  Optional<java.lang.String> name,
                                                  Optional<java.lang.Boolean> enableRemoteReplication,
                                                  Optional<java.lang.String> expirationTime,
                                                  Optional<java.lang.String> retention,
                                                  Optional<Attributes> attributes,
                                                  Optional<java.lang.String> snapMirrorLabel,
                                                  Optional<java.lang.Boolean> ensureSerialCreation)

Method Detail

getVolumeID

public java.lang.Long getVolumeID()

Specifies the unique ID of the volume image from which to copy.

setVolumeID

public void setVolumeID(java.lang.Long volumeID)

getSnapshotID

public Optional<java.lang.Long> getSnapshotID()

Specifies the unique ID of a snapshot from which the new snapshot is made. The snapshotID passed must be a snapshot on the given volume.

setSnapshotID

public void setSnapshotID(Optional<java.lang.Long> snapshotID)

getName

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

Specifies a name for the snapshot. If unspecified, the date and time the snapshot was taken is used.

setName

public void setName(Optional<java.lang.String> name)

getEnableRemoteReplication

public Optional<java.lang.Boolean> getEnableRemoteReplication()

Replicates the snapshot created to a remote cluster. Possible values are: true: The snapshot is replicated to remote storage. false: Default. The snapshot is not replicated.

setEnableRemoteReplication

public void setEnableRemoteReplication(Optional<java.lang.Boolean> enableRemoteReplication)

getExpirationTime

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

Specify the time after which the snapshot can be removed. Cannot be used with retention. If neither 'expirationTime' nor 'retention' is specified, the snapshot will be retained until manually deleted. The format is: ISO 8601 date string for time based expiration, otherwise it will not expire. 'null' is the snapshot is to be retained permanently. 'fifo' causes the snapshot to be preserved on a First-In-First-Out basis, relative to other FIFO snapshots on the volume. The API will fail if no FIFO space is available. Warning: Due to a bug, 'expirationTime' does not work correctly prior to magnesium-patch5. Use 'retention' instead.

setExpirationTime

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

getRetention

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

This operates the same as the expirationTime option, except the time format is HH:MM:SS. If neither 'expirationTime' nor 'retention' is specified, the snapshot will be retained until manually deleted.

setRetention

public void setRetention(Optional<java.lang.String> retention)

getAttributes

public Optional<Attributes> getAttributes()

List of name-value pairs in JSON object format.

setAttributes

public void setAttributes(Optional<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)

getEnsureSerialCreation

public Optional<java.lang.Boolean> getEnsureSerialCreation()

Specify if the snapshot creation should be failed if a previous snapshot replication is in progress. Possible values are: true: This ensures only one snapshot is being replicated at a time by failing this snapshot creation. false: Default. This allows creation of snapshot if another snapshot replication is still in progress.

setEnsureSerialCreation

public void setEnsureSerialCreation(Optional<java.lang.Boolean> ensureSerialCreation)

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 CreateSnapshotRequest.Builder builder()

asBuilder

public final CreateSnapshotRequest.Builder asBuilder()