@Generated(value="OracleSDKGenerator", comments="API Version: 20160918") public final class BootVolume extends Object
A detachable boot volume device that contains the image used to boot a Compute instance. For more information, see Overview of Boot Volumes.
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 BootVolume.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 BootVolume.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 |
BootVolume.Builder |
static class |
BootVolume.LifecycleState
The current state of a boot volume.
|
Constructor and Description |
---|
BootVolume(String availabilityDomain,
String compartmentId,
Map<String,Map<String,Object>> definedTags,
Map<String,Map<String,Object>> systemTags,
String displayName,
Map<String,String> freeformTags,
String id,
String imageId,
Boolean isHydrated,
Long vpusPerGB,
BootVolume.LifecycleState lifecycleState,
Long sizeInGBs,
Long sizeInMBs,
BootVolumeSourceDetails sourceDetails,
Date timeCreated,
String volumeGroupId,
String kmsKeyId,
Boolean isAutoTuneEnabled,
Long autoTunedVpusPerGB)
Deprecated.
|
Modifier and Type | Method and Description |
---|---|
static BootVolume.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 boot volume is effectively tuned to when it’s idle.
|
String |
getAvailabilityDomain()
The availability domain of the boot volume.
|
String |
getCompartmentId()
The OCID of the compartment that contains the boot 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 boot volume’s Oracle ID (OCID).
|
String |
getImageId()
The image OCID used to create the boot volume.
|
Boolean |
getIsAutoTuneEnabled()
Specifies whether the auto-tune performance is enabled for this boot volume.
|
Boolean |
getIsHydrated()
Specifies whether the boot volume’s data has finished copying
from the source boot volume or boot volume backup.
|
String |
getKmsKeyId()
The OCID of the Key Management master encryption key assigned to the boot volume.
|
BootVolume.LifecycleState |
getLifecycleState()
The current state of a boot volume.
|
Long |
getSizeInGBs()
The size of the boot volume in GBs.
|
Long |
getSizeInMBs()
The size of the volume in MBs.
|
BootVolumeSourceDetails |
getSourceDetails() |
Map<String,Map<String,Object>> |
getSystemTags()
System tags for this resource.
|
Date |
getTimeCreated()
The date and time the boot 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 boot volume per GB,
representing the Block Volume service’s elastic performance options.
|
int |
hashCode() |
BootVolume.Builder |
toBuilder() |
String |
toString() |
@ConstructorProperties(value={"availabilityDomain","compartmentId","definedTags","systemTags","displayName","freeformTags","id","imageId","isHydrated","vpusPerGB","lifecycleState","sizeInGBs","sizeInMBs","sourceDetails","timeCreated","volumeGroupId","kmsKeyId","isAutoTuneEnabled","autoTunedVpusPerGB"}) @Deprecated public BootVolume(String availabilityDomain, String compartmentId, Map<String,Map<String,Object>> definedTags, Map<String,Map<String,Object>> systemTags, String displayName, Map<String,String> freeformTags, String id, String imageId, Boolean isHydrated, Long vpusPerGB, BootVolume.LifecycleState lifecycleState, Long sizeInGBs, Long sizeInMBs, BootVolumeSourceDetails sourceDetails, Date timeCreated, String volumeGroupId, String kmsKeyId, Boolean isAutoTuneEnabled, Long autoTunedVpusPerGB)
public static BootVolume.Builder builder()
Create a new builder.
public BootVolume.Builder toBuilder()
public String getAvailabilityDomain()
The availability domain of the boot volume.
Example: `Uocm:PHX-AD-1`
public String getCompartmentId()
The OCID of the compartment that contains the boot 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 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 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 String getId()
The boot volume’s Oracle ID (OCID).
public String getImageId()
The image OCID used to create the boot volume.
public Boolean getIsHydrated()
Specifies whether the boot volume’s data has finished copying from the source boot volume or boot volume backup.
public Long getVpusPerGB()
The number of volume performance units (VPUs) that will be applied to this boot volume per GB, representing the Block Volume service’s elastic performance options. See Block Volume Elastic Performance for more information.
Allowed values:
`10`: Represents Balanced option.
`20`: Represents Higher Performance option.
public BootVolume.LifecycleState getLifecycleState()
The current state of a boot volume.
public Long getSizeInGBs()
The size of the boot volume in GBs.
public Long getSizeInMBs()
The size of the volume in MBs. The value must be a multiple of 1024. This field is deprecated. Please use sizeInGBs.
public BootVolumeSourceDetails getSourceDetails()
public Date getTimeCreated()
The date and time the boot volume was created. Format defined by RFC3339.
public String getVolumeGroupId()
The OCID of the source volume group.
public String getKmsKeyId()
The OCID of the Key Management master encryption key assigned to the boot volume.
public Boolean getIsAutoTuneEnabled()
Specifies whether the auto-tune performance is enabled for this boot volume.
public Long getAutoTunedVpusPerGB()
The number of Volume Performance Units per GB that this boot volume is effectively tuned to when it’s idle.
Copyright © 2016–2021. All rights reserved.