org.jclouds.cloudstack.features

Interface SnapshotAsyncClient

public interface SnapshotAsyncClient

Provides synchronous access to CloudStack Snapshot features.

Author:

Richard Downer

See Also:

SnapshotClient, http://download.cloud.com/releases/2.2.0/api/TOC_User.html

Method Summary

Methods

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

Method Detail

createSnapshot

com.google.common.util.concurrent.ListenableFuture<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

com.google.common.util.concurrent.ListenableFuture<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

com.google.common.util.concurrent.ListenableFuture<Snapshot> getSnapshot(long id)

Gets a snapshot by its ID.

Parameters:

id - the snapshot ID

Returns:

the snapshot with the requested ID

deleteSnapshot

com.google.common.util.concurrent.ListenableFuture<Void> deleteSnapshot(long id)

Deletes a snapshot of a disk volume.

Parameters:

id - The ID of the snapshot

Returns:

an asynchronous job structure

createSnapshotPolicy

com.google.common.util.concurrent.ListenableFuture<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

com.google.common.util.concurrent.ListenableFuture<Void> deleteSnapshotPolicy(long id)

Deletes a snapshot policy for the account.

Parameters:

id - The ID of the snapshot policy

Returns:

deleteSnapshotPolicies

com.google.common.util.concurrent.ListenableFuture<Void> deleteSnapshotPolicies(Iterable<Long> id)

Deletes snapshot policies for the account.

Parameters:

id - IDs of snapshot policies

Returns:

listSnapshotPolicies

com.google.common.util.concurrent.ListenableFuture<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