com.solidfire.element.api

Class CreateVolumeRequest

java.lang.Object

com.solidfire.element.api.CreateVolumeRequest

All Implemented Interfaces:

java.io.Serializable

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

CreateVolumeRequest CreateVolume enables you to create a new (empty) volume on the cluster. As soon as the volume creation is complete, the volume is available for connection via iSCSI.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CreateVolumeRequest.Builder

Field Summary

Fields

Modifier and Type	Field and Description
static long	serialVersionUID

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
CreateVolumeRequest.Builder	asBuilder()
static CreateVolumeRequest.Builder	builder()
boolean	equals(java.lang.Object o)
Optional<java.lang.String>	getAccess() The access mode for the volume.
java.lang.Long	getAccountID() AccountID for the owner of this volume.
Optional<java.lang.Boolean>	getAssociateWithQoSPolicy() Associate the volume with the specified QoS policy.
Optional<Attributes>	getAttributes() The list of name-value pairs in JSON object format.
Optional<java.lang.Boolean>	getEnable512e() Specifies whether 512e emulation is enabled or not.
Optional<java.lang.Boolean>	getEnableSnapMirrorReplication() Specifies whether SnapMirror replication is enabled or not.
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.
java.lang.String	getName() The name of the volume access group (might be user specified).
Optional<java.lang.String>	getProtectionScheme() Protection scheme that should be used for this volume.
Optional<QoS>	getQos() Initial quality of service settings for this volume.
Optional<java.lang.Long>	getQosPolicyID() The ID for the policy whose QoS settings should be applied to the specified volumes.
java.lang.Long	getTotalSize() Total size of the volume, in bytes.
int	hashCode()
void	setAccess(Optional<java.lang.String> access)
void	setAccountID(java.lang.Long accountID)
void	setAssociateWithQoSPolicy(Optional<java.lang.Boolean> associateWithQoSPolicy)
void	setAttributes(Optional<Attributes> attributes)
void	setEnable512e(Optional<java.lang.Boolean> enable512e)
void	setEnableSnapMirrorReplication(Optional<java.lang.Boolean> enableSnapMirrorReplication)
void	setFifoSize(Optional<java.lang.Long> fifoSize)
void	setMinFifoSize(Optional<java.lang.Long> minFifoSize)
void	setName(java.lang.String name)
void	setProtectionScheme(Optional<java.lang.String> protectionScheme)
void	setQos(Optional<QoS> qos)
void	setQosPolicyID(Optional<java.lang.Long> qosPolicyID)
void	setTotalSize(java.lang.Long totalSize)
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

CreateVolumeRequest

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

CreateVolumeRequest

@Since(value="7.0")
public CreateVolumeRequest(java.lang.String name,
                                               java.lang.Long accountID,
                                               java.lang.Long totalSize,
                                               Optional<java.lang.Boolean> enable512e,
                                               Optional<QoS> qos,
                                               Optional<Attributes> attributes,
                                               Optional<java.lang.String> protectionScheme)

CreateVolumeRequest

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

CreateVolumeRequest

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

Method Detail

getName

public java.lang.String getName()

The name of the volume access group (might be user specified). Not required to be unique, but recommended. Might be 1 to 64 characters in length.

setName

public void setName(java.lang.String name)

getAccountID

public java.lang.Long getAccountID()

AccountID for the owner of this volume.

setAccountID

public void setAccountID(java.lang.Long accountID)

getTotalSize

public java.lang.Long getTotalSize()

Total size of the volume, in bytes. Size is rounded up to the nearest 1MB size.

setTotalSize

public void setTotalSize(java.lang.Long totalSize)

getEnable512e

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

Specifies whether 512e emulation is enabled or not. Possible values are: true: The volume provides 512-byte sector emulation. false: 512e emulation is not enabled.

setEnable512e

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

getQos

public Optional<QoS> getQos()

Initial quality of service settings for this volume. Default values are used if none are specified. Valid settings are: minIOPS maxIOPS burstIOPS You can get the default values for a volume by using the GetDefaultQoS method.

setQos

public void setQos(Optional<QoS> qos)

getAttributes

public Optional<Attributes> getAttributes()

The list of name-value pairs in JSON object format. Total attribute size must be less than 1000B, or 1KB, including JSON formatting characters.

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)

getAccess

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

The access mode for the volume. Only snapMirrorTarget is allowed.

setAccess

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

getEnableSnapMirrorReplication

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

Specifies whether SnapMirror replication is enabled or not.

setEnableSnapMirrorReplication

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

getQosPolicyID

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

The ID for the policy whose QoS settings should be applied to the specified volumes. This parameter is mutually exclusive with the qos parameter.

setQosPolicyID

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

getProtectionScheme

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

Protection scheme that should be used for this volume. The default value is the defaultProtectionScheme stored in the ClusterInfo object.

setProtectionScheme

public void setProtectionScheme(Optional<java.lang.String> protectionScheme)

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. If unspecified, a default value of 24 will be used.

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. If unspecified, a default value of 0 will be used.

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

asBuilder

public final CreateVolumeRequest.Builder asBuilder()