com.oracle.bmc.core.model

Class VolumeAttachment

java.lang.Object

com.oracle.bmc.core.model.VolumeAttachment

Direct Known Subclasses:

EmulatedVolumeAttachment, IScsiVolumeAttachment, ParavirtualizedVolumeAttachment

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20160918")
public class VolumeAttachment
extends Object

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.

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 #__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).

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	VolumeAttachment.LifecycleState The current state of the volume attachment.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	VolumeAttachment(String availabilityDomain, String compartmentId, String device, String displayName, String id, String instanceId, Boolean isReadOnly, Boolean isShareable, VolumeAttachment.LifecycleState lifecycleState, Date timeCreated, String volumeId, Boolean isPvEncryptionInTransitEnabled) Deprecated.

Method Summary

Modifier and Type	Method and Description
protected boolean	canEqual(Object other)
boolean	equals(Object o)
String	getAvailabilityDomain() The availability domain of an instance.
String	getCompartmentId() The OCID of the compartment.
String	getDevice() The device name.
String	getDisplayName() A user-friendly name.
String	getId() The OCID of the volume attachment.
String	getInstanceId() The OCID of the instance the volume is attached to.
Boolean	getIsPvEncryptionInTransitEnabled() Whether in-transit encryption for the data volume’s paravirtualized attachment is enabled or not.
Boolean	getIsReadOnly() Whether the attachment was created in read-only mode.
Boolean	getIsShareable() Whether the attachment should be created in shareable mode.
VolumeAttachment.LifecycleState	getLifecycleState() The current state of the volume attachment.
Date	getTimeCreated() The date and time the volume was created, in the format defined by RFC3339.
String	getVolumeId() The OCID of the volume.
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

VolumeAttachment

@ConstructorProperties(value={"availabilityDomain","compartmentId","device","displayName","id","instanceId","isReadOnly","isShareable","lifecycleState","timeCreated","volumeId","isPvEncryptionInTransitEnabled"})
 @Deprecated
protected VolumeAttachment(String availabilityDomain,
                                                                                                                                                                                                                                                            String compartmentId,
                                                                                                                                                                                                                                                            String device,
                                                                                                                                                                                                                                                            String displayName,
                                                                                                                                                                                                                                                            String id,
                                                                                                                                                                                                                                                            String instanceId,
                                                                                                                                                                                                                                                            Boolean isReadOnly,
                                                                                                                                                                                                                                                            Boolean isShareable,
                                                                                                                                                                                                                                                            VolumeAttachment.LifecycleState lifecycleState,
                                                                                                                                                                                                                                                            Date timeCreated,
                                                                                                                                                                                                                                                            String volumeId,
                                                                                                                                                                                                                                                            Boolean isPvEncryptionInTransitEnabled)

Deprecated.

Method Detail

getAvailabilityDomain

public String getAvailabilityDomain()

The availability domain of an instance.

Example: Uocm:PHX-AD-1

getCompartmentId

public String getCompartmentId()

The OCID of the compartment.

getDevice

public String getDevice()

The device name.

getDisplayName

public String getDisplayName()

A user-friendly name. Does not have to be unique, and it cannot be changed. Avoid entering confidential information.

Example: My volume attachment

getId

public String getId()

The OCID of the volume attachment.

getInstanceId

public String getInstanceId()

The OCID of the instance the volume is attached to.

getIsReadOnly

public Boolean getIsReadOnly()

Whether the attachment was created in read-only mode.

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.

getLifecycleState

public VolumeAttachment.LifecycleState getLifecycleState()

The current state of the volume attachment.

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

getVolumeId

public String getVolumeId()

The OCID of the volume.

getIsPvEncryptionInTransitEnabled

public Boolean getIsPvEncryptionInTransitEnabled()

Whether in-transit encryption for the data volume’s paravirtualized attachment is enabled or not.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

canEqual

protected boolean canEqual(Object other)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object