Package com.ibm.cloud.is.vpc.v1.model
Class Volume
- java.lang.Object
-
- com.ibm.cloud.sdk.core.service.model.GenericModel
-
- com.ibm.cloud.is.vpc.v1.model.Volume
-
- All Implemented Interfaces:
com.ibm.cloud.sdk.core.service.model.ObjectModel
public class Volume extends com.ibm.cloud.sdk.core.service.model.GenericModel
Volume.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
Volume.AdjustableCapacityStates
The attachment state of the volume - `unattached`: Not attached to any virtual server instances - `attached`: Attached to a virtual server instance (even if the instance is stopped) - `unusable`: Not able to be attached to any virtual server instances.static interface
Volume.AdjustableIopsStates
The attachment state of the volume - `unattached`: Not attached to any virtual server instances - `attached`: Attached to a virtual server instance (even if the instance is stopped) - `unusable`: Not able to be attached to any virtual server instances.static interface
Volume.AttachmentState
The attachment state of the volume - `unattached`: Not attached to any virtual server instances - `attached`: Attached to a virtual server instance (even if the instance is stopped) - `unusable`: Not able to be attached to any virtual server instances.static interface
Volume.Encryption
The type of encryption used on the volume.static interface
Volume.HealthState
The health of this resource: - `ok`: No abnormal behavior detected - `degraded`: Experiencing compromised performance, capacity, or connectivity - `faulted`: Completely unreachable, inoperative, or otherwise entirely incapacitated - `inapplicable`: The health state does not apply because of the current lifecycle state.static interface
Volume.ResourceType
The resource type.static interface
Volume.Status
The status of the volume.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description List<String>
getAdjustableCapacityStates()
Gets the adjustableCapacityStates.List<String>
getAdjustableIopsStates()
Gets the adjustableIopsStates.String
getAttachmentState()
Gets the attachmentState.Long
getBandwidth()
Gets the bandwidth.Long
getCapacity()
Gets the capacity.VolumeCatalogOffering
getCatalogOffering()
Gets the catalogOffering.Date
getCreatedAt()
Gets the createdAt.String
getCrn()
Gets the crn.String
getEncryption()
Gets the encryption.EncryptionKeyReference
getEncryptionKey()
Gets the encryptionKey.List<VolumeHealthReason>
getHealthReasons()
Gets the healthReasons.String
getHealthState()
Gets the healthState.String
getHref()
Gets the href.String
getId()
Gets the id.Long
getIops()
Gets the iops.String
getName()
Gets the name.OperatingSystem
getOperatingSystem()
Gets the operatingSystem.VolumeProfileReference
getProfile()
Gets the profile.ResourceGroupReference
getResourceGroup()
Gets the resourceGroup.String
getResourceType()
Gets the resourceType.ImageReference
getSourceImage()
Gets the sourceImage.SnapshotReference
getSourceSnapshot()
Gets the sourceSnapshot.String
getStatus()
Gets the status.List<VolumeStatusReason>
getStatusReasons()
Gets the statusReasons.List<String>
getUserTags()
Gets the userTags.List<VolumeAttachmentReferenceVolumeContext>
getVolumeAttachments()
Gets the volumeAttachments.ZoneReference
getZone()
Gets the zone.Boolean
isActive()
Gets the active.Boolean
isBusy()
Gets the busy.
-
-
-
Method Detail
-
isActive
public Boolean isActive()
Gets the active. Indicates whether a running virtual server instance has an attachment to this volume.- Returns:
- the active
-
getAdjustableCapacityStates
public List<String> getAdjustableCapacityStates()
Gets the adjustableCapacityStates. The attachment states that support adjustable capacity for this volume.- Returns:
- the adjustableCapacityStates
-
getAdjustableIopsStates
public List<String> getAdjustableIopsStates()
Gets the adjustableIopsStates. The attachment states that support adjustable IOPS for this volume.- Returns:
- the adjustableIopsStates
-
getAttachmentState
public String getAttachmentState()
Gets the attachmentState. The attachment state of the volume - `unattached`: Not attached to any virtual server instances - `attached`: Attached to a virtual server instance (even if the instance is stopped) - `unusable`: Not able to be attached to any virtual server instances.- Returns:
- the attachmentState
-
getBandwidth
public Long getBandwidth()
Gets the bandwidth. The maximum bandwidth (in megabits per second) for the volume.- Returns:
- the bandwidth
-
isBusy
public Boolean isBusy()
Gets the busy. Indicates whether this volume is performing an operation that must be serialized. This must be `false` to perform an operation that is specified to require serialization.- Returns:
- the busy
-
getCapacity
public Long getCapacity()
Gets the capacity. The capacity to use for the volume (in gigabytes). The minimum and maximum limits for this property may [expand](https://cloud.ibm.com/apidocs/vpc#property-value-expansion) in the future.- Returns:
- the capacity
-
getCatalogOffering
public VolumeCatalogOffering getCatalogOffering()
Gets the catalogOffering. The [catalog](https://cloud.ibm.com/docs/account?topic=account-restrict-by-user) offering this volume was created from. If a virtual server instance is provisioned with a `boot_volume_attachment` specifying this volume, the virtual server instance will use this volume's catalog offering, including its pricing plan. If absent, this volume was not created from a catalog offering.- Returns:
- the catalogOffering
-
getCreatedAt
public Date getCreatedAt()
Gets the createdAt. The date and time that the volume was created.- Returns:
- the createdAt
-
getCrn
public String getCrn()
Gets the crn. The CRN for this volume.- Returns:
- the crn
-
getEncryption
public String getEncryption()
Gets the encryption. The type of encryption used on the volume.- Returns:
- the encryption
-
getEncryptionKey
public EncryptionKeyReference getEncryptionKey()
Gets the encryptionKey. The root key used to wrap the data encryption key for the volume. This property will be present for volumes with an `encryption` type of `user_managed`.- Returns:
- the encryptionKey
-
getHealthReasons
public List<VolumeHealthReason> getHealthReasons()
Gets the healthReasons. The reasons for the current `health_state` (if any).- Returns:
- the healthReasons
-
getHealthState
public String getHealthState()
Gets the healthState. The health of this resource: - `ok`: No abnormal behavior detected - `degraded`: Experiencing compromised performance, capacity, or connectivity - `faulted`: Completely unreachable, inoperative, or otherwise entirely incapacitated - `inapplicable`: The health state does not apply because of the current lifecycle state. A resource with a lifecycle state of `failed` or `deleting` will have a health state of `inapplicable`. A `pending` resource may also have this state.- Returns:
- the healthState
-
getHref
public String getHref()
Gets the href. The URL for this volume.- Returns:
- the href
-
getId
public String getId()
Gets the id. The unique identifier for this volume.- Returns:
- the id
-
getIops
public Long getIops()
Gets the iops. The maximum I/O operations per second (IOPS) for this volume.- Returns:
- the iops
-
getName
public String getName()
Gets the name. The name for this volume. The name is unique across all volumes in the region.- Returns:
- the name
-
getOperatingSystem
public OperatingSystem getOperatingSystem()
Gets the operatingSystem. The operating system associated with this volume. If absent, this volume was not created from an image, or the image did not include an operating system.- Returns:
- the operatingSystem
-
getProfile
public VolumeProfileReference getProfile()
Gets the profile. The [profile](https://cloud.ibm.com/docs/vpc?topic=vpc-block-storage-profiles) for this volume.- Returns:
- the profile
-
getResourceGroup
public ResourceGroupReference getResourceGroup()
Gets the resourceGroup. The resource group for this volume.- Returns:
- the resourceGroup
-
getResourceType
public String getResourceType()
Gets the resourceType. The resource type.- Returns:
- the resourceType
-
getSourceImage
public ImageReference getSourceImage()
Gets the sourceImage. The image from which this volume was created (this may be [deleted](https://cloud.ibm.com/apidocs/vpc#deleted-resources)). If absent, this volume was not created from an image.- Returns:
- the sourceImage
-
getSourceSnapshot
public SnapshotReference getSourceSnapshot()
Gets the sourceSnapshot. The snapshot from which this volume was cloned.- Returns:
- the sourceSnapshot
-
getStatus
public String getStatus()
Gets the status. The status of the volume. The enumerated values for this property may [expand](https://cloud.ibm.com/apidocs/vpc#property-value-expansion) in the future.- Returns:
- the status
-
getStatusReasons
public List<VolumeStatusReason> getStatusReasons()
Gets the statusReasons. The reasons for the current status (if any).- Returns:
- the statusReasons
-
getUserTags
public List<String> getUserTags()
Gets the userTags. The [user tags](https://cloud.ibm.com/apidocs/tagging#types-of-tags) associated with this volume.- Returns:
- the userTags
-
getVolumeAttachments
public List<VolumeAttachmentReferenceVolumeContext> getVolumeAttachments()
Gets the volumeAttachments. The volume attachments for this volume.- Returns:
- the volumeAttachments
-
getZone
public ZoneReference getZone()
Gets the zone. The zone this volume resides in.- Returns:
- the zone
-
-