LaunchAttachVolumeDetails¶
- class oci.core.models.LaunchAttachVolumeDetails(**kwargs)¶
Bases:
objectThe details of the volume to attach.
Methods:
__init__(**kwargs)Initializes a new LaunchAttachVolumeDetails object with values from keyword arguments.
get_subtype(object_dictionary)Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.
Attributes:
Gets the device of this LaunchAttachVolumeDetails.
Gets the display_name of this LaunchAttachVolumeDetails.
Gets the is_read_only of this LaunchAttachVolumeDetails.
Gets the is_shareable of this LaunchAttachVolumeDetails.
Gets the launch_create_volume_details of this LaunchAttachVolumeDetails.
[Required] Gets the type of this LaunchAttachVolumeDetails.
Gets the volume_id of this LaunchAttachVolumeDetails.
- __init__(**kwargs)¶
Initializes a new LaunchAttachVolumeDetails object with values from keyword arguments. This class has the following subclasses and if you are using this class as input to a service operations then you should favor using a subclass over the base class:
The following keyword arguments are supported (corresponding to the getters/setters of this class):
- Parameters
device (str) – The value to assign to the device property of this LaunchAttachVolumeDetails.
display_name (str) – The value to assign to the display_name property of this LaunchAttachVolumeDetails.
is_read_only (bool) – The value to assign to the is_read_only property of this LaunchAttachVolumeDetails.
is_shareable (bool) – The value to assign to the is_shareable property of this LaunchAttachVolumeDetails.
type (str) – The value to assign to the type property of this LaunchAttachVolumeDetails.
volume_id (str) – The value to assign to the volume_id property of this LaunchAttachVolumeDetails.
launch_create_volume_details (oci.core.models.LaunchCreateVolumeDetails) – The value to assign to the launch_create_volume_details property of this LaunchAttachVolumeDetails.
- property device¶
Gets the device of this LaunchAttachVolumeDetails. The device name. To retrieve a list of devices for a given instance, see
list_instance_devices().- Returns
The device of this LaunchAttachVolumeDetails.
- Return type
str
- property display_name¶
Gets the display_name of this LaunchAttachVolumeDetails. A user-friendly name. Does not have to be unique, and it’s changeable. Avoid entering confidential information.
- Returns
The display_name of this LaunchAttachVolumeDetails.
- Return type
str
- static get_subtype(object_dictionary)¶
Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.
- property is_read_only¶
Gets the is_read_only of this LaunchAttachVolumeDetails. Whether the attachment was created in read-only mode.
- Returns
The is_read_only of this LaunchAttachVolumeDetails.
- Return type
bool
Gets the is_shareable of this LaunchAttachVolumeDetails. 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 is_shareable of this LaunchAttachVolumeDetails.
- Return type
bool
- property launch_create_volume_details¶
Gets the launch_create_volume_details of this LaunchAttachVolumeDetails.
- Returns
The launch_create_volume_details of this LaunchAttachVolumeDetails.
- Return type
- property type¶
[Required] Gets the type of this LaunchAttachVolumeDetails. The type of volume attachment. Currently, the only supported values are “iscsi”, “paravirtualized”, and “nvme”.
- Returns
The type of this LaunchAttachVolumeDetails.
- Return type
str
- property volume_id¶
Gets the volume_id of this LaunchAttachVolumeDetails. The OCID of the volume. If CreateVolumeDetails is specified, this field must be omitted from the request.
- Returns
The volume_id of this LaunchAttachVolumeDetails.
- Return type
str