Package com.oracle.bmc.core.model

Class Volume

  • @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.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).

    • Method Detail

      • builder

        public static Volume.Builder builder()
        Create a new builder.

      • getAvailabilityDomain

        public String getAvailabilityDomain()
        The availability domain of the volume.

        Example: Uocm:PHX-AD-1

        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

      • getSystemTags

        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”}}

        Returns:
        the value

      • getId

        public String getId()
        The OCID of the volume.
        Returns:
        the value

      • getIsHydrated

        public Boolean getIsHydrated()
        Specifies whether the cloned volume’s data has finished copying from the source volume or backup.
        Returns:
        the value

      • getKmsKeyId

        public String getKmsKeyId()
        The OCID of the Vault service key which is the master encryption key for the volume.
        Returns:
        the value

      • getLifecycleState

        public Volume.LifecycleState getLifecycleState()
        The current state of a 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.

        This field is deprecated. Use sizeInGBs instead.

        Returns:
        the value

      • getTimeCreated

        public Date getTimeCreated()
        The date and time the volume was created.

        Format defined by RFC3339.

        Returns:
        the value

      • getVolumeGroupId

        public String getVolumeGroupId()
        The OCID of the source volume group.
        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

      • getAutoTunedVpusPerGB

        public Long getAutoTunedVpusPerGB()
        The number of Volume Performance Units per GB that this volume is effectively tuned to.
        Returns:
        the value

      • getBlockVolumeReplicas

        public List<BlockVolumeReplicaInfo> getBlockVolumeReplicas()
        The list of block volume replicas of this volume.
        Returns:
        the value

      • getAutotunePolicies

        public List<AutotunePolicy> getAutotunePolicies()
        The list of autotune policies enabled for this volume.
        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 class com.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 class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel