AttachVolumeDetails¶

class oci.core.models.AttachVolumeDetails(**kwargs)¶

Bases: object

AttachVolumeDetails model.

Methods

`__init__`(**kwargs)	Initializes a new AttachVolumeDetails 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

`device`	Gets the device of this AttachVolumeDetails.
`display_name`	Gets the display_name of this AttachVolumeDetails.
`instance_id`	[Required] Gets the instance_id of this AttachVolumeDetails.
`is_read_only`	Gets the is_read_only of this AttachVolumeDetails.
`is_shareable`	Gets the is_shareable of this AttachVolumeDetails.
`type`	[Required] Gets the type of this AttachVolumeDetails.
`volume_id`	[Required] Gets the volume_id of this AttachVolumeDetails.

__init__(**kwargs)¶

Initializes a new AttachVolumeDetails 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 AttachVolumeDetails.
display_name (str) – The value to assign to the display_name property of this AttachVolumeDetails.
instance_id (str) – The value to assign to the instance_id property of this AttachVolumeDetails.
is_read_only (bool) – The value to assign to the is_read_only property of this AttachVolumeDetails.
is_shareable (bool) – The value to assign to the is_shareable property of this AttachVolumeDetails.
type (str) – The value to assign to the type property of this AttachVolumeDetails.
volume_id (str) – The value to assign to the volume_id property of this AttachVolumeDetails.

device¶

Gets the device of this AttachVolumeDetails. The device name. To retrieve a list of devices for a given instance, see list_instance_devices().

Returns:	The device of this AttachVolumeDetails.
Return type:	str

display_name¶

Gets the display_name of this AttachVolumeDetails. A user-friendly name. Does not have to be unique, and it’s changeable. Avoid entering confidential information.

Returns:	The display_name of this AttachVolumeDetails.
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.

instance_id¶

[Required] Gets the instance_id of this AttachVolumeDetails. The OCID of the instance. For AttachVolume operation, this is a required field for the request, see attach_volume().

Returns:	The instance_id of this AttachVolumeDetails.
Return type:	str

is_read_only¶

Gets the is_read_only of this AttachVolumeDetails. Whether the attachment was created in read-only mode.

Returns:	The is_read_only of this AttachVolumeDetails.
Return type:	bool

is_shareable¶

Gets the is_shareable of this AttachVolumeDetails. 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 AttachVolumeDetails.
Return type:	bool

type¶

[Required] Gets the type of this AttachVolumeDetails. The type of volume. The only supported values are “iscsi” and “paravirtualized”.

Returns:	The type of this AttachVolumeDetails.
Return type:	str

volume_id¶

[Required] Gets the volume_id of this AttachVolumeDetails. The OCID of the volume. If CreateVolumeDetails is specified, this field must be omitted from the request.

Returns:	The volume_id of this AttachVolumeDetails.
Return type:	str