Package com.oracle.bmc.core.model

Class VolumeAttachment

  • Direct Known Subclasses:
    EmulatedVolumeAttachment, IScsiVolumeAttachment, ParavirtualizedVolumeAttachment
    @Generated(value="OracleSDKGenerator",
           comments="API Version: 20160918")
public class VolumeAttachment
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
    A base object for all types of attachments between a storage volume and an instance.

    For specific details about iSCSI attachments, see IScsiVolumeAttachment.

    For general information about volume attachments, see [Overview of Block Volume Storage](https://docs.oracle.com/iaas/Content/Block/Concepts/overview.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 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 Builder, which maintain a set of all explicitly set fields called 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

      • getAvailabilityDomain

        public String getAvailabilityDomain()
        The availability domain of an instance.

        Example: Uocm:PHX-AD-1

        Returns:
        the value

      • getCompartmentId

        public String getCompartmentId()
        The OCID of the compartment.
        Returns:
        the value

      • getDevice

        public String getDevice()
        The device name.
        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

      • getId

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

      • getInstanceId

        public String getInstanceId()
        The OCID of the instance the volume is attached to.
        Returns:
        the value

      • getIsReadOnly

        public Boolean getIsReadOnly()
        Whether the attachment was created in read-only mode.
        Returns:
        the value

      • getIsShareable

        public Boolean getIsShareable()
        Whether the attachment should be created in shareable mode.

        If an attachment is created in shareable mode, then other instances can attach the same volume, provided that they also create their attachments in shareable mode. Only certain volume types can be attached in shareable mode. Defaults to false if not specified.

        Returns:
        the value

      • getTimeCreated

        public Date getTimeCreated()
        The date and time the volume was created, in the format defined by RFC3339.

        Example: 2016-08-25T21:10:29.600Z

        Returns:
        the value

      • getVolumeId

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

      • getIsPvEncryptionInTransitEnabled

        public Boolean getIsPvEncryptionInTransitEnabled()
        Whether in-transit encryption for the data volume’s paravirtualized attachment is enabled or not.
        Returns:
        the value

      • getIsMultipath

        public Boolean getIsMultipath()
        Whether the Iscsi or Paravirtualized attachment is multipath or not, it is not applicable to NVMe attachment.
        Returns:
        the value

      • getIscsiLoginState

        public VolumeAttachment.IscsiLoginState getIscsiLoginState()
        The iscsi login state of the volume attachment.

        For a Iscsi volume attachment, all iscsi sessions need to be all logged-in or logged-out to be in logged-in or logged-out state.

        Returns:
        the value

      • getIsVolumeCreatedDuringLaunch

        public Boolean getIsVolumeCreatedDuringLaunch()
        Flag indicating if this volume was created for the customer as part of a simplified launch.

        Used to determine whether the volume requires deletion on instance termination.

        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