org.openstack4j.model.storage.block.builder

Interface VolumeSnapshotBuilder

All Superinterfaces:

Buildable.Builder<VolumeSnapshotBuilder,VolumeSnapshot>

All Known Implementing Classes:

CinderVolumeSnapshot.ConcreteVolumeSnapshotBuilder

public interface VolumeSnapshotBuilder
extends Buildable.Builder<VolumeSnapshotBuilder,VolumeSnapshot>

A Builder which creates a Volume Snapshot. NOTE: The only REQUIRED field when creating a snapshot is volume(String) . All other fields are optional

Author:

Jeremy Unruh

Method Summary

Modifier and Type	Method and Description
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	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 interface org.openstack4j.common.Buildable.Builder

build, from

Method Detail

name

VolumeSnapshotBuilder name(String name)

Name of the snapshot

Parameters:

name - the name

Returns:

the volume snapshot builder

description

VolumeSnapshotBuilder description(String description)

Description of the snapshot

Parameters:

description - the description

Returns:

the volume snapshot builder

volume

VolumeSnapshotBuilder volume(String volumeId)

The ID of of the existing Volume (REQUIRED)

Parameters:

volumeId - the volume id

Returns:

the volume snapshot builder

metadata

VolumeSnapshotBuilder metadata(Map<String,String> metadata)

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

Parameters:

metadata - metadata to set

Returns:

VolumeSnapshotBuilder

force

VolumeSnapshotBuilder force(boolean force)

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

Parameters:

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

Returns:

the volume snapshot builder