com.solidfire.element.api

Class CloneVolumeRequest

java.lang.Object

com.solidfire.element.api.CloneVolumeRequest

All Implemented Interfaces:

java.io.Serializable

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

CloneVolumeRequest CloneVolume enables you to create a copy of a volume. This method is asynchronous and might take a variable amount of time to complete. The cloning process begins immediately when you make the CloneVolume request and is representative of the state of the volume when the API method is issued. You can use the GetAsyncResult method to determine when the cloning process is complete and the new volume is available for connections. You can use ListSyncJobs to see the progress of creating the clone. Note: The initial attributes and QoS settings for the volume are inherited from the volume being cloned. You can change these settings with ModifyVolume. Note: Cloned volumes do not inherit volume access group memberships from the source volume.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CloneVolumeRequest.Builder

Field Summary

Fields

Modifier and Type	Field and Description
static long	serialVersionUID

Constructor Summary

Constructors

Constructor and Description
CloneVolumeRequest()
CloneVolumeRequest(java.lang.Long volumeID, java.lang.String name, Optional<java.lang.Long> newAccountID, Optional<java.lang.Long> newSize, Optional<java.lang.String> access, Optional<java.lang.Long> snapshotID, Optional<Attributes> attributes, Optional<java.lang.Boolean> enable512e)
CloneVolumeRequest(java.lang.Long volumeID, java.lang.String name, Optional<java.lang.Long> newAccountID, Optional<java.lang.Long> newSize, Optional<java.lang.String> access, Optional<java.lang.Long> snapshotID, Optional<Attributes> attributes, Optional<java.lang.Boolean> enable512e, Optional<java.lang.Boolean> enableSnapMirrorReplication)

Method Summary

Modifier and Type	Method and Description
CloneVolumeRequest.Builder	asBuilder()
static CloneVolumeRequest.Builder	builder()
boolean	equals(java.lang.Object o)
Optional<java.lang.String>	getAccess() Specifies the level of access allowed for the new volume.
Optional<Attributes>	getAttributes() List of name-value pairs in JSON object format.
Optional<java.lang.Boolean>	getEnable512e() Specifies whether the new volume should use 512-byte sector emulation.
Optional<java.lang.Boolean>	getEnableSnapMirrorReplication() Specifies whether SnapMirror replication is enabled or not.
java.lang.String	getName() The name of the new cloned volume.
Optional<java.lang.Long>	getNewAccountID() AccountID for the owner of the new volume.
Optional<java.lang.Long>	getNewSize() New size of the volume, in bytes.
Optional<java.lang.Long>	getSnapshotID() ID of the snapshot that is used as the source of the clone.
java.lang.Long	getVolumeID() VolumeID for the volume to be cloned.
int	hashCode()
void	setAccess(Optional<java.lang.String> access)
void	setAttributes(Optional<Attributes> attributes)
void	setEnable512e(Optional<java.lang.Boolean> enable512e)
void	setEnableSnapMirrorReplication(Optional<java.lang.Boolean> enableSnapMirrorReplication)
void	setName(java.lang.String name)
void	setNewAccountID(Optional<java.lang.Long> newAccountID)
void	setNewSize(Optional<java.lang.Long> newSize)
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

CloneVolumeRequest

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

CloneVolumeRequest

@Since(value="7.0")
public CloneVolumeRequest(java.lang.Long volumeID,
                                              java.lang.String name,
                                              Optional<java.lang.Long> newAccountID,
                                              Optional<java.lang.Long> newSize,
                                              Optional<java.lang.String> access,
                                              Optional<java.lang.Long> snapshotID,
                                              Optional<Attributes> attributes,
                                              Optional<java.lang.Boolean> enable512e)

CloneVolumeRequest

@Since(value="10.0")
public CloneVolumeRequest(java.lang.Long volumeID,
                                               java.lang.String name,
                                               Optional<java.lang.Long> newAccountID,
                                               Optional<java.lang.Long> newSize,
                                               Optional<java.lang.String> access,
                                               Optional<java.lang.Long> snapshotID,
                                               Optional<Attributes> attributes,
                                               Optional<java.lang.Boolean> enable512e,
                                               Optional<java.lang.Boolean> enableSnapMirrorReplication)

Method Detail

getVolumeID

public java.lang.Long getVolumeID()

VolumeID for the volume to be cloned.

setVolumeID

public void setVolumeID(java.lang.Long volumeID)

getName

public java.lang.String getName()

The name of the new cloned volume. Must be 1 to 64 characters in length.

setName

public void setName(java.lang.String name)

getNewAccountID

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

AccountID for the owner of the new volume. If unspecified, the accountID of the owner of the volume being cloned is used.

setNewAccountID

public void setNewAccountID(Optional<java.lang.Long> newAccountID)

getNewSize

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

New size of the volume, in bytes. Must be greater or less than the size of the volume being cloned. If unspecified, the volume size is not changed. Size is rounded to the nearest 1MB.

setNewSize

public void setNewSize(Optional<java.lang.Long> newSize)

getAccess

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

Specifies the level of access allowed for the new volume. If unspecified, the level of access of the volume being cloned is used. If replicationTarget is is passed and the volume is not paired, the access gets set to locked.

setAccess

public void setAccess(Optional<java.lang.String> access)

getSnapshotID

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

ID of the snapshot that is used as the source of the clone. If no ID is provided, the current active volume is used.

setSnapshotID

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

getAttributes

public Optional<Attributes> getAttributes()

List of name-value pairs in JSON object format.

setAttributes

public void setAttributes(Optional<Attributes> attributes)

getEnable512e

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

Specifies whether the new volume should use 512-byte sector emulation. If unspecified, the setting of the volume being cloned is used.

setEnable512e

public void setEnable512e(Optional<java.lang.Boolean> enable512e)

getEnableSnapMirrorReplication

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

Specifies whether SnapMirror replication is enabled or not. Defaults to false.

setEnableSnapMirrorReplication

public void setEnableSnapMirrorReplication(Optional<java.lang.Boolean> enableSnapMirrorReplication)

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

asBuilder

public final CloneVolumeRequest.Builder asBuilder()