org.jclouds.openstack.cinder.v1.features

Interface SnapshotApi

public interface SnapshotApi

Provides synchronous access to Volume Snapshots via their REST API.

Author:

Everett Toews

See Also:

SnapshotAsyncApi, API Doc

Method Summary

Methods

Modifier and Type	Method and Description
Snapshot	create(String volumeId, CreateSnapshotOptions... options) Creates a new Snapshot.
boolean	delete(String snapshotId) Delete a Snapshot.
Snapshot	get(String snapshotId) Return data about the given Snapshot.
com.google.common.collect.FluentIterable<? extends Snapshot>	list() Returns a summary list of Snapshots.
com.google.common.collect.FluentIterable<? extends Snapshot>	listInDetail() Returns a detailed list of Snapshots.

Method Detail

list

com.google.common.collect.FluentIterable<? extends Snapshot> list()

Returns a summary list of Snapshots.

Returns:

The list of Snapshots

listInDetail

com.google.common.collect.FluentIterable<? extends Snapshot> listInDetail()

Returns a detailed list of Snapshots.

Returns:

The list of Snapshots

get

Snapshot get(String snapshotId)

Return data about the given Snapshot.

Parameters:

snapshotId - Id of the Snapshot

Returns:

Details of a specific Snapshot

create

Snapshot create(String volumeId,
              CreateSnapshotOptions... options)

Creates a new Snapshot. The Volume status must be Available.

Parameters:

volumeId - The Volume Id from which to create the Snapshot

options - See CreateSnapshotOptions

Returns:

The new Snapshot

delete

boolean delete(String snapshotId)

Delete a Snapshot.

Parameters:

snapshotId - Id of the Snapshot

Returns:

true if successful, false otherwise