Interface ArchiveApi


public interface ArchiveApi
Provides synchronous access to Archive requests.

See Also:
  • Method Details

    • list

      @Named("archive:list") @POST @Path("/archive/list/format/json") @Consumes("application/json") com.google.common.collect.FluentIterable<Archive> list()
      Lists all active disks on this account.
    • get

      @Named("archive:details") @POST @Path("/archive/details/format/json") @Consumes("application/json") Archive get(@FormParam("username") 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
    • createWithCredentialsAndSize

      @Named("archive:create") @POST @Path("/archive/create/format/json") @Consumes("application/json") Archive createWithCredentialsAndSize(@FormParam("username") String username, @FormParam("password") String password, @FormParam("size") 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
    • delete

      @Named("archive:delete") @POST @Path("/archive/delete/format/json") void delete(@FormParam("username") String username)
      Delete an archive volume. All files on the volume
      Parameters:
      username - the username associated with the archive
    • resize

      @Named("archive:resize") @POST @Path("/archive/resize/format/json") @Consumes("application/json") Archive resize(@FormParam("username") String username, @FormParam("size") 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 #getAllowedArguments for valid values
    • changePassword

      @Named("archive:changepassword") @POST @Path("/archive/changepassword/format/json") @Consumes("application/json") Archive changePassword(@FormParam("username") String username, @FormParam("password") String password)
      Change the password for an archive user.
      Parameters:
      username - the archive username
      password - the new password
    • getAllowedArguments

      @Named("archive:allowedarguments") @GET @Path("/archive/allowedarguments/format/json") @Consumes("application/json") ArchiveAllowedArguments getAllowedArguments()
      Lists the allowed arguments for some of the functions in this module such as archive size.