org.openstack4j.openstack.storage.block.domain

Class CinderVolume.ConcreteVolumeBuilder

java.lang.Object

org.openstack4j.openstack.storage.block.domain.CinderVolume.ConcreteVolumeBuilder

All Implemented Interfaces:

Buildable.Builder<VolumeBuilder,Volume>, VolumeBuilder

Enclosing class:

CinderVolume

public static class CinderVolume.ConcreteVolumeBuilder
extends Object
implements VolumeBuilder

Method Summary

Modifier and Type	Method and Description
VolumeBuilder	bootable(boolean isBootable) Enables or disables the bootable attribute.
Volume	build() Creates and return the Model Entity M
VolumeBuilder	description(String description) See Volume.getDescription() Optional
VolumeBuilder	from(Volume in) Creates a Builder using the param M as the default values
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 class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

name

public VolumeBuilder name(String name)

Description copied from interface: VolumeBuilder

See Volume.getName()

Specified by:

name in interface VolumeBuilder

Parameters:

name - the name of the volume

Returns:

VolumeBuilder

description

public VolumeBuilder description(String description)

Description copied from interface: VolumeBuilder

See Volume.getDescription() Optional

Specified by:

description in interface VolumeBuilder

Parameters:

description - the description of the volume

Returns:

VolumeBuilder

source_volid

public VolumeBuilder source_volid(String uuid)

Description copied from interface: VolumeBuilder

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

Specified by:

source_volid in interface VolumeBuilder

Parameters:

uuid - the id of an existing volume

Returns:

VolumeBuilder

snapshot

public VolumeBuilder snapshot(String snapshotId)

Description copied from interface: VolumeBuilder

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

Specified by:

snapshot in interface VolumeBuilder

Parameters:

snapshotId - the id of an existing volume snapshot

Returns:

VolumeBuilder

imageRef

public VolumeBuilder imageRef(String imageRef)

Description copied from interface: VolumeBuilder

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

Specified by:

imageRef in interface VolumeBuilder

Parameters:

imageRef - the id of an existing image

Returns:

VolumeBuilder

size

public VolumeBuilder size(int size)

Description copied from interface: VolumeBuilder

The size of the volume, in GB.

Specified by:

size in interface VolumeBuilder

Parameters:

size - the size in GB

Returns:

VolumeBuilder

volumeType

public VolumeBuilder volumeType(String volumeType)

Description copied from interface: VolumeBuilder

The associated volume type. Optional

Specified by:

volumeType in interface VolumeBuilder

Parameters:

volumeType - The associated volume type.

Returns:

VolumeBuilder

bootable

public VolumeBuilder bootable(boolean isBootable)

Description copied from interface: VolumeBuilder

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

Specified by:

bootable in interface VolumeBuilder

Parameters:

isBootable - true to enable the bootable flag

Returns:

VolumeBuilder

metadata

public VolumeBuilder metadata(Map<String,String> metadata)

Description copied from interface: VolumeBuilder

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

Specified by:

metadata in interface VolumeBuilder

Parameters:

metadata - metadata to set

Returns:

VolumeBuilder

build

public Volume build()

Description copied from interface: Buildable.Builder

Creates and return the Model Entity M

Specified by:

build in interface Buildable.Builder<VolumeBuilder,Volume>

Returns:

M instance

from

public VolumeBuilder from(Volume in)

Description copied from interface: Buildable.Builder

Creates a Builder using the param M as the default values

Specified by:

from in interface Buildable.Builder<VolumeBuilder,Volume>

Returns:

Builder

zone

public VolumeBuilder zone(String zone)

Description copied from interface: VolumeBuilder

The associated availability zone. Optional

Specified by:

zone in interface VolumeBuilder

Parameters:

zone - The associated availability zone.

Returns:

VolumeBuilder