org.openstack4j.openstack.storage.block.domain

Class CinderVolumeSnapshot.ConcreteVolumeSnapshotBuilder

java.lang.Object

org.openstack4j.openstack.storage.block.domain.CinderVolumeSnapshot.ConcreteVolumeSnapshotBuilder

All Implemented Interfaces:

Buildable.Builder<VolumeSnapshotBuilder,VolumeSnapshot>, VolumeSnapshotBuilder

Enclosing class:

CinderVolumeSnapshot

public static class CinderVolumeSnapshot.ConcreteVolumeSnapshotBuilder
extends Object
implements VolumeSnapshotBuilder

Method Summary

Modifier and Type	Method and Description
VolumeSnapshot	build() Creates and return the Model Entity M
VolumeSnapshotBuilder	description(String description) Description of the snapshot
VolumeSnapshotBuilder	force(boolean force) [True/False] Indicate whether to snapshot, even if the volume is attached.
VolumeSnapshotBuilder	from(VolumeSnapshot in) Creates a Builder using the param M as the default values
VolumeSnapshotBuilder	metadata(Map<String,String> metadata) One or more metadata key and value pairs to associate with the volume snapshot.
VolumeSnapshotBuilder	name(String name) Name of the snapshot
VolumeSnapshotBuilder	volume(String volumeId) The ID of of the existing Volume (REQUIRED)

Methods inherited from class java.lang.Object

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

Method Detail

name

public VolumeSnapshotBuilder name(String name)

Description copied from interface: VolumeSnapshotBuilder

Name of the snapshot

Specified by:

name in interface VolumeSnapshotBuilder

Parameters:

name - the name

Returns:

the volume snapshot builder

description

public VolumeSnapshotBuilder description(String description)

Description copied from interface: VolumeSnapshotBuilder

Description of the snapshot

Specified by:

description in interface VolumeSnapshotBuilder

Parameters:

description - the description

Returns:

the volume snapshot builder

volume

public VolumeSnapshotBuilder volume(String volumeId)

Description copied from interface: VolumeSnapshotBuilder

The ID of of the existing Volume (REQUIRED)

Specified by:

volume in interface VolumeSnapshotBuilder

Parameters:

volumeId - the volume id

Returns:

the volume snapshot builder

force

public VolumeSnapshotBuilder force(boolean force)

Description copied from interface: VolumeSnapshotBuilder

[True/False] Indicate whether to snapshot, even if the volume is attached.

Specified by:

force in interface VolumeSnapshotBuilder

Parameters:

force - true to force an attached volume to be a snapshot

Returns:

the volume snapshot builder

metadata

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

Description copied from interface: VolumeSnapshotBuilder

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

Specified by:

metadata in interface VolumeSnapshotBuilder

Parameters:

metadata - metadata to set

Returns:

VolumeSnapshotBuilder

build

public VolumeSnapshot build()

Description copied from interface: Buildable.Builder

Creates and return the Model Entity M

Specified by:

build in interface Buildable.Builder<VolumeSnapshotBuilder,VolumeSnapshot>

Returns:

M instance

from

public VolumeSnapshotBuilder from(VolumeSnapshot 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<VolumeSnapshotBuilder,VolumeSnapshot>

Returns:

Builder