org.openstack4j.api.storage

Interface BlockVolumeSnapshotService

All Superinterfaces:

RestService

All Known Implementing Classes:

BlockVolumeSnapshotServiceImpl

public interface BlockVolumeSnapshotService
extends RestService

OpenStack (Cinder) Volume Snapshot Operations API.

Author:

Jeremy Unruh

Method Summary

Modifier and Type	Method and Description
VolumeSnapshot	create(VolumeSnapshot snapshot) Creates a snapshot, which is a point-in-time copy of a volume.
ActionResponse	delete(String snapshotId) Deletes a specified snapshot
VolumeSnapshot	get(String snapshotId) Shows information for a specified snapshot.
List<? extends VolumeSnapshot>	list() Lists detailed information for all Block Storage snapshots that the tenant who submits the request can access.
List<? extends VolumeSnapshot>	list(Map<String,String> filteringParams) Returns list of Block Storage snapshots filtered by parameters.
ActionResponse	update(String snapshotId, String name, String description) Updates the Name and/or Description for the specified snapshot

Method Detail

list

List<? extends VolumeSnapshot> list()

Lists detailed information for all Block Storage snapshots that the tenant who submits the request can access.

Returns:

List of VolumeSnapshot

list

List<? extends VolumeSnapshot> list(Map<String,String> filteringParams)

Returns list of Block Storage snapshots filtered by parameters.

Parameters:

filteringParams - map (name, value) of filtering parameters

get

VolumeSnapshot get(String snapshotId)

Shows information for a specified snapshot.

Parameters:

snapshotId - the snapshot identifier

Returns:

the volume snapshot or null

delete

ActionResponse delete(String snapshotId)

Deletes a specified snapshot

Parameters:

snapshotId - the snapshot identifier

Returns:

the action response

update

ActionResponse update(String snapshotId,
                      String name,
                      String description)

Updates the Name and/or Description for the specified snapshot

Parameters:

snapshotId - the snapshot identifier

name - the new name

description - the new description

Returns:

the action response

create

VolumeSnapshot create(VolumeSnapshot snapshot)

Creates a snapshot, which is a point-in-time copy of a volume. You can create a volume from the snapshot.

NOTE: the volume ID within the snapshot must be set or an NullPointerException will be thrown

Parameters:

snapshot - the snapshot to create

Returns:

the newly created snapshot