Class CreateVolumeDetails
- java.lang.Object
-
- com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
-
- com.oracle.bmc.core.model.CreateVolumeDetails
-
@Generated(value="OracleSDKGenerator", comments="API Version: 20160918") public final class CreateVolumeDetails extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
The details of the volume to create.For CreateVolume operation, this field is required in the request, see
createVolume
.
Note: Objects should always be created or deserialized using theCreateVolumeDetails.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 theCreateVolumeDetails.Builder
, which maintain a set of all explicitly set fields calledCreateVolumeDetails.Builder.__explicitlySet__
. ThehashCode()
andequals(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).
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
CreateVolumeDetails.Builder
-
Constructor Summary
Constructors Constructor Description CreateVolumeDetails(String availabilityDomain, String backupPolicyId, String compartmentId, Map<String,Map<String,Object>> definedTags, String displayName, Map<String,String> freeformTags, String kmsKeyId, Long vpusPerGB, String clusterPlacementGroupId, Long sizeInGBs, Long sizeInMBs, VolumeSourceDetails sourceDetails, String volumeBackupId, Boolean isAutoTuneEnabled, List<BlockVolumeReplicaDetails> blockVolumeReplicas, List<AutotunePolicy> autotunePolicies, String xrcKmsKeyId, Boolean isReservationsEnabled)
Deprecated.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static CreateVolumeDetails.Builder
builder()
Create a new builder.boolean
equals(Object o)
List<AutotunePolicy>
getAutotunePolicies()
The list of autotune policies to be enabled for this volume.String
getAvailabilityDomain()
The availability domain of the volume.String
getBackupPolicyId()
If provided, specifies the ID of the volume backup policy to assign to the newly created volume.List<BlockVolumeReplicaDetails>
getBlockVolumeReplicas()
The list of block volume replicas to be enabled for this volume in the specified destination availability domains.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.Boolean
getIsAutoTuneEnabled()
Specifies whether the auto-tune performance is enabled for this volume.Boolean
getIsReservationsEnabled()
Reservations-enabled is a boolean field that allows to enable PR (Persistent Reservation) on a volume.String
getKmsKeyId()
The OCID of the Vault service key to assign as the master encryption key for the volume.Long
getSizeInGBs()
The size of the volume in GBs.Long
getSizeInMBs()
The size of the volume in MBs.VolumeSourceDetails
getSourceDetails()
String
getVolumeBackupId()
The OCID of the volume backup from which the data should be restored on the newly created volume.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.String
getXrcKmsKeyId()
The OCID of the Vault service key which is the master encryption key for the block volume cross region backups, which will be used in the destination region to encrypt the backup’s encryption keys.int
hashCode()
CreateVolumeDetails.Builder
toBuilder()
String
toString()
String
toString(boolean includeByteArrayContents)
Return a string representation of the object.
-
-
-
Constructor Detail
-
CreateVolumeDetails
@Deprecated @ConstructorProperties({"availabilityDomain","backupPolicyId","compartmentId","definedTags","displayName","freeformTags","kmsKeyId","vpusPerGB","clusterPlacementGroupId","sizeInGBs","sizeInMBs","sourceDetails","volumeBackupId","isAutoTuneEnabled","blockVolumeReplicas","autotunePolicies","xrcKmsKeyId","isReservationsEnabled"}) public CreateVolumeDetails(String availabilityDomain, String backupPolicyId, String compartmentId, Map<String,Map<String,Object>> definedTags, String displayName, Map<String,String> freeformTags, String kmsKeyId, Long vpusPerGB, String clusterPlacementGroupId, Long sizeInGBs, Long sizeInMBs, VolumeSourceDetails sourceDetails, String volumeBackupId, Boolean isAutoTuneEnabled, List<BlockVolumeReplicaDetails> blockVolumeReplicas, List<AutotunePolicy> autotunePolicies, String xrcKmsKeyId, Boolean isReservationsEnabled)
Deprecated.
-
-
Method Detail
-
builder
public static CreateVolumeDetails.Builder builder()
Create a new builder.
-
toBuilder
public CreateVolumeDetails.Builder toBuilder()
-
getAvailabilityDomain
public String getAvailabilityDomain()
The availability domain of the volume.Omissible for cloning a volume. The new volume will be created in the availability domain of the source volume.
Example: Uocm:PHX-AD-1
- Returns:
- the value
-
getBackupPolicyId
public String getBackupPolicyId()
If provided, specifies the ID of the volume backup policy to assign to the newly created volume.If omitted, no policy will be assigned.
- Returns:
- the value
-
getCompartmentId
public String getCompartmentId()
The OCID of the compartment that contains the volume.- Returns:
- the value
-
getDefinedTags
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"}}
- Returns:
- the value
-
getDisplayName
public String getDisplayName()
A user-friendly name.Does not have to be unique, and it’s changeable. Avoid entering confidential information.
- Returns:
- the value
-
getFreeformTags
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"}
- Returns:
- the value
-
getKmsKeyId
public String getKmsKeyId()
The OCID of the Vault service key to assign as the master encryption key for the volume.- Returns:
- the value
-
getVpusPerGB
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.
- Returns:
- the value
-
getClusterPlacementGroupId
public String getClusterPlacementGroupId()
The clusterPlacementGroup Id of the volume for volume placement.- Returns:
- the value
-
getSizeInGBs
public Long getSizeInGBs()
The size of the volume in GBs.- Returns:
- the value
-
getSizeInMBs
public Long getSizeInMBs()
The size of the volume in MBs.The value must be a multiple of 1024. This field is deprecated. Use sizeInGBs instead.
- Returns:
- the value
-
getSourceDetails
public VolumeSourceDetails getSourceDetails()
-
getVolumeBackupId
public String getVolumeBackupId()
The OCID of the volume backup from which the data should be restored on the newly created volume.This field is deprecated. Use the sourceDetails field instead to specify the backup for the volume.
- Returns:
- the value
-
getIsAutoTuneEnabled
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.
- Returns:
- the value
-
getBlockVolumeReplicas
public List<BlockVolumeReplicaDetails> getBlockVolumeReplicas()
The list of block volume replicas to be enabled for this volume in the specified destination availability domains.- Returns:
- the value
-
getAutotunePolicies
public List<AutotunePolicy> getAutotunePolicies()
The list of autotune policies to be enabled for this volume.- Returns:
- the value
-
getXrcKmsKeyId
public String getXrcKmsKeyId()
The OCID of the Vault service key which is the master encryption key for the block volume cross region backups, which will be used in the destination region to encrypt the backup’s encryption keys.For more information about the Vault service and encryption keys, see Overview of Vault service and Using Keys.
- Returns:
- the value
-
getIsReservationsEnabled
public Boolean getIsReservationsEnabled()
Reservations-enabled is a boolean field that allows to enable PR (Persistent Reservation) on a volume.- Returns:
- the value
-
toString
public String toString()
- Overrides:
toString
in classcom.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
-
toString
public String toString(boolean includeByteArrayContents)
Return a string representation of the object.- Parameters:
includeByteArrayContents
- true to include the full contents of byte arrays- Returns:
- string representation
-
equals
public boolean equals(Object o)
- Overrides:
equals
in classcom.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classcom.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
-
-