org.openstack4j.model.compute.builder

Interface BlockDeviceMappingBuilder

All Superinterfaces:

Buildable.Builder<BlockDeviceMappingBuilder,BlockDeviceMappingCreate>

All Known Implementing Classes:

NovaBlockDeviceMappingCreate.NovaBlockDeviceMappingBuilder

public interface BlockDeviceMappingBuilder
extends Buildable.Builder<BlockDeviceMappingBuilder,BlockDeviceMappingCreate>

Block Device Mapping

Author:

jaroslav.sovicka@oracle.com

Method Summary

Modifier and Type	Method and Description
BlockDeviceMappingBuilder	bootIndex(int i) The boot index
BlockDeviceMappingBuilder	deleteOnTermination(boolean deleteOnTermination) Set to True to delete the volume when the instance is deleted.
BlockDeviceMappingBuilder	destinationType(BDMDestType type) Either snap or any other value, including a blank string.
BlockDeviceMappingBuilder	deviceName(String deviceName) A device name where the volume is attached in the system at /dev/dev_name.
BlockDeviceMappingBuilder	deviceType(String deviceType) Used to set the device_type, low level detail that some hypervisors (currently only libvirt) may support.
BlockDeviceMappingBuilder	diskBus(String diskBus) Used to set the disk_bus, low level detail that some hypervisors (currently only libvirt) may support.
BlockDeviceMappingBuilder	snapshotId(String snapshotId) Set to create a volume from a snapshot id
BlockDeviceMappingBuilder	sourceType(BDMSourceType type) Either snap or any other value, including a blank string.
BlockDeviceMappingBuilder	uuid(String id) The device ID.
BlockDeviceMappingBuilder	volumeId(String volumeId) Set to create a volume from a volume id
BlockDeviceMappingBuilder	volumeSize(Integer size) Used to set the volume size of the destination volume (typically needed when source type is image)

Methods inherited from interface org.openstack4j.common.Buildable.Builder

build, from

Method Detail

bootIndex

BlockDeviceMappingBuilder bootIndex(int i)

The boot index

Parameters:

i -

Returns:

BlockDeviceMappingBuilder

deviceName

BlockDeviceMappingBuilder deviceName(String deviceName)

A device name where the volume is attached in the system at /dev/dev_name. This value is typically vda.

Parameters:

deviceName - the device name

Returns:

BlockDeviceMappingBuilder

uuid

BlockDeviceMappingBuilder uuid(String id)

The device ID.

Parameters:

id - the device id

Returns:

BlockDeviceMappingBuilder

destinationType

BlockDeviceMappingBuilder destinationType(BDMDestType type)

Either snap or any other value, including a blank string. snap means that the volume was created from a snapshot.

Parameters:

type - the destination type

Returns:

BlockDeviceMappingBuilder

sourceType

BlockDeviceMappingBuilder sourceType(BDMSourceType type)

Either snap or any other value, including a blank string. snap means that the volume was created from a snapshot.

Parameters:

type - the source type

Returns:

BlockDeviceMappingBuilder

deleteOnTermination

BlockDeviceMappingBuilder deleteOnTermination(boolean deleteOnTermination)

Set to True to delete the volume when the instance is deleted. Set to False to retain the volume when the instance is deleted.

Parameters:

deleteOnTermination -

Returns:

BlockDeviceMappingBuilder

snapshotId

BlockDeviceMappingBuilder snapshotId(String snapshotId)

Set to create a volume from a snapshot id

Parameters:

snapshotId -

Returns:

BlockDeviceMappingBuilder

volumeId

BlockDeviceMappingBuilder volumeId(String volumeId)

Set to create a volume from a volume id

Parameters:

volumeId -

Returns:

BlockDeviceMappingBuilder

volumeSize

BlockDeviceMappingBuilder volumeSize(Integer size)

Used to set the volume size of the destination volume (typically needed when source type is image)

Parameters:

size - the size of the volume

Returns:

BlockDeviceMappingBuilder

diskBus

BlockDeviceMappingBuilder diskBus(String diskBus)

Used to set the disk_bus, low level detail that some hypervisors (currently only libvirt) may support.

Parameters:

disk_bus - type, e.g ide, usb, virtio, scsi

Returns:

BlockDeviceMappingBuilder

See Also:

https://docs.openstack.org/developer/nova/block_device_mapping.html#block-device-mapping-v2

deviceType

BlockDeviceMappingBuilder deviceType(String deviceType)

Used to set the device_type, low level detail that some hypervisors (currently only libvirt) may support.

Parameters:

device_type, - disk, cdrom, floppy, lun

Returns:

BlockDeviceMappingBuilder

See Also:

https://docs.openstack.org/developer/nova/block_device_mapping.html#block-device-mapping-v2