Package com.morpheusdata.model

Class StorageVolume

java.lang.Object
com.morpheusdata.model.MorpheusModel
com.morpheusdata.model.projection.MorpheusIdentityModel
com.morpheusdata.model.projection.StorageVolumeIdentityProjection
com.morpheusdata.model.StorageVolume
All Implemented Interfaces:
Serializable
public class StorageVolume extends StorageVolumeIdentityProjection
Representation of a Morpheus StorageVolume database object within the Morpheus platform. Not all data is provided in this implementation that is available in the morpheus core platform for security purposes and internal use.
See Also:

  • Field Details

    • account

      protected Account account

    • cloudId

      protected Long cloudId

    • description

      protected String description

    • deviceName

      protected String deviceName

    • deviceDisplayName

      protected String deviceDisplayName

    • maxStorage

      protected Long maxStorage

    • usedStorage

      protected Long usedStorage

    • type

      protected StorageVolumeType type

    • displayOrder

      protected Integer displayOrder

    • rootVolume

      protected Boolean rootVolume

    • unitNumber

      protected String unitNumber

    • datastore

      protected DatastoreIdentity datastore

    • maxIOPS

      protected Integer maxIOPS

    • removable

      protected Boolean removable

    • diskIndex

      protected Integer diskIndex

    • uniqueId

      protected String uniqueId

    • datastoreOption

      protected String datastoreOption

    • controller

      protected StorageControllerIdentityProjection controller

    • controllerKey

      protected String controllerKey

    • snapshots

      protected List<SnapshotIdentityProjection> snapshots

    • refType

      protected String refType

    • refId

      protected Long refId

    • regionCode

      protected String regionCode

    • status

      protected String status

    • sourceSnapshotId

      protected String sourceSnapshotId

    • poolName

      protected String poolName

    • volumeName

      protected String volumeName

    • storageServer

      protected StorageServer storageServer

    • storageGroup

      protected StorageGroup storageGroup

    • volumeType

      protected String volumeType

    • volumePath

      protected String volumePath

    • diskType

      protected String diskType

    • StatusMessage

      protected String StatusMessage

    • sourceId

      protected String sourceId

    • active

      protected Boolean active

    • resizeable

      protected Boolean resizeable

    • planResizable

      protected Boolean planResizable

    • readOnly

      protected Boolean readOnly

    • online

      protected Boolean online

    • isExported

      protected Boolean isExported

    • isAssigned

      protected Boolean isAssigned

    • provisionType

      protected String provisionType

    • copyType

      protected String copyType

    • fiberWwn

      protected String fiberWwn

    • imageType

      protected String imageType

    • sourceImage

      protected String sourceImage

    • fileName

      protected String fileName

    • claimName

      protected String claimName

    • sharePath

      protected String sharePath

    • diskMode

      protected String diskMode

    • wwn

      protected String wwn

    • createForMultiAttach

      protected Boolean createForMultiAttach

    • activeReplica

      protected Boolean activeReplica

    • definitionId

      protected String definitionId
      An identifier for volumes sharing the same role across servers in an instance.

      Used as a fallback for reconfigure volume comparison when volumes have no inherent information that ties them together. Core automatically supplies a definitionId during provisioning or reconfigure, but manual assignment is required for volumes added to a ComputeServer out of band.

      For example: 

       - Instance
   - Server A
     - Volumes
       - deviceDisplayName: data1-a89f6, definitionId: 'application-storage'
   - Server B
     - Volumes
       - deviceDisplayName: data1-beb17, definitionId: 'application-storage'
      In this case, even though their volume names are different on the array, we can still treat these volumes as in the same "role" when attempting to reconfigure their size or datastore at the instance level.

    • memberOfAggregate

      protected StorageAggregate memberOfAggregate
      The storage aggregate this volume is a member of (i.e., part of its physical storage pool).

      For example, in a RAID array, the volume would be a member disk; in ZFS, a vdev in the zpool. A volume can only be a member of one aggregate.

    • exposedByAggregate

      protected StorageAggregate exposedByAggregate
      The storage aggregate that exposes/provides this volume.

      This is the aggregate that makes this volume available for use. A volume can only be exposed by one aggregate.

    • isMultiAttach

      protected Boolean isMultiAttach
      Indicates whether this volume supports attachment to multiple hosts simultaneously

  • Constructor Details

    • StorageVolume

      public StorageVolume()

  • Method Details

    • getAccount

      public Account getAccount()

    • getCloud

      public Long getCloud()

    • setDeviceName

      public void setDeviceName(String deviceName)

    • getDeviceName

      public String getDeviceName()

    • setMaxStorage

      public void setMaxStorage(Long maxStorage)

    • getMaxStorage

      public Long getMaxStorage()

    • setUsedStorage

      public void setUsedStorage(Long usedStorage)

    • getUsedStorage

      public Long getUsedStorage()

    • setType

      public void setType(StorageVolumeType type)

    • getType

      public StorageVolumeType getType()

    • getDisplayOrder

      public Integer getDisplayOrder()
      The display order of the disk in the user interface when displayed with other related disks for a ComputeServer, VirtualImage, or VirtualImageLocation
      Returns:
      displayOrder

    • setDisplayOrder

      public void setDisplayOrder(Integer displayOrder)
      The display order of the disk in the user interface when displayed with other related disks for a ComputeServer, VirtualImage, or VirtualImageLocation
      Parameters:
      displayOrder - displayOrder

    • getRootVolume

      public Boolean getRootVolume()
      Represents if this StorageVolume is a root volume
      Returns:
      rootVolume

    • setRootVolume

      public void setRootVolume(Boolean rootVolume)
      Represents if this StorageVolume is a root volume
      Parameters:
      rootVolume - rootVolume

    • getUnitNumber

      public String getUnitNumber()
      The unit number
      Returns:
      unitNumber

    • setUnitNumber

      public void setUnitNumber(String unitNumber)
      The unit number
      Parameters:
      unitNumber - unitNumber

    • getDatastore

      public DatastoreIdentity getDatastore()
      The Datastore associated with this StorageVolume
      Returns:
      datastore

    • setDatastore

      public void setDatastore(DatastoreIdentity datastore)
      The Datastore associated with this StorageVolume
      Parameters:
      datastore - datastore

    • getMaxIOPS

      public Integer getMaxIOPS()

    • setMaxIOPS

      public void setMaxIOPS(Integer maxIOPS)

    • getRemovable

      public Boolean getRemovable()
      Indicates if the disk is able to be removed
      Returns:
      removable

    • setRemovable

      public void setRemovable(Boolean removable)
      Indicates if the disk is able to be removed
      Parameters:
      removable - removable

    • getDiskIndex

      public Integer getDiskIndex()
      Utilized during creation to set logical defaults for deviceName and deviceDisplayName if they are null. Not stored in Morpheus or returned For example: 0 may result in a diskName of sda
      Returns:
      diskIndex diskIndex

    • setDiskIndex

      public void setDiskIndex(Integer diskIndex)
      Utilized during creation to set logical defaults for deviceName and deviceDisplayName if they are null. Not stored in Morpheus or returned For example: 0 may result in a diskName of sda
      Parameters:
      diskIndex - diskIndex

    • setUniqueId

      public void setUniqueId(String uniqueId)
      A unique identifier. Not controlled by Morpheus.
      Overrides:
      setUniqueId in class StorageVolumeIdentityProjection
      Parameters:
      uniqueId -

    • getUniqueId

      public String getUniqueId()
      Get the unique identifier. Not controlled by Morpheus.
      Overrides:
      getUniqueId in class StorageVolumeIdentityProjection
      Returns:
      uniqueId

    • getController

      public StorageControllerIdentityProjection getController()

    • setController

      public void setController(StorageControllerIdentityProjection controller)

    • getSnapshots

      public List<SnapshotIdentityProjection> getSnapshots()

    • setSnapshots

      public void setSnapshots(List<SnapshotIdentityProjection> snapshots)
      NOTE: To modify the list of snapshots associated with this StorageVolume, utilize MorpheusSnapshotService
      Parameters:
      snapshots -

    • getDatastoreOption

      public String getDatastoreOption()

    • setDatastoreOption

      public void setDatastoreOption(String datastoreOption)

    • getControllerKey

      public String getControllerKey()

    • setControllerKey

      public void setControllerKey(String controllerKey)

    • getDeviceDisplayName

      public String getDeviceDisplayName()

    • setDeviceDisplayName

      public void setDeviceDisplayName(String deviceDisplayName)

    • getRefType

      public String getRefType()

    • setRefType

      public void setRefType(String refType)

    • getRefId

      public Long getRefId()

    • setRefId

      public void setRefId(Long refId)

    • getRegionCode

      public String getRegionCode()

    • setRegionCode

      public void setRegionCode(String regionCode)

    • getStatus

      public String getStatus()

    • setStatus

      public void setStatus(String status)

    • getSourceSnapshotId

      public String getSourceSnapshotId()

    • setSourceSnapshotId

      public void setSourceSnapshotId(String sourceSnapshotId)

    • setAccount

      public void setAccount(Account account)

    • getCloudId

      public Long getCloudId()

    • setCloudId

      public void setCloudId(Long cloudId)

    • getStorageServer

      public StorageServer getStorageServer()

    • setStorageServer

      public void setStorageServer(StorageServer storageServer)

    • getStorageGroup

      public StorageGroup getStorageGroup()

    • setStorageGroup

      public void setStorageGroup(StorageGroup storageGroup)

    • getPoolName

      public String getPoolName()

    • setPoolName

      public void setPoolName(String poolName)

    • getVolumeName

      public String getVolumeName()

    • setVolumeName

      public void setVolumeName(String volumeName)

    • getDescription

      public String getDescription()

    • setDescription

      public void setDescription(String description)

    • getVolumeType

      public String getVolumeType()

    • setVolumeType

      public void setVolumeType(String volumeType)

    • getVolumePath

      public String getVolumePath()

    • setVolumePath

      public void setVolumePath(String volumePath)

    • getDiskType

      public String getDiskType()

    • setDiskType

      public void setDiskType(String diskType)

    • getStatusMessage

      public String getStatusMessage()

    • setStatusMessage

      public void setStatusMessage(String statusMessage)

    • getSourceId

      public String getSourceId()

    • setSourceId

      public void setSourceId(String sourceId)

    • getActive

      public Boolean getActive()

    • setActive

      public void setActive(Boolean active)

    • getResizeable

      public Boolean getResizeable()

    • setResizeable

      public void setResizeable(Boolean resizeable)

    • getPlanResizable

      public Boolean getPlanResizable()

    • setPlanResizable

      public void setPlanResizable(Boolean planResizable)

    • getReadOnly

      public Boolean getReadOnly()

    • setReadOnly

      public void setReadOnly(Boolean readOnly)

    • getOnline

      public Boolean getOnline()

    • setOnline

      public void setOnline(Boolean online)

    • getExported

      public Boolean getExported()

    • setExported

      public void setExported(Boolean exported)

    • getAssigned

      public Boolean getAssigned()

    • setAssigned

      public void setAssigned(Boolean assigned)

    • getProvisionType

      public String getProvisionType()

    • setProvisionType

      public void setProvisionType(String provisionType)

    • getCopyType

      public String getCopyType()

    • setCopyType

      public void setCopyType(String copyType)

    • getFiberWwn

      public String getFiberWwn()

    • setFiberWwn

      public void setFiberWwn(String fiberWwn)

    • getWwn

      public String getWwn()

    • setWwn

      public void setWwn(String wwn)

    • getImageType

      public String getImageType()

    • setImageType

      public void setImageType(String imageType)

    • getSourceImage

      public String getSourceImage()

    • setSourceImage

      public void setSourceImage(String sourceImage)

    • getFileName

      public String getFileName()

    • setFileName

      public void setFileName(String fileName)

    • getClaimName

      public String getClaimName()

    • setClaimName

      public void setClaimName(String claimName)

    • getSharePath

      public String getSharePath()

    • setSharePath

      public void setSharePath(String sharePath)

    • getDiskMode

      public String getDiskMode()

    • setDiskMode

      public void setDiskMode(String diskMode)

    • getCreateForMultiAttach

      public Boolean getCreateForMultiAttach()

    • setCreateForMultiAttach

      public void setCreateForMultiAttach(Boolean createForMultiAttach)

    • getActiveReplica

      public Boolean getActiveReplica()

    • setActiveReplica

      public void setActiveReplica(Boolean activeReplica)

    • getDefinitionId

      public String getDefinitionId()

    • setDefinitionId

      public void setDefinitionId(String definitionId)

    • getMemberOfAggregate

      public StorageAggregate getMemberOfAggregate()
      Gets the storage aggregate this volume is a member of (i.e., part of its physical storage pool).
      Returns:
      memberOfAggregate

    • setMemberOfAggregate

      public void setMemberOfAggregate(StorageAggregate memberOfAggregate)
      Sets the storage aggregate this volume is a member of.
      Parameters:
      memberOfAggregate - the aggregate this volume is a member of

    • getExposedByAggregate

      public StorageAggregate getExposedByAggregate()
      Gets the storage aggregate that exposes/provides this volume.
      Returns:
      exposedByAggregate

    • setExposedByAggregate

      public void setExposedByAggregate(StorageAggregate exposedByAggregate)
      Sets the storage aggregate that exposes/provides this volume.
      Parameters:
      exposedByAggregate - the aggregate that exposes this volume

    • getMultiAttach

      @Deprecated(since="1.3.0") public Boolean getMultiAttach()
      Deprecated.
      use getIsMultiAttach()
      Returns:
      true if this is multi attach; false otherwise

    • setMultiAttach

      @Deprecated(since="1.3.0") public void setMultiAttach(Boolean isMultiAttach)
      Deprecated.
      use setIsMultiAttach(Boolean)
      Sets whether this volume is multi attach
      Parameters:
      isMultiAttach - true if this volume is multi attach; false otherwise

    • getIsMultiAttach

      public Boolean getIsMultiAttach()
      Returns:
      true if this is multi attach; false otherwise

    • setIsMultiAttach

      public void setIsMultiAttach(Boolean isMultiAttach)
      Sets whether this volume is multi attach
      Parameters:
      isMultiAttach - true if this volume is multi attach; false otherwise