nebius.api.nebius.compute.v1.AttachedDiskSpec

class documentation

class AttachedDiskSpec(pb_classes.Message): (source)

Constructor: AttachedDiskSpec(initial_message, attach_mode, existing_disk, device_id)

View In Hierarchy

Undocumented

Class __OneOfClass_type__ Undocumented
Class __OneOfClass_type_existing_disk__ Undocumented
Class AttachMode Undocumented
Method __dir__ Undocumented
Method __init__ Create a wrapper around a protobuf message instance.
Method attach_mode.setter Undocumented
Method device_id.setter Undocumented
Method existing_disk.setter Undocumented
Constant __PB2_DESCRIPTOR__ Undocumented
Constant __PY_TO_PB2__ Undocumented
Class Variable __mask_functions__ Undocumented
Property attach_mode Undocumented
Property device_id Specifies the user-defined identifier, allowing to use '/dev/disk/by-id/virtio-{device_id}' as a device path in mount command.
Property existing_disk Attach an existing disk.
Property type Undocumented

Inherited from Message:

Class Method get_descriptor Return the protobuf descriptor for this message class.
Class Method is_credentials Return True if the field contains credentials.
Class Method is_sensitive Return True if the field is marked as sensitive.
Method __repr__ Return a human-readable representation of the message, sanitizing sensitive fields.
Method check_presence Check explicit presence for a field in the protobuf message.
Method get_full_update_reset_mask Build a reset mask for a full update of this message.
Method get_mask Return the tracked reset mask.
Method is_default Return True if a field equals its default value.
Method set_mask Replace the tracked reset mask.
Method which_field_in_oneof Return the set field name for a given oneof.
Instance Variable __PB2_CLASS__ Protobuf message class associated with this wrapper.
Instance Variable __pb2_message__ Underlying protobuf message instance.
Method _clear_field Clear a field and record it in the reset mask.
Method _get_field Return a field value with optional wrapping and presence handling.
Method _set_field Set a field value and update the reset mask.
Class Variable __credentials_fields Undocumented
Class Variable __default Undocumented
Class Variable __sensitive_fields Undocumented
Instance Variable __recorded_reset_mask Mask tracking fields cleared or set to default.
def __dir__(self) -> abc.Iterable[builtins.str]: (source)

Undocumented

def __init__(self, initial_message: message_1.Message | None = None, *, attach_mode: AttachedDiskSpec.AttachMode | instance_pb2.AttachedDiskSpec.AttachMode | None | unset.UnsetType = unset.Unset, existing_disk: ExistingDisk | instance_pb2.ExistingDisk | None | unset.UnsetType = unset.Unset, device_id: builtins.str | None | unset.UnsetType = unset.Unset): (source)
overrides nebius.base.protos.pb_classes.Message.__init__

Create a wrapper around a protobuf message instance.

Raises
AttributeErrorIf the wrapper is missing required class metadata.
@attach_mode.setter
def attach_mode(self, value: AttachedDiskSpec.AttachMode | instance_pb2.AttachedDiskSpec.AttachMode | None): (source)

Undocumented

@device_id.setter
def device_id(self, value: builtins.str | None): (source)

Undocumented

@existing_disk.setter
def existing_disk(self, value: ExistingDisk | instance_pb2.ExistingDisk | None): (source)

Undocumented

__PB2_DESCRIPTOR__ = (source)
overrides nebius.base.protos.pb_classes.Message.__PB2_DESCRIPTOR__

Undocumented

Value
descriptor.DescriptorWrap[descriptor_1.Descriptor]('.nebius.compute.v1.AttachedD↵
iskSpec',
                                                   instance_pb2.DESCRIPTOR,
                                                   descriptor_1.Descriptor)
__PY_TO_PB2__: builtins.dict[builtins.str, builtins.str] = (source)
overrides nebius.base.protos.pb_classes.Message.__PY_TO_PB2__

Undocumented

Value
{'attach_mode': 'attach_mode',
 'existing_disk': 'existing_disk',
 'device_id': 'device_id',
 'type': 'type',
 'AttachMode': 'AttachMode'}
__mask_functions__: dict = (source)
overrides nebius.base.protos.pb_classes.Message.__mask_functions__

Undocumented

@builtins.property
attach_mode: AttachedDiskSpec.AttachMode = (source)

Undocumented

@builtins.property
device_id: builtins.str = (source)

Specifies the user-defined identifier, allowing to use '/dev/disk/by-id/virtio-{device_id}' as a device path in mount command.

@builtins.property
existing_disk: ExistingDisk | None = (source)

Attach an existing disk.

Lifecycle:

  • The disk is preserved when the instance is deleted (it will be detached).

Switching to a managed disk:

  • To delete the disk together with the instance, switch to ManagedDisk in the instance spec.
  • For the switch, ManagedDisk.name MUST match the current disk name (see DiskService.Get for the disk referenced by ExistingDisk.id).
  • When converting an ExistingDisk to a ManagedDisk, you must provide ManagedDisk.name and ManagedDisk.spec exactly as they are currently defined in the disk resource. Obtain the current values via DiskService.Get and copy them verbatim. If ManagedDisk.spec differs from the current disk spec, the instance update will fail.
@builtins.property
type: __OneOfClass_type_existing_disk__ | None = (source)

Undocumented