@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.cloud.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).
| Modifier and Type | Class and Description |
|---|---|
static class |
VolumeAttachment.IscsiLoginState
The iscsi login state of the volume attachment.
|
static class |
VolumeAttachment.LifecycleState
The current state of the volume attachment.
|
EXPLICITLY_SET_FILTER_NAME, EXPLICITLY_SET_PROPERTY_NAME| 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,
Boolean isMultipath,
VolumeAttachment.IscsiLoginState iscsiLoginState,
Boolean isVolumeCreatedDuringLaunch)
Deprecated.
|
| Modifier and Type | Method and Description |
|---|---|
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.
|
VolumeAttachment.IscsiLoginState |
getIscsiLoginState()
The iscsi login state of the volume attachment.
|
Boolean |
getIsMultipath()
Whether the Iscsi or Paravirtualized attachment is multipath or not, it is not applicable to
NVMe attachment.
|
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.
|
Boolean |
getIsVolumeCreatedDuringLaunch()
Flag indicating if this volume was created for the customer as part of a simplified launch.
|
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() |
String |
toString(boolean includeByteArrayContents)
Return a string representation of the object.
|
markPropertyAsExplicitlySet, wasPropertyExplicitlySet@Deprecated @ConstructorProperties(value={"availabilityDomain","compartmentId","device","displayName","id","instanceId","isReadOnly","isShareable","lifecycleState","timeCreated","volumeId","isPvEncryptionInTransitEnabled","isMultipath","iscsiLoginState","isVolumeCreatedDuringLaunch"}) 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, Boolean isMultipath, VolumeAttachment.IscsiLoginState iscsiLoginState, Boolean isVolumeCreatedDuringLaunch)
public String getAvailabilityDomain()
The availability domain of an instance.
Example: Uocm:PHX-AD-1
public String getCompartmentId()
The OCID of the compartment.
public String getDevice()
The device name.
public String getDisplayName()
A user-friendly name. Does not have to be unique, and it’s changeable. Avoid entering confidential information.
public String getId()
The OCID of the volume attachment.
public String getInstanceId()
The OCID of the instance the volume is attached to.
public Boolean getIsReadOnly()
Whether the attachment was created in read-only mode.
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.
public VolumeAttachment.LifecycleState getLifecycleState()
The current state of the volume attachment.
public Date getTimeCreated()
The date and time the volume was created, in the format defined by RFC3339.
Example: 2016-08-25T21:10:29.600Z
public String getVolumeId()
The OCID of the volume.
public Boolean getIsPvEncryptionInTransitEnabled()
Whether in-transit encryption for the data volume’s paravirtualized attachment is enabled or not.
public Boolean getIsMultipath()
Whether the Iscsi or Paravirtualized attachment is multipath or not, it is not applicable to NVMe attachment.
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.
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.
public String toString()
toString in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModelpublic String toString(boolean includeByteArrayContents)
Return a string representation of the object.
includeByteArrayContents - true to include the full contents of byte arrayspublic boolean equals(Object o)
equals in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModelpublic int hashCode()
hashCode in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModelCopyright © 2016–2024. All rights reserved.