org.jclouds.cloudsigma2

Interface CloudSigma2Api

All Superinterfaces:

AutoCloseable, Closeable

@Consumes(value="application/json")
public interface CloudSigma2Api
extends Closeable

Provides synchronous access to CloudSigma v2 API.

See Also:

Method Summary

Modifier and Type	Method and Description
SubscriptionCalculator	calculateSubscriptions(Iterable<CalcSubscription> subscriptions) This is identical to the listSubscriptions(), except that subscriptions are not actually bought.
DriveInfo	cloneDrive(String sourceUuid, DriveInfo driveInfo) Clones a drive.
LibraryDrive	cloneLibraryDrive(String uuid, LibraryDrive libraryDrive) If a library drive is not a CDROM, you have to clone it in your account in order to use it.
ServerInfo	cloneServer(String uuid) Clones a server.
void	closeServerVCNTunnel(String uuid) Closes a VNC tunnel to a server with specific UUID.
DriveInfo	createDrive(DriveInfo createDrive) Creates a new drive
List<DriveInfo>	createDrives(List<DriveInfo> createDrives) Creates multiple new drives
List<FirewallPolicy>	createFirewallPolicies(List<FirewallPolicy> firewallPolicies) Creates firewall policies.
FirewallPolicy	createFirewallPolicy(FirewallPolicy firewallPolicy) Creates a firewall policy.
ServerInfo	createServer(ServerInfo createServer) Creates a new virtual server or multiple servers.
List<ServerInfo>	createServers(Iterable<ServerInfo> servers) create a new servers
Subscription	createSubscription(CreateSubscriptionRequest subscriptionRequest) Creates a new subscription.
List<Subscription>	createSubscriptions(List<CreateSubscriptionRequest> subscriptionRequest) Creates a new subscription.
Tag	createTag(Tag tag) Creates a new tag
List<Tag>	createTags(List<Tag> tags) Creates a multiple new tags
void	deleteDrive(String uuid) Deletes a single mounted or unmounted drive.
void	deleteDrives(Iterable<String> uuids) Deletes multiple mounted or unmounted drives specified by their UUID’s.
void	deleteFirewallPolicy(String uuid) Deletes a single firewall policy.
void	deleteServer(String uuid) Deletes a single server.
void	deleteServers(Iterable<String> uuids) Deletes multiple servers specified by their UUID’s.
void	deleteTag(String uuid) Deletes a single tag.
DriveInfo	editDrive(String sourceUuid, DriveInfo driveInfo) Edits a mounted or unmounted drive.
FirewallPolicy	editFirewallPolicy(String uuid, FirewallPolicy firewallPolicy) Update an existing firewall policy
IPInfo	editIP(String uuid, IPInfo ipInfo) Currently only IP meta field can be edited.
ProfileInfo	editProfileInfo(ProfileInfo profile) Edits a user profile.
ServerInfo	editServer(String uuid, ServerInfo server) Edits a server.
Tag	editTag(String uuid, Tag tag) Edits a tag.
VLANInfo	editVLAN(String uuid, VLANInfo vlanInfo) Currently only VLAN meta field can be edited.
void	enableSubscriptionAutorenew(String id) Toggles the autorenew flag of the subscription.
void	extendSubscription(String id) Extends the subscription.
AccountBalance	getAccountBalance() Get the balance and currency of the current account.
CurrentUsage	getCurrentUsage() Get the current usage of the user.
DriveInfo	getDriveInfo(String uuid) Gets detailed information for drive identified by drive uuid
FirewallPolicy	getFirewallPolicy(String uuid) Gets firewall policy.
IPInfo	getIPInfo(String uuid) Gets detailed information for IP identified by IP uuid.
LibraryDrive	getLibraryDrive(String uuid) Gets detailed information for library drive identified by uuid.
Pricing	getPricing() Gets the pricing information that are applicable to the cloud.
ProfileInfo	getProfileInfo() Gets the user profile.
ServerAvailabilityGroup	getServerAvailabilityGroup(String uuid) Queries which other servers share same physical host with the given one.
ServerInfo	getServerInfo(String uuid) Gets detailed information for server identified by server uuid.
Subscription	getSubscription(String id) Returns requested subscription
Tag	getTagInfo(String uuid) Gets detailed information for tag identified by tag uuid.
VLANInfo	getVLANInfo(String uuid) Gets detailed information for VLAN identified by VLAN uuid.
PagedIterable<Discount>	listDiscounts() Get discount information.
PaginatedCollection<Discount>	listDiscounts(PaginationOptions options) Get discount information.
PagedIterable<Drive>	listDrives() Gets the list of drives to which the authenticated user has access.
List<DriveInfo>	listDrives(DrivesListRequestFieldsGroup fields, int limit) Gets the list of drives to which the authenticated user has access.
PaginatedCollection<Drive>	listDrives(PaginationOptions options) Gets the list of drives to which the authenticated user has access.
PagedIterable<DriveInfo>	listDrivesInfo() Gets the detailed list of drives with additional information to which the authenticated user has access.
PaginatedCollection<DriveInfo>	listDrivesInfo(PaginationOptions options) Gets the detailed list of drives with additional information to which the authenticated user has access.
PagedIterable<FirewallPolicy>	listFirewallPolicies() Gets the list of firewall policies to which the authenticated user has access.
PaginatedCollection<FirewallPolicy>	listFirewallPolicies(PaginationOptions options) Gets the list of firewall policies to which the authenticated user has access.
PagedIterable<FirewallPolicy>	listFirewallPoliciesInfo() Gets a detailed list of firewall policies to which the authenticated user has access.
PaginatedCollection<FirewallPolicy>	listFirewallPoliciesInfo(PaginationOptions options) Gets a detailed list of firewall policies to which the authenticated user has access.
PagedIterable<IPInfo>	listIPInfo() Gets the detailed list of IPs with additional information to which the authenticated user has access.
PaginatedCollection<IPInfo>	listIPInfo(PaginationOptions options) Gets the detailed list of IPs with additional information to which the authenticated user has access.
PagedIterable<IP>	listIPs() Gets the list of IPs to which the authenticated user has access.
PaginatedCollection<IP>	listIPs(PaginationOptions options) Gets the list of IPs to which the authenticated user has access.
PagedIterable<LibraryDrive>	listLibraryDrives() Gets the list of library drives to which the authenticated user has access.
PaginatedCollection<LibraryDrive>	listLibraryDrives(PaginationOptions options) Gets the list of library drives to which the authenticated user has access.
PagedIterable<License>	listLicenses() Get the licenses available on the cloud.
PaginatedCollection<License>	listLicenses(PaginationOptions options) Get the licenses available on the cloud.
List<List<String>>	listServerAvailabilityGroup()
PagedIterable<Server>	listServers() Gets the list of servers to which the authenticated user has access.
PaginatedCollection<Server>	listServers(PaginationOptions options) Gets the list of servers to which the authenticated user has access.
PagedIterable<ServerInfo>	listServersInfo() Gets the detailed list of servers to which the authenticated user has access.
PaginatedCollection<ServerInfo>	listServersInfo(PaginationOptions options) Gets the detailed list of servers to which the authenticated user has access.
PagedIterable<Subscription>	listSubscriptions() Gets the list of subscriptions of the user.
PaginatedCollection<Subscription>	listSubscriptions(PaginationOptions options) Gets the list of subscriptions of the user.
PagedIterable<Tag>	listTags() Gets the list of tags to which the authenticated user has access.
PaginatedCollection<Tag>	listTags(PaginationOptions options) Gets the list of tags to which the authenticated user has access.
PagedIterable<Transaction>	listTransactions() Get the transactions for the account.
PaginatedCollection<Transaction>	listTransactions(PaginationOptions options) Get the transactions for the account.
PagedIterable<VLANInfo>	listVLANInfo() Gets the list of VLANs to which the authenticated user has access.
PaginatedCollection<VLANInfo>	listVLANInfo(PaginationOptions options) Gets the list of VLANs to which the authenticated user has access.
PagedIterable<VLANInfo>	listVLANs() Gets the list of VLANs to which the authenticated user has access.
PaginatedCollection<VLANInfo>	listVLANs(PaginationOptions options) Gets the list of VLANs to which the authenticated user has access.
void	openServerVNCTunnel(String uuid) Opens a VNC tunnel to a server with specific UUID.
void	startServer(String uuid) Starts a server with specific UUID.
void	startServerInSeparateAvailabilityGroup(String uuid, List<String> uuidGroup) Starts a server with specific UUID assuring that it is started on a different physical infrastructure host from the other servers specified in the avoid argument which is a single server UUID or a comma-separated list of server UUIDs.
void	stopServer(String uuid) Stops a server with specific UUID.

Methods inherited from interface java.io.Closeable

close

Method Detail

listDrives

@GET
 @Path(value="/drives/")
PagedIterable<Drive> listDrives()

Gets the list of drives to which the authenticated user has access.

Returns:

list of drives or empty list if no drives are found

listDrives

@GET
 @Path(value="/drives/")
PaginatedCollection<Drive> listDrives(PaginationOptions options)

Gets the list of drives to which the authenticated user has access.

Returns:

PaginatedCollection of drives

listDrives

@GET
 @Path(value="/drives/")
List<DriveInfo> listDrives(@QueryParam(value="fields")
                                                         DrivesListRequestFieldsGroup fields,
                                                         @DefaultValue(value="0") @QueryParam(value="limit")
                                                         int limit)

Gets the list of drives to which the authenticated user has access.

Parameters:

fields - A set of field names specifying the returned fields

limit - number of drives to show

Returns:

or empty set if no drives are found

listDrivesInfo

@GET
 @Path(value="/drives/detail/")
PagedIterable<DriveInfo> listDrivesInfo()

Gets the detailed list of drives with additional information to which the authenticated user has access.

Returns:

list of drives or empty list if no drives are found

listDrivesInfo

@GET
 @Path(value="/drives/detail/")
PaginatedCollection<DriveInfo> listDrivesInfo(PaginationOptions options)

Gets the detailed list of drives with additional information to which the authenticated user has access.

Returns:

PaginatedCollection of drives

getDriveInfo

@GET
 @Path(value="/drives/{uuid}/")
DriveInfo getDriveInfo(@PathParam(value="uuid")
                                                            String uuid)

Gets detailed information for drive identified by drive uuid

Parameters:

uuid - drive uuid to get

Returns:

null, if not found

createDrive

@POST
 @Path(value="/drives/")
DriveInfo createDrive(DriveInfo createDrive)

Creates a new drive

Parameters:

createDrive - required parameters: name, size, media

Returns:

newly created drive

createDrives

@POST
 @Path(value="/drives/")
List<DriveInfo> createDrives(List<DriveInfo> createDrives)

Creates multiple new drives

Parameters:

createDrives - required parameters: name, size, media

Returns:

newly created drives

deleteDrive

@DELETE
 @Path(value="/drives/{uuid}/")
void deleteDrive(@PathParam(value="uuid")
                                                         String uuid)

Deletes a single mounted or unmounted drive.

Parameters:

uuid - what to delete

deleteDrives

@DELETE
 @Path(value="/drives/")
void deleteDrives(Iterable<String> uuids)

Deletes multiple mounted or unmounted drives specified by their UUID’s.

Parameters:

uuids - what drives to delete

editDrive

@PUT
 @Path(value="/drives/{uuid}/")
DriveInfo editDrive(@PathParam(value="uuid")
                                                         String sourceUuid,
                                                         DriveInfo driveInfo)

Edits a mounted or unmounted drive. If mounted, the server mounted on should be stopped.

Parameters:

sourceUuid - source drive to edit

driveInfo - drive parameters to change

Returns:

changed drive

cloneDrive

@POST
 @Path(value="/drives/{uuid}/action/?do=clone")
DriveInfo cloneDrive(@PathParam(value="uuid")
                                                                           String sourceUuid,
                                                                           @Nullable
                                                                           DriveInfo driveInfo)

Clones a drive. Request body is optional and any or all of the key/value pairs can be omitted.

Parameters:

sourceUuid - source drive to clone

driveInfo - drive parameters to change

Returns:

new drive

listLibraryDrives

@GET
 @Path(value="/libdrives/")
PagedIterable<LibraryDrive> listLibraryDrives()

Gets the list of library drives to which the authenticated user has access.

Returns:

list of library drives to which the authenticated user has access

listLibraryDrives

@GET
 @Path(value="/libdrives/")
PaginatedCollection<LibraryDrive> listLibraryDrives(PaginationOptions options)

Gets the list of library drives to which the authenticated user has access.

Returns:

PaginatedCollection of library drives

getLibraryDrive

@GET
 @Path(value="/libdrives/{uuid}/")
LibraryDrive getLibraryDrive(@PathParam(value="uuid")
                                                                     String uuid)

Gets detailed information for library drive identified by uuid.

Parameters:

uuid - uuid of library drive to be listed

Returns:

drive information or null if not found

cloneLibraryDrive

@POST
 @Path(value="/libdrives/{uuid}/action/?do=clone")
LibraryDrive cloneLibraryDrive(@PathParam(value="uuid")
                                                                                        String uuid,
                                                                                        @Nullable
                                                                                        LibraryDrive libraryDrive)

If a library drive is not a CDROM, you have to clone it in your account in order to use it.

Parameters:

uuid - uuid of library drive to clone

libraryDrive - cloned drive

Returns:

cloned drive information or null if not found

listServers

@GET
 @Path(value="/servers/")
PagedIterable<Server> listServers()

Gets the list of servers to which the authenticated user has access.

Returns:

list of servers or empty list if no servers are found

listServers

@GET
 @Path(value="/servers/")
PaginatedCollection<Server> listServers(PaginationOptions options)

Gets the list of servers to which the authenticated user has access.

Returns:

PaginatedCollection of servers

listServersInfo

@GET
 @Path(value="/servers/detail/")
PagedIterable<ServerInfo> listServersInfo()

Gets the detailed list of servers to which the authenticated user has access.

Returns:

list of servers or empty list if no servers are found

listServersInfo

@GET
 @Path(value="/servers/detail/")
PaginatedCollection<ServerInfo> listServersInfo(PaginationOptions options)

Gets the detailed list of servers to which the authenticated user has access.

Returns:

PaginatedCollection of servers

createServer

@POST
 @Path(value="/servers/")
ServerInfo createServer(ServerInfo createServer)

Creates a new virtual server or multiple servers. The minimial amount of information you need to set is: cpu memory name vncPassword

Parameters:

createServer - required parameters: cpu, memory, name, vncPassword

Returns:

newly created server

createServers

@POST
 @Path(value="/servers/")
List<ServerInfo> createServers(Iterable<ServerInfo> servers)

create a new servers

Parameters:

servers - servers to create. Required parameters: cpu, memory, name, vncPassword

Returns:

newly created servers

editServer

@PUT
 @Path(value="/servers/{uuid}/")
ServerInfo editServer(@PathParam(value="uuid")
                                                            String uuid,
                                                            ServerInfo server)

Edits a server. Used also for attaching NIC’s and drives to servers.

Parameters:

uuid - server uuid

server - data to change

Returns:

modified server

deleteServer

@DELETE
 @Path(value="/servers/{uuid}/")
void deleteServer(@PathParam(value="uuid")
                                                           String uuid)

Deletes a single server.

Parameters:

uuid - uuid of server to delete

deleteServers

@DELETE
 @Path(value="/servers/")
void deleteServers(Iterable<String> uuids)

Deletes multiple servers specified by their UUID’s.

Parameters:

uuids - server uuids to delete

cloneServer

@POST
 @Path(value="/servers/{uuid}/action/?do=clone")
ServerInfo cloneServer(@PathParam(value="uuid")
                                                                              String uuid)

Clones a server. Empty body. Does cascading clone of server drives. IPs of the cloned server are set to DHCP. All other properties of the clone are equal to the original.

Parameters:

uuid - server what to clone

Returns:

cloned server

getServerInfo

@GET
 @Path(value="/servers/{uuid}/")
ServerInfo getServerInfo(@PathParam(value="uuid")
                                                               String uuid)

Gets detailed information for server identified by server uuid.

Parameters:

uuid - server uuid

Returns:

server info or null, if not found

startServer

@POST
 @Path(value="/servers/{uuid}/action/?do=start")
void startServer(@PathParam(value="uuid")
                                                                        String uuid)

Starts a server with specific UUID.

Parameters:

uuid - uuid of server to start

stopServer

@POST
 @Path(value="/servers/{uuid}/action/?do=stop")
void stopServer(@PathParam(value="uuid")
                                                                      String uuid)

Stops a server with specific UUID.

Parameters:

uuid - uuid of server to stop

startServerInSeparateAvailabilityGroup

@POST
 @Path(value="/servers/{uuid}/action/?do=start")
void startServerInSeparateAvailabilityGroup(@PathParam(value="uuid")
                                                                                                   String uuid,
                                                                                                   @QueryParam(value="avoid")
                                                                                                   List<String> uuidGroup)

Starts a server with specific UUID assuring that it is started on a different physical infrastructure host from the other servers specified in the avoid argument which is a single server UUID or a comma-separated list of server UUIDs. This way the server specified by uuid is run in a distinct availability group from the other listed servers. Note that it might not always be possible to run a server in a different availability group, therefore the order of the avoid list also signifies the priority of avoiding other servers.

Parameters:

uuid - uuid of server to start

uuidGroup - availability group to avoid

openServerVNCTunnel

@POST
 @Path(value="/servers/{uuid}/action/?do=open_vnc")
void openServerVNCTunnel(@PathParam(value="uuid")
                                                                                   String uuid)

Opens a VNC tunnel to a server with specific UUID.

Parameters:

uuid - uuid of server to open VNC tunnel

closeServerVCNTunnel

@POST
 @Path(value="/servers/{uuid}/action/?do=close_vnc")
void closeServerVCNTunnel(@PathParam(value="uuid")
                                                                                     String uuid)

Closes a VNC tunnel to a server with specific UUID.

Parameters:

uuid - uuid of server to close VNC tunnel

listServerAvailabilityGroup

@GET
 @Path(value="/servers/availability_groups/")
List<List<String>> listServerAvailabilityGroup()

Returns:

which servers share same physical infrastructure host.

getServerAvailabilityGroup

@GET
 @PathParam(value="/servers/availability_groups/{uuid}/")
ServerAvailabilityGroup getServerAvailabilityGroup(@PathParam(value="uuid")
                                                                                                                  String uuid)

Queries which other servers share same physical host with the given one.

Parameters:

uuid - Uuid of server to find availability group

Returns:

an array holding server UUIDs. The response includes also the UUID of the queried server.

listFirewallPolicies

@GET
 @Path(value="/fwpolicies/")
PagedIterable<FirewallPolicy> listFirewallPolicies()

Gets the list of firewall policies to which the authenticated user has access.

Returns:

list of firewall policies to which the authenticated user has access.

listFirewallPolicies

@GET
 @Path(value="/fwpolicies/")
PaginatedCollection<FirewallPolicy> listFirewallPolicies(PaginationOptions options)

Gets the list of firewall policies to which the authenticated user has access.

Returns:

PaginatedCollection of firewall policies

listFirewallPoliciesInfo

@GET
 @Path(value="/fwpolicies/detail/")
PagedIterable<FirewallPolicy> listFirewallPoliciesInfo()

Gets a detailed list of firewall policies to which the authenticated user has access.

Returns:

list of firewall policies to which the authenticated user has access.

listFirewallPoliciesInfo

@GET
 @Path(value="/fwpolicies/detail/")
PaginatedCollection<FirewallPolicy> listFirewallPoliciesInfo(PaginationOptions options)

Gets a detailed list of firewall policies to which the authenticated user has access.

Returns:

PaginatedCollection of firewall policies

getFirewallPolicy

@GET
 @Path(value="/fwpolicies/{uuid}/")
FirewallPolicy getFirewallPolicy(@PathParam(value="uuid")
                                                                          String uuid)

Gets firewall policy.

Returns:

firewall policy

createFirewallPolicies

@POST
 @Path(value="/fwpolicies/")
List<FirewallPolicy> createFirewallPolicies(List<FirewallPolicy> firewallPolicies)

Creates firewall policies.

Parameters:

firewallPolicies - firewall policies to create

Returns:

list of created firewall policies

createFirewallPolicy

@POST
 @Path(value="/fwpolicies/")
FirewallPolicy createFirewallPolicy(FirewallPolicy firewallPolicy)

Creates a firewall policy.

Parameters:

firewallPolicy - firewall policy to create

Returns:

created firewall policy

editFirewallPolicy

@PUT
 @Path(value="/fwpolicies/{uuid}/")
FirewallPolicy editFirewallPolicy(@PathParam(value="uuid")
                                                                           String uuid,
                                                                           FirewallPolicy firewallPolicy)

Update an existing firewall policy

Parameters:

uuid - uuid of policy to update

firewallPolicy - firewall policy data to update

Returns:

updated firewall policy

deleteFirewallPolicy

@DELETE
 @Path(value="/fwpolicies/{uuid}/")
void deleteFirewallPolicy(@PathParam(value="uuid")
                                                                      String uuid)

Deletes a single firewall policy.

Parameters:

uuid - uuid of firewall policy to delete

getVLANInfo

@GET
 @Path(value="/vlans/{uuid}/")
VLANInfo getVLANInfo(@PathParam(value="uuid")
                                                         String uuid)

Gets detailed information for VLAN identified by VLAN uuid.

Parameters:

uuid - uuid of VLAN to get

Returns:

null, if not found

listVLANs

@GET
 @Path(value="/vlans/")
PagedIterable<VLANInfo> listVLANs()

Gets the list of VLANs to which the authenticated user has access.

Returns:

list of VLANs or empty list if no vlans are found

listVLANs

@GET
 @Path(value="/vlans/")
PaginatedCollection<VLANInfo> listVLANs(PaginationOptions options)

Gets the list of VLANs to which the authenticated user has access.

Returns:

PaginatedCollection of VLANs

listVLANInfo

@GET
 @Path(value="/vlans/detail/")
PagedIterable<VLANInfo> listVLANInfo()

Gets the list of VLANs to which the authenticated user has access.

Returns:

list of VLANs or empty list if no vlans are found

listVLANInfo

@GET
 @Path(value="/vlans/detail/")
PaginatedCollection<VLANInfo> listVLANInfo(PaginationOptions options)

Gets the list of VLANs to which the authenticated user has access.

Returns:

PaginatedCollection of VLANs

editVLAN

@PUT
 @Path(value="/vlans/{uuid}/")
VLANInfo editVLAN(@PathParam(value="uuid")
                                                      String uuid,
                                                      VLANInfo vlanInfo)

Currently only VLAN meta field can be edited.

Parameters:

uuid - uuid of VLAN to edit

vlanInfo - data to change

Returns:

changed VLAN

listIPs

@GET
 @Path(value="/ips/")
PagedIterable<IP> listIPs()

Gets the list of IPs to which the authenticated user has access.

Returns:

list of IPs or empty list if no ips are found

listIPs

@GET
 @Path(value="/ips/")
PaginatedCollection<IP> listIPs(PaginationOptions options)

Gets the list of IPs to which the authenticated user has access.

Returns:

PaginatedCollection of IPs

listIPInfo

@GET
 @Path(value="/ips/detail/")
PagedIterable<IPInfo> listIPInfo()

Gets the detailed list of IPs with additional information to which the authenticated user has access.

Returns:

list of IPs or empty list if no ips are found

listIPInfo

@GET
 @Path(value="/ips/detail/")
PaginatedCollection<IPInfo> listIPInfo(PaginationOptions options)

Gets the detailed list of IPs with additional information to which the authenticated user has access.

Returns:

PaginatedCollection of IPs

getIPInfo

@GET
 @Path(value="/ips/{uuid}/")
IPInfo getIPInfo(@PathParam(value="uuid")
                                                   String uuid)

Gets detailed information for IP identified by IP uuid.

Parameters:

uuid - uuid of IP to get

Returns:

null, if not found

editIP

@PUT
 @Path(value="/ips/{uuid}/")
IPInfo editIP(@PathParam(value="uuid")
                                                String uuid,
                                                IPInfo ipInfo)

Currently only IP meta field can be edited.

Parameters:

uuid - uuid of IP to edit

ipInfo - data to change

Returns:

changed IP

listTags

@GET
 @Path(value="/tags/")
PagedIterable<Tag> listTags()

Gets the list of tags to which the authenticated user has access.

Returns:

list of tags to which the authenticated user has access

listTags

@GET
 @Path(value="/tags/")
PaginatedCollection<Tag> listTags(PaginationOptions options)

Gets the list of tags to which the authenticated user has access.

Returns:

PaginatedCollection of tags to which the authenticated user has access

getTagInfo

@GET
 @Path(value="/tags/{uuid}/")
Tag getTagInfo(@PathParam(value="uuid")
                                                  String uuid)

Gets detailed information for tag identified by tag uuid.

Parameters:

uuid - tag uuid

Returns:

detailed info of tag

editTag

@PUT
 @Path(value="/tags/{uuid}/")
Tag editTag(@PathParam(value="uuid")
                                               String uuid,
                                               Tag tag)

Edits a tag. It is possible to add or remove resources to a tag by replacing the resources list with a new one

Parameters:

uuid - tag uuid

tag - info to change

Returns:

detailed info of tag

createTag

@POST
 @Path(value="/tags/")
Tag createTag(Tag tag)

Creates a new tag

Parameters:

tag - tag to create

Returns:

created tag

deleteTag

@DELETE
 @Path(value="/tags/{uuid}/")
void deleteTag(@PathParam(value="uuid")
                                                     String uuid)

Deletes a single tag.

Parameters:

uuid - uuid of tag to delete

createTags

@POST
 @Path(value="/tags/")
List<Tag> createTags(List<Tag> tags)

Creates a multiple new tags

Parameters:

tags - tags to create

Returns:

created tags

getProfileInfo

@GET
 @Path(value="/profile/")
ProfileInfo getProfileInfo()

Gets the user profile.

Returns:

profile information

editProfileInfo

@PUT
 @Path(value="/profile/")
ProfileInfo editProfileInfo(ProfileInfo profile)

Edits a user profile.

Parameters:

profile - data to change

Returns:

info or null, if not found

getAccountBalance

@GET
 @Path(value="/balance/")
AccountBalance getAccountBalance()

Get the balance and currency of the current account.

Returns:

current account balance and currency

getCurrentUsage

@GET
 @Path(value="/currentusage/")
CurrentUsage getCurrentUsage()

Get the current usage of the user.

Returns:

current usage of the user

listSubscriptions

@GET
 @Path(value="/subscriptions/")
PagedIterable<Subscription> listSubscriptions()

Gets the list of subscriptions of the user.

Returns:

list of subscriptions of the user.

listSubscriptions

@GET
 @Path(value="/subscriptions/")
PaginatedCollection<Subscription> listSubscriptions(PaginationOptions options)

Gets the list of subscriptions of the user.

Returns:

PaginatedCollection of subscriptions of the user.

getSubscription

@GET
 @Path(value="/subscriptions/{id}/")
Subscription getSubscription(@PathParam(value="id")
                                                                       String id)

Returns requested subscription

Returns:

requested subscription.

calculateSubscriptions

@POST
 @Path(value="/subscriptioncalculator/")
SubscriptionCalculator calculateSubscriptions(Iterable<CalcSubscription> subscriptions)

This is identical to the listSubscriptions(), except that subscriptions are not actually bought.

Returns:

SubscriptionCalculator with subscriptions that are not actually bought.

createSubscription

@POST
 @Path(value="/subscriptions/")
Subscription createSubscription(CreateSubscriptionRequest subscriptionRequest)

Creates a new subscription. Subscription times are rounded to noon UTC, using the following rules: - End time is always rounded to the next noon. - Start time is rounded to the maximum between the current time an the previous noon. This means that subscriptions bought for now do start now, but subscriptions for the future start at the previous noon.

Parameters:

subscriptionRequest - subscription request object

Returns:

created subscription

createSubscriptions

@POST
 @Path(value="/subscriptions/")
List<Subscription> createSubscriptions(List<CreateSubscriptionRequest> subscriptionRequest)

Creates a new subscription. There is a limit of 500 subscriptions that can be purchased in one request. Subscription times are rounded to noon UTC, using the following rules: - End time is always rounded to the next noon. - Start time is rounded to the maximum between the current time an the previous noon. This means that subscriptions bought for now do start now, but subscriptions for the future start at the previous noon.

Parameters:

subscriptionRequest - parameters for new subscriptions

Returns:

new subscriptions

extendSubscription

@POST
 @Path(value="/subscriptions/{id}/action/?do=extend")
void extendSubscription(@PathParam(value="id")
                                                                                    String id)

Extends the subscription. An extended subscription is actually just another subscription that is linked to the original If a period or and end_time are specified in the request,they are used. If neither are specified, the creation length of the subscription is used.

A caveat to this is that a subscription created initially with an end_time, the exact interval is used. Subscriptions that are created with a period have the period parsed again in the context of the new start_time. An example would be a subscription created on the 1st of February with a period of ‘1 month’ will be extended for 31 days, but one that was created with an end date of 1st of March will be extended for 28 days.

If the specified subscription has actually been extended, it traverses and extends the last subscription in the chain.

Parameters:

id - id of subscription to extend

enableSubscriptionAutorenew

@POST
 @Path(value="/subscriptions/{id}/action/?do=auto_renew")
void enableSubscriptionAutorenew(@PathParam(value="id")
                                                                                                 String id)

Toggles the autorenew flag of the subscription.

Parameters:

id - id of subscription to enable autorenew

getPricing

@GET
 @Path(value="/pricing/")
Pricing getPricing()

Gets the pricing information that are applicable to the cloud. Subscription prices use a burst level of 0.

Returns:

pricing information that are applicable to the cloud.

listDiscounts

@GET
 @Path(value="/discount/")
PagedIterable<Discount> listDiscounts()

Get discount information.

Returns:

discount information.

listDiscounts

@GET
 @Path(value="/discount/")
PaginatedCollection<Discount> listDiscounts(PaginationOptions options)

Get discount information.

Returns:

PaginatedCollection of discount information.

listTransactions

@GET
 @Path(value="/ledger/")
PagedIterable<Transaction> listTransactions()

Get the transactions for the account.

Returns:

transactions for the account.

listTransactions

@GET
 @Path(value="/ledger/")
PaginatedCollection<Transaction> listTransactions(PaginationOptions options)

Get the transactions for the account.

Returns:

PaginatedCollection of account's transactions.

listLicenses

@GET
 @Path(value="/licenses/")
PagedIterable<License> listLicenses()

Get the licenses available on the cloud. The type of the license can be one of: install - These licenses are billed per installation, regardless of whether it is attached to a running guests or not. instance - These licenses are billed per running instance of a guest. A license attached to a guest that’s stopped is not billed. stub - These licenses are billed per a metric specified by the customer (i.e. per number of users license)

The user metric field specifies what attribute on the instance of the guest is used for determining the number of licenses. For example, “smp” will count one license for each CPU/core in the virtual machine.

Returns:

licenses available on the cloud

listLicenses

@GET
 @Path(value="/licenses/")
PaginatedCollection<License> listLicenses(PaginationOptions options)

Get the licenses available on the cloud. The type of the license can be one of: install - These licenses are billed per installation, regardless of whether it is attached to a running guests or not. instance - These licenses are billed per running instance of a guest. A license attached to a guest that’s stopped is not billed. stub - These licenses are billed per a metric specified by the customer (i.e. per number of users license)

The user metric field specifies what attribute on the instance of the guest is used for determining the number of licenses. For example, “smp” will count one license for each CPU/core in the virtual machine.

Returns:

PaginatedCollection of licenses available on the cloud