@Generated(value="OracleSDKGenerator",
comments="API Version: 20160918")
public final class Volume
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
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/iaas/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 Volume.Builder.__explicitlySet__. The hashCode() and equals(Object) methods are implemented to take the explicitly set
fields into account. The constructor, on the other hand, does not take the explicitly set fields
into account (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.
|
EXPLICITLY_SET_FILTER_NAME, EXPLICITLY_SET_PROPERTY_NAME| 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,
String clusterPlacementGroupId,
Long sizeInGBs,
Long sizeInMBs,
VolumeSourceDetails sourceDetails,
Date timeCreated,
String volumeGroupId,
Boolean isAutoTuneEnabled,
Long autoTunedVpusPerGB,
List<BlockVolumeReplicaInfo> blockVolumeReplicas,
List<AutotunePolicy> autotunePolicies)
Deprecated.
|
| Modifier and Type | Method and Description |
|---|---|
static Volume.Builder |
builder()
Create a new builder.
|
boolean |
equals(Object o) |
Long |
getAutoTunedVpusPerGB()
The number of Volume Performance Units per GB that this volume is effectively tuned to.
|
List<AutotunePolicy> |
getAutotunePolicies()
The list of autotune policies enabled for this volume.
|
String |
getAvailabilityDomain()
The availability domain of the volume.
|
List<BlockVolumeReplicaInfo> |
getBlockVolumeReplicas()
The list of block volume replicas of this volume.
|
String |
getClusterPlacementGroupId()
The clusterPlacementGroup Id of the volume for volume placement.
|
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 Vault service 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() |
String |
toString(boolean includeByteArrayContents)
Return a string representation of the object.
|
markPropertyAsExplicitlySet, wasPropertyExplicitlySet@Deprecated @ConstructorProperties(value={"availabilityDomain","compartmentId","definedTags","displayName","freeformTags","systemTags","id","isHydrated","kmsKeyId","lifecycleState","vpusPerGB","clusterPlacementGroupId","sizeInGBs","sizeInMBs","sourceDetails","timeCreated","volumeGroupId","isAutoTuneEnabled","autoTunedVpusPerGB","blockVolumeReplicas","autotunePolicies"}) 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, String clusterPlacementGroupId, Long sizeInGBs, Long sizeInMBs, VolumeSourceDetails sourceDetails, Date timeCreated, String volumeGroupId, Boolean isAutoTuneEnabled, Long autoTunedVpusPerGB, List<BlockVolumeReplicaInfo> blockVolumeReplicas, List<AutotunePolicy> autotunePolicies)
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 Vault service 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 Performance Levels for more information.
Allowed values:
0: Represents Lower Cost option.
10: Represents Balanced option.
20: Represents Higher Performance option.
30-120: Represents the Ultra High Performance option.
For performance autotune enabled volumes, It would be the Default(Minimum) VPUs/GB.
public String getClusterPlacementGroupId()
The clusterPlacementGroup Id of the volume for volume placement.
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. This field is
deprecated. Use the DetachedVolumeAutotunePolicy instead to enable the volume for
detached autotune.
public Long getAutoTunedVpusPerGB()
The number of Volume Performance Units per GB that this volume is effectively tuned to.
public List<BlockVolumeReplicaInfo> getBlockVolumeReplicas()
The list of block volume replicas of this volume.
public List<AutotunePolicy> getAutotunePolicies()
The list of autotune policies enabled for this volume.
public String toString()
toString in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModelpublic String toString(boolean includeByteArrayContents)
Return a string representation of the object.
includeByteArrayContents - true to include the full contents of byte arrayspublic boolean equals(Object o)
equals in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModelpublic int hashCode()
hashCode in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModelCopyright © 2016–2024. All rights reserved.