@Generated(value="OracleSDKGenerator", comments="API Version: 20160918") public final class Volume extends Object
A detachable block volume device that allows you to dynamically expand the storage capacity of an instance. For more information, see Overview of Cloud Volume Storage.
To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see [Getting Started with Policies](https://docs.cloud.oracle.com/Content/Identity/Concepts/policygetstarted.htm).
*Warning:** Oracle recommends that you avoid using any confidential information when you
supply string values using the API.
Note: Objects should always be created or deserialized using the Volume.Builder. This model distinguishes fields
that are null because they are unset from fields that are explicitly set to null. This is done in
the setter methods of the Volume.Builder, which maintain a set of all explicitly set fields called
__explicitlySet__. The hashCode() and equals(Object) methods are implemented to take
__explicitlySet__ into account. The constructor, on the other hand, does not set __explicitlySet__
(since the constructor cannot distinguish explicit null from unset null).
| Modifier and Type | Class and Description |
|---|---|
static class |
Volume.Builder |
static class |
Volume.LifecycleState
The current state of a volume.
|
| Constructor and Description |
|---|
Volume(String availabilityDomain,
String compartmentId,
Map<String,Map<String,Object>> definedTags,
String displayName,
Map<String,String> freeformTags,
Map<String,Map<String,Object>> systemTags,
String id,
Boolean isHydrated,
String kmsKeyId,
Volume.LifecycleState lifecycleState,
Long vpusPerGB,
Long sizeInGBs,
Long sizeInMBs,
VolumeSourceDetails sourceDetails,
Date timeCreated,
String volumeGroupId,
Boolean isAutoTuneEnabled,
Long autoTunedVpusPerGB)
Deprecated.
|
| Modifier and Type | Method and Description |
|---|---|
static Volume.Builder |
builder()
Create a new builder.
|
boolean |
equals(Object o) |
Set<String> |
get__explicitlySet__() |
Long |
getAutoTunedVpusPerGB()
The number of Volume Performance Units per GB that this volume is effectively tuned to when it’s idle.
|
String |
getAvailabilityDomain()
The availability domain of the volume.
|
String |
getCompartmentId()
The OCID of the compartment that contains the volume.
|
Map<String,Map<String,Object>> |
getDefinedTags()
Defined tags for this resource.
|
String |
getDisplayName()
A user-friendly name.
|
Map<String,String> |
getFreeformTags()
Free-form tags for this resource.
|
String |
getId()
The OCID of the volume.
|
Boolean |
getIsAutoTuneEnabled()
Specifies whether the auto-tune performance is enabled for this volume.
|
Boolean |
getIsHydrated()
Specifies whether the cloned volume’s data has finished copying from the source volume or backup.
|
String |
getKmsKeyId()
The OCID of the Key Management key which is the master encryption key for the volume.
|
Volume.LifecycleState |
getLifecycleState()
The current state of a volume.
|
Long |
getSizeInGBs()
The size of the volume in GBs.
|
Long |
getSizeInMBs()
The size of the volume in MBs.
|
VolumeSourceDetails |
getSourceDetails() |
Map<String,Map<String,Object>> |
getSystemTags()
System tags for this resource.
|
Date |
getTimeCreated()
The date and time the volume was created.
|
String |
getVolumeGroupId()
The OCID of the source volume group.
|
Long |
getVpusPerGB()
The number of volume performance units (VPUs) that will be applied to this volume per GB,
representing the Block Volume service’s elastic performance options.
|
int |
hashCode() |
Volume.Builder |
toBuilder() |
String |
toString() |
@ConstructorProperties(value={"availabilityDomain","compartmentId","definedTags","displayName","freeformTags","systemTags","id","isHydrated","kmsKeyId","lifecycleState","vpusPerGB","sizeInGBs","sizeInMBs","sourceDetails","timeCreated","volumeGroupId","isAutoTuneEnabled","autoTunedVpusPerGB"}) @Deprecated public Volume(String availabilityDomain, String compartmentId, Map<String,Map<String,Object>> definedTags, String displayName, Map<String,String> freeformTags, Map<String,Map<String,Object>> systemTags, String id, Boolean isHydrated, String kmsKeyId, Volume.LifecycleState lifecycleState, Long vpusPerGB, Long sizeInGBs, Long sizeInMBs, VolumeSourceDetails sourceDetails, Date timeCreated, String volumeGroupId, Boolean isAutoTuneEnabled, Long autoTunedVpusPerGB)
public static Volume.Builder builder()
Create a new builder.
public Volume.Builder toBuilder()
public String getAvailabilityDomain()
The availability domain of the volume.
Example: `Uocm:PHX-AD-1`
public String getCompartmentId()
The OCID of the compartment that contains the volume.
public Map<String,Map<String,Object>> getDefinedTags()
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
Example: `{\"Operations\": {\"CostCenter\": \"42\"}}`
public String getDisplayName()
A user-friendly name. Does not have to be unique, and it’s changeable. Avoid entering confidential information.
public Map<String,String> getFreeformTags()
Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags.
Example: `{\"Department\": \"Finance\"}`
public Map<String,Map<String,Object>> getSystemTags()
System tags for this resource. Each key is predefined and scoped to a namespace.
Example: {\"foo-namespace\": {\"bar-key\": \"value\"}}
public String getId()
The OCID of the volume.
public Boolean getIsHydrated()
Specifies whether the cloned volume’s data has finished copying from the source volume or backup.
public String getKmsKeyId()
The OCID of the Key Management key which is the master encryption key for the volume.
public Volume.LifecycleState getLifecycleState()
The current state of a volume.
public Long getVpusPerGB()
The number of volume performance units (VPUs) that will be applied to this volume per GB, representing the Block Volume service’s elastic performance options. See Block Volume Elastic Performance for more information.
Allowed values:
`0`: Represents Lower Cost option.
`10`: Represents Balanced option.
`20`: Represents Higher Performance option.
public Long getSizeInGBs()
The size of the volume in GBs.
public Long getSizeInMBs()
The size of the volume in MBs. This field is deprecated. Use sizeInGBs instead.
public VolumeSourceDetails getSourceDetails()
public Date getTimeCreated()
The date and time the volume was created. Format defined by RFC3339.
public String getVolumeGroupId()
The OCID of the source volume group.
public Boolean getIsAutoTuneEnabled()
Specifies whether the auto-tune performance is enabled for this volume.
public Long getAutoTunedVpusPerGB()
The number of Volume Performance Units per GB that this volume is effectively tuned to when it’s idle.
Copyright © 2016–2021. All rights reserved.