org.jclouds.cloudstack.features
Interface SnapshotClient


public interface SnapshotClient

Provides synchronous access to CloudStack Snapshot features.

Author:
Richard Downer
See Also:
SnapshotAsyncClient, http://download.cloud.com/releases/2.2.0/api/TOC_User.html

Method Summary
 AsyncCreateResponse createSnapshot(long volumeId, CreateSnapshotOptions... options)
          Creates an instant snapshot of a volume.
 SnapshotPolicy createSnapshotPolicy(SnapshotPolicySchedule schedule, long numberToRetain, String timezone, long volumeId)
          Creates a snapshot policy for the account.
 void deleteSnapshot(long id)
          Deletes a snapshot of a disk volume.
 void deleteSnapshotPolicies(Iterable<Long> id)
          Deletes snapshot policies for the account.
 void deleteSnapshotPolicy(long id)
          Deletes a snapshot policy for the account.
 Snapshot getSnapshot(long id)
          Gets a snapshot by its ID.
 Set<SnapshotPolicy> listSnapshotPolicies(long 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

AsyncCreateResponse createSnapshot(long 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

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

Snapshot getSnapshot(long id)
Gets a snapshot by its ID.

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

deleteSnapshot

void deleteSnapshot(long id)
Deletes a snapshot of a disk volume.

Parameters:
id - The ID of the snapshot

createSnapshotPolicy

SnapshotPolicy createSnapshotPolicy(SnapshotPolicySchedule schedule,
                                    long numberToRetain,
                                    String timezone,
                                    long 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

void deleteSnapshotPolicy(long id)
Deletes a snapshot policy for the account.

Parameters:
id - The ID of the snapshot policy

deleteSnapshotPolicies

void deleteSnapshotPolicies(Iterable<Long> id)
Deletes snapshot policies for the account.

Parameters:
id - IDs of snapshot policies

listSnapshotPolicies

Set<SnapshotPolicy> listSnapshotPolicies(long volumeId,
                                         ListSnapshotPoliciesOptions... options)
Lists snapshot policies.

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


Copyright © 2009-2012 jclouds. All Rights Reserved.