com.solidfire.element.api

Class ModifyVolumeRequest

java.lang.Object

com.solidfire.element.api.ModifyVolumeRequest

All Implemented Interfaces:

java.io.Serializable

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

ModifyVolumeRequest ModifyVolume enables you to modify settings on an existing volume. You can make modifications to one volume at a time and changes take place immediately. If you do not specify QoS values when you modify a volume, they remain the same as before the modification. You can retrieve default QoS values for a newly created volume by running the GetDefaultQoS method. When you need to increase the size of a volume that is being replicated, do so in the following order to prevent replication errors: 1. Increase the size of the "Replication Target" volume. 2. Increase the size of the source or "Read / Write" volume. Both the target and source volumes must be of the same size. Note: If you change the "access" status to locked or target, all existing iSCSI connections are terminated.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ModifyVolumeRequest.Builder

Field Summary

Fields

Modifier and Type	Field and Description
static long	serialVersionUID

Constructor Summary

Constructors

Constructor and Description
ModifyVolumeRequest()
ModifyVolumeRequest(java.lang.Long volumeID, Optional<java.lang.Long> accountID, Optional<java.lang.String> access, Optional<QoS> qos, Optional<java.lang.Long> totalSize, Optional<Attributes> attributes)
ModifyVolumeRequest(java.lang.Long volumeID, Optional<java.lang.Long> accountID, Optional<java.lang.String> access, Optional<QoS> qos, Optional<java.lang.Long> totalSize, Optional<Attributes> attributes, Optional<java.lang.Boolean> associateWithQoSPolicy, Optional<java.lang.Long> qosPolicyID, Optional<java.lang.Boolean> enableSnapMirrorReplication)
ModifyVolumeRequest(java.lang.Long volumeID, Optional<java.lang.Long> accountID, Optional<java.lang.String> access, Optional<QoS> qos, Optional<java.lang.Long> totalSize, Optional<Attributes> attributes, Optional<java.lang.Boolean> associateWithQoSPolicy, Optional<java.lang.Long> qosPolicyID, Optional<java.lang.Boolean> enableSnapMirrorReplication, Optional<java.lang.Long> fifoSize, Optional<java.lang.Long> minFifoSize)

Method Summary

Modifier and Type	Method and Description
ModifyVolumeRequest.Builder	asBuilder()
static ModifyVolumeRequest.Builder	builder()
boolean	equals(java.lang.Object o)
Optional<java.lang.String>	getAccess() Specifies the access allowed for the volume.
Optional<java.lang.Long>	getAccountID() AccountID to which the volume is reassigned.
Optional<java.lang.Boolean>	getAssociateWithQoSPolicy() Associate the volume with the specified QoS policy.
Optional<Attributes>	getAttributes() List of name-value pairs in JSON object format.
Optional<java.lang.Boolean>	getEnableSnapMirrorReplication() Determines whether the volume can be used for replication with SnapMirror endpoints.
Optional<java.lang.Long>	getFifoSize() Specifies the maximum number of FIFO (First-In-First-Out) snapshots supported by the volume.
Optional<java.lang.Long>	getMinFifoSize() Specifies the number of snapshot slots that are reserved for only FIFO (First-In-First-Out) snapshots.
Optional<QoS>	getQos() New QoS settings for this volume.
Optional<java.lang.Long>	getQosPolicyID() The ID for the policy whose QoS settings should be applied to the specified volumes.
Optional<java.lang.Long>	getTotalSize() New size of the volume in bytes.
java.lang.Long	getVolumeID() VolumeID for the volume to be modified.
int	hashCode()
void	setAccess(Optional<java.lang.String> access)
void	setAccountID(Optional<java.lang.Long> accountID)
void	setAssociateWithQoSPolicy(Optional<java.lang.Boolean> associateWithQoSPolicy)
void	setAttributes(Optional<Attributes> attributes)
void	setEnableSnapMirrorReplication(Optional<java.lang.Boolean> enableSnapMirrorReplication)
void	setFifoSize(Optional<java.lang.Long> fifoSize)
void	setMinFifoSize(Optional<java.lang.Long> minFifoSize)
void	setQos(Optional<QoS> qos)
void	setQosPolicyID(Optional<java.lang.Long> qosPolicyID)
void	setTotalSize(Optional<java.lang.Long> totalSize)
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

ModifyVolumeRequest

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

ModifyVolumeRequest

@Since(value="7.0")
public ModifyVolumeRequest(java.lang.Long volumeID,
                                               Optional<java.lang.Long> accountID,
                                               Optional<java.lang.String> access,
                                               Optional<QoS> qos,
                                               Optional<java.lang.Long> totalSize,
                                               Optional<Attributes> attributes)

ModifyVolumeRequest

@Since(value="10.0")
public ModifyVolumeRequest(java.lang.Long volumeID,
                                                Optional<java.lang.Long> accountID,
                                                Optional<java.lang.String> access,
                                                Optional<QoS> qos,
                                                Optional<java.lang.Long> totalSize,
                                                Optional<Attributes> attributes,
                                                Optional<java.lang.Boolean> associateWithQoSPolicy,
                                                Optional<java.lang.Long> qosPolicyID,
                                                Optional<java.lang.Boolean> enableSnapMirrorReplication)

ModifyVolumeRequest

@Since(value="12.0")
public ModifyVolumeRequest(java.lang.Long volumeID,
                                                Optional<java.lang.Long> accountID,
                                                Optional<java.lang.String> access,
                                                Optional<QoS> qos,
                                                Optional<java.lang.Long> totalSize,
                                                Optional<Attributes> attributes,
                                                Optional<java.lang.Boolean> associateWithQoSPolicy,
                                                Optional<java.lang.Long> qosPolicyID,
                                                Optional<java.lang.Boolean> enableSnapMirrorReplication,
                                                Optional<java.lang.Long> fifoSize,
                                                Optional<java.lang.Long> minFifoSize)

Method Detail

getVolumeID

public java.lang.Long getVolumeID()

VolumeID for the volume to be modified.

setVolumeID

public void setVolumeID(java.lang.Long volumeID)

getAccountID

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

AccountID to which the volume is reassigned. If unspecified, the previous account name is used.

setAccountID

public void setAccountID(Optional<java.lang.Long> accountID)

getAccess

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

Specifies the access allowed for the volume. Possible values are: readOnly: Only read operations are allowed. readWrite: Reads and writes are allowed. locked: No reads or writes are allowed. If not specified, the access value does not change. replicationTarget: Identify a volume as the target volume for a paired set of volumes. If the volume is not paired, the access status is locked. If a value is not specified, the access value does not change.

setAccess

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

getQos

public Optional<QoS> getQos()

New QoS settings for this volume. If not specified, the QoS settings are not changed.

setQos

public void setQos(Optional<QoS> qos)

getTotalSize

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

New size of the volume in bytes. 1000000000 is equal to 1GB. Size is rounded up to the nearest 1MB. This parameter can only be used to increase the size of a volume.

setTotalSize

public void setTotalSize(Optional<java.lang.Long> totalSize)

getAttributes

public Optional<Attributes> getAttributes()

List of name-value pairs in JSON object format.

setAttributes

public void setAttributes(Optional<Attributes> attributes)

getAssociateWithQoSPolicy

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

Associate the volume with the specified QoS policy. Possible values: true: Associate the volume with the QoS policy specified in the QoSPolicyID parameter. false: Do not assosciate the volume with the QoS policy specified in the QoSPolicyID parameter. When false, any existing policy association is removed regardless of whether you specify a QoS policy in the QoSPolicyID parameter.

setAssociateWithQoSPolicy

public void setAssociateWithQoSPolicy(Optional<java.lang.Boolean> associateWithQoSPolicy)

getQosPolicyID

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

The ID for the policy whose QoS settings should be applied to the specified volumes. The volume will not maintain any association with the policy; this is an alternate way to apply QoS settings to the volume. This parameter and the qos parameter cannot be specified at the same time.

setQosPolicyID

public void setQosPolicyID(Optional<java.lang.Long> qosPolicyID)

getEnableSnapMirrorReplication

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

Determines whether the volume can be used for replication with SnapMirror endpoints. Possible values: true false

setEnableSnapMirrorReplication

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

getFifoSize

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

Specifies the maximum number of FIFO (First-In-First-Out) snapshots supported by the volume. Note that FIFO and non-FIFO snapshots both use the same pool of available snapshot slots on a volume. Use this option to limit FIFO snapshot consumption of the available snapshot slots. Also note this cannot be modified such that it is less than the current FIFO snapshot count.

setFifoSize

public void setFifoSize(Optional<java.lang.Long> fifoSize)

getMinFifoSize

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

Specifies the number of snapshot slots that are reserved for only FIFO (First-In-First-Out) snapshots. Since FIFO and non-FIFO snapshots share the same pool, the minFifoSize reduces the total number of possible non-FIFO snapshots by the same amount. Note this cannot be modified such that it conflicts with the current non-FIFO snapshot count.

setMinFifoSize

public void setMinFifoSize(Optional<java.lang.Long> minFifoSize)

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

asBuilder

public final ModifyVolumeRequest.Builder asBuilder()