SnapshotApi (Apache jclouds 2.1.0 API)

@Consumes(value="application/json")
@Path(value="/snapshots")
public interface SnapshotApi

Provides access to Volume Snapshots API.

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

@Named(value="snapshot:list")
@GET
com.google.common.collect.FluentIterable<? extends Snapshot> list()

Returns a summary list of Snapshots.

Returns:: The list of Snapshots

listInDetail

@Named(value="snapshot:list")
@GET
@Path(value="/detail")
com.google.common.collect.FluentIterable<? extends Snapshot> listInDetail()

Returns a detailed list of Snapshots.

Returns:: The list of Snapshots

get

@Named(value="snapshot:get")
@GET
@Path(value="/{id}")
@Nullable
Snapshot get(@PathParam(value="id")
                                   String snapshotId)

Return data about the given Snapshot.

Parameters:: snapshotId - Id of the Snapshot
Returns:: Details of a specific Snapshot

create

@Named(value="snapshot:create")
@POST
@Produces(value="application/json")
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

@Named(value="snapshot:delete")
@DELETE
@Path(value="/{id}")
boolean delete(@PathParam(value="id")
                               String snapshotId)

Delete a Snapshot.

Parameters:: snapshotId - Id of the Snapshot
Returns:: true if successful, false otherwise