org.openstack4j.model.storage.block.builder

Interface VolumeBuilder

All Superinterfaces:

Buildable.Builder<VolumeBuilder,Volume>

All Known Implementing Classes:

CinderVolume.ConcreteVolumeBuilder

public interface VolumeBuilder
extends Buildable.Builder<VolumeBuilder,Volume>

Builder used for Creating or Updating Volumes

Author:

Jeremy Unruh

Method Summary

Modifier and Type	Method and Description
VolumeBuilder	bootable(boolean isBootable) Enables or disables the bootable attribute.
VolumeBuilder	description(String description) See Volume.getDescription() Optional
VolumeBuilder	imageRef(String imageRef) The ID of the image from which you want to create the volume.
VolumeBuilder	metadata(Map<String,String> metadata) One or more metadata key and value pairs to associate with the volume.
VolumeBuilder	name(String name) See Volume.getName()
VolumeBuilder	size(int size) The size of the volume, in GB.
VolumeBuilder	snapshot(String snapshotId) To create a volume from an existing snapshot, specify the ID of the existing volume snapshot.
VolumeBuilder	source_volid(String uuid) To create a volume from an existing volume, specify the ID of the existing volume.
VolumeBuilder	volumeType(String volumeType) The associated volume type.
VolumeBuilder	zone(String zone) The associated availability zone.

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

build, from

Method Detail

name

VolumeBuilder name(String name)

See Volume.getName()

Parameters:

name - the name of the volume

Returns:

VolumeBuilder

description

VolumeBuilder description(String description)

See Volume.getDescription() Optional

Parameters:

description - the description of the volume

Returns:

VolumeBuilder

source_volid

VolumeBuilder source_volid(String uuid)

To create a volume from an existing volume, specify the ID of the existing volume. Optional

Parameters:

uuid - the id of an existing volume

Returns:

VolumeBuilder

snapshot

VolumeBuilder snapshot(String snapshotId)

To create a volume from an existing snapshot, specify the ID of the existing volume snapshot. Optional

Parameters:

snapshotId - the id of an existing volume snapshot

Returns:

VolumeBuilder

imageRef

VolumeBuilder imageRef(String imageRef)

The ID of the image from which you want to create the volume. Required to create a bootable volume. Optional

Parameters:

imageRef - the id of an existing image

Returns:

VolumeBuilder

size

VolumeBuilder size(int size)

The size of the volume, in GB.

Parameters:

size - the size in GB

Returns:

VolumeBuilder

volumeType

VolumeBuilder volumeType(String volumeType)

The associated volume type. Optional

Parameters:

volumeType - The associated volume type.

Returns:

VolumeBuilder

bootable

VolumeBuilder bootable(boolean isBootable)

Enables or disables the bootable attribute. You can boot an instance from a bootable volume. Optional

Parameters:

isBootable - true to enable the bootable flag

Returns:

VolumeBuilder

metadata

VolumeBuilder metadata(Map<String,String> metadata)

One or more metadata key and value pairs to associate with the volume. Optional

Parameters:

metadata - metadata to set

Returns:

VolumeBuilder

zone

VolumeBuilder zone(String zone)

The associated availability zone. Optional

Parameters:

zone - The associated availability zone.

Returns:

VolumeBuilder