org.jclouds.glesys.features

Interface ArchiveApi

public interface ArchiveApi

Provides synchronous access to Archive requests.

Author:

Adam Lowe

See Also:

ArchiveAsyncApi,

Method Summary

Methods

Modifier and Type	Method and Description
Archive	changeArchivePassword(String username, String password) Change the password for an archive user.
Archive	createArchive(String username, String password, int size) Create a new backup volume.
void	deleteArchive(String username) Delete an archive volume.
Archive	getArchive(String username) Get detailed information about an archive volume.
ArchiveAllowedArguments	getArchiveAllowedArguments() Lists the allowed arguments for some of the functions in this module such as archive size.
Set<Archive>	listArchives() Lists all active disks on this account.
Archive	resizeArchive(String username, int size) Resize an archive volume.

Method Detail

listArchives

Set<Archive> listArchives()

Lists all active disks on this account.

getArchive

Archive getArchive(String username)

Get detailed information about an archive volume.

Parameters:

username - the username associated with the archive

Returns:

the archive information or null if not found

createArchive

Archive createArchive(String username,
                    String password,
                    int size)

Create a new backup volume.

Parameters:

username - the archive username, this must be prefixed by Glesys account name (in lower case) and an underscore, ex. "c100005_archive1"

password - the new password

size - the new size required in GB

deleteArchive

void deleteArchive(String username)

Delete an archive volume. All files on the volume

Parameters:

username - the username associated with the archive

resizeArchive

Archive resizeArchive(String username,
                    int size)

Resize an archive volume. It is only possible to upgrade the size of the disk. Downgrading is currently not supported. If you need to downgrade, please create a new volume and transfer all data to the new volume. Then delete the old volume.

Parameters:

username - the username associated with the archive

size - the new size required, see #getArchiveAllowedArguments for valid values

changeArchivePassword

Archive changeArchivePassword(String username,
                            String password)

Change the password for an archive user.

Parameters:

username - the archive username

password - the new password

getArchiveAllowedArguments

ArchiveAllowedArguments getArchiveAllowedArguments()

Lists the allowed arguments for some of the functions in this module such as archive size.