SnapshotApi (Apache jclouds 2.1.0 API)

```
public interface SnapshotApi
```
Provides synchronous access to CloudStack Snapshot features.

See Also:
http://download.cloud.com/releases/2.2.0/api/TOC_User.html

Method Summary

Methods
Modifier and Type	Method and Description
`AsyncCreateResponse`	`createSnapshot(String volumeId, CreateSnapshotOptions... options)` Creates an instant snapshot of a volume.
`SnapshotPolicy`	`createSnapshotPolicy(SnapshotPolicySchedule schedule, String numberToRetain, String timezone, String volumeId)` Creates a snapshot policy for the account.
`void`	`deleteSnapshot(String id)` Deletes a snapshot of a disk volume.
`void`	`deleteSnapshotPolicies(Iterable<String> id)` Deletes snapshot policies for the account.
`void`	`deleteSnapshotPolicy(String id)` Deletes a snapshot policy for the account.
`Snapshot`	`getSnapshot(String id)` Gets a snapshot by its ID.
`Set<SnapshotPolicy>`	`listSnapshotPolicies(String volumeId, ListSnapshotPoliciesOptions... options)` Lists snapshot policies.
`Set<Snapshot>`	`listSnapshots(ListSnapshotsOptions... options)` Lists all available snapshots for the account, matching the query described by the options.

Method Detail

createSnapshot

@Named(value="createSnapshot")
@GET
@Consumes(value="application/json")
AsyncCreateResponse createSnapshot(@QueryParam(value="volumeid")
                                                    String volumeId,
                                                    CreateSnapshotOptions... options)

Creates an instant snapshot of a volume.

Parameters:: volumeId - The ID of the disk volume; options - optional arguments
Returns:: an asynchronous job structure

listSnapshots
```
@Named(value="listSnapshots")
@GET
@Consumes(value="application/json")
Set<Snapshot> listSnapshots(ListSnapshotsOptions... options)
```
Lists all available snapshots for the account, matching the query described by the options.

Parameters:
options - optional arguments

Returns:
the snapshots matching the query

getSnapshot

@Named(value="listSnapshots")
@GET
@Consumes(value="application/json")
Snapshot getSnapshot(@QueryParam(value="id")
                                      String id)

Gets a snapshot by its ID.

Parameters:: id - the snapshot ID
Returns:: the snapshot with the requested ID

deleteSnapshot

@Named(value="deleteSnapshot")
@GET
@Consumes(value="application/json")
void deleteSnapshot(@QueryParam(value="id")
                                     String id)

Deletes a snapshot of a disk volume.

Parameters:: id - The ID of the snapshot

createSnapshotPolicy

@Named(value="createSnapshotPolicy")
@GET
@Consumes(value="application/json")
SnapshotPolicy createSnapshotPolicy(SnapshotPolicySchedule schedule,
                                                     @QueryParam(value="maxsnaps")
                                                     String numberToRetain,
                                                     @QueryParam(value="timezone")
                                                     String timezone,
                                                     @QueryParam(value="volumeid")
                                                     String volumeId)

Creates a snapshot policy for the account.

Parameters:: schedule - how to schedule snapshots; numberToRetain - maximum number of snapshots to retain; timezone - Specifies a timezone for this command. For more information on the timezone parameter, see Time Zone Format.; volumeId - the ID of the disk volume
Returns:: the newly-created snapshot policy

deleteSnapshotPolicy

@Named(value="deleteSnapshotPolicies")
@GET
@Consumes(value="application/json")
void deleteSnapshotPolicy(@QueryParam(value="id")
                                           String id)

Deletes a snapshot policy for the account.

Parameters:: id - The ID of the snapshot policy

deleteSnapshotPolicies

@Named(value="deleteSnapshotPolicies")
@GET
@Consumes(value="application/json")
void deleteSnapshotPolicies(Iterable<String> id)

Deletes snapshot policies for the account.

Parameters:: id - IDs of snapshot policies

listSnapshotPolicies

@Named(value="listSnapshotPolicies")
@GET
@Consumes(value="application/json")
Set<SnapshotPolicy> listSnapshotPolicies(@QueryParam(value="volumeid")
                                                          String volumeId,
                                                          ListSnapshotPoliciesOptions... options)

Lists snapshot policies.

Parameters:: volumeId - the ID of the disk volume; options - optional arguments
Returns:: the snapshot policies matching the query

Interface SnapshotApi