UpCloud (groovy-upcloud-api 0.0.7 API)

fi.linuxbox.upcloud.api.UpCloud

Top-level APIs.
This class provides following APIs:
- getting account information
- listing prices, zones, timezones, plans, and server sizes
- listing and creating servers, IP addresses, tags, and storages

Constructor Summary

Constructors
Constructor and description
`UpCloud (AbstractSession SESSION)`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`def`	`account(def... args)` Fetch UpCloud API account information for the session.
	`def`	`create(Resource resource, def... args)` Create a resource.
	`def`	`ipAddresses(def... args)` Fetch a list of all IP addresses associated with this session.
	`def`	`plans(def... args)` Fetch a list of available plans.
	`def`	`prices(def... args)` Fetch UpCloud prices for all zones.
	`def`	`serverSizes(def... args)` Fetch a list of available server configurations.
	`def`	`servers(def... args)` Fetch a list of all servers associated with this session.
	`def`	`storages(def... args)` Fetch a list of all storages.
	`def`	`tags(def... args)` Fetch a list of all tags associated with this account.
	`def`	`timezones(def... args)` Fetch a list of available timezones.
	`def`	`zones(def... args)` Fetch UpCloud zone list.

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class Object`	`wait, wait, wait, equals, toString, hashCode, getClass, notify, notifyAll`

- Constructor Detail
  - @Inject UpCloud(AbstractSession SESSION)
- Method Detail
  - def account(def... args)
    
    Fetch UpCloud API account information for the session.
    A 200 OK response will include an instance of Account in the account property.
```
     upcloud.account { resp, err ->
         assert resp?.account instanceof Account
     }
 
```
    Parameters:
    args - Request callbacks for the GET /account call.
    Returns:
    Whatever is returned by the AbstractSession for starting an asynchronous request.
    See Also:
    UpCloud API docs for GET /account
  - def create(Resource resource, def... args)
    
    Create a resource.
    For Server creation, a 202 Accepted response will include an instance of Server in the server property. The Server.state property will be maintenance since it will take awhile to create the server.
    
    For Storage creation, a 201 Created response will include an instance of Storage in the storage property.
    
    For IpAddress creation, a 201 Created response will include an instance of IpAddress in the ipAddress property.
    
    For Tag creation, a 200 OK response will include an instance of Tag in the tag property.
    
    Parameters:
    resource - Resource to create.
    args - Request callbacks for the POST call.
    Returns:
    Whatever is returned by the AbstractSession for starting an asynchronous request.
    See Also:
    UpCloud API docs for POST /server
    UpCloud API docs for POST /storage
    UpCloud API docs for POST /ip_address
    UpCloud API docs for POST /tag
  - def ipAddresses(def... args)
    
    Fetch a list of all IP addresses associated with this session.
    A 200 OK response will include a list of IpAddress instances in the ipAddresses property.
```
     upcloud.ipAddresses { resp, err ->
         assert resp?.ipAddresses instanceof List
         assert rest.ipAddresses.every { it instanceof IpAddress }
     }
 
```
    Parameters:
    args - Request callbacks for the GET /ip_address call.
    Returns:
    Whatever is returned by the AbstractSession for starting an asynchronous request.
    See Also:
    UpCloud API docs for GET /ip_address
  - def plans(def... args)
    
    Fetch a list of available plans.
    A 200 OK response will include a list of Plan instances in the plans property.
```
     upcloud.plans { resp, err ->
         assert resp?.plans instanceof List
         assert rest.plans.every { it instanceof Plan }
     }
 
```
    Parameters:
    args - Request callbacks for the GET /plan call.
    Returns:
    Whatever is returned by the AbstractSession for starting an asynchronous request.
    See Also:
    UpCloud API docs for GET /plan
  - def prices(def... args)
    
    Fetch UpCloud prices for all zones.
    A 200 OK response will include a list of Zone instances in the prices property.
```
     upcloud.prices { resp, err ->
         assert resp?.prices instanceof List
         assert rest.prices.every { it instanceof Zone }
     }
 
```
    When zones are listed via this API, they will not include Zone.id properties, but Zone.name properties instead. They are the same.
    
    Parameters:
    args - Request callbacks for the GET /price call.
    Returns:
    Whatever is returned by the AbstractSession for starting an asynchronous request.
    See Also:
    UpCloud API docs for GET /price
  - def serverSizes(def... args)
    
    Fetch a list of available server configurations.
    A 200 OK response will include a list of ServerSize instances in the serverSizes property.
```
     upcloud.serverSizes { resp, err ->
         assert resp?.serverSizes instanceof List
         assert rest.serverSizes.every { it instanceof ServerSize }
     }
 
```
    Parameters:
    args - Request callbacks for the GET /server_size call.
    Returns:
    Whatever is returned by the AbstractSession for starting an asynchronous request.
    See Also:
    UpCloud API docs for GET /server_size
  - def servers(def... args)
    
    Fetch a list of all servers associated with this session.
    A 200 OK response will include a list of Server instances in the servers property.
```
     upcloud.servers { resp, err ->
         assert resp?.servers instanceof List
         assert rest.servers.every { it instanceof Server }
     }
 
```
    Only the servers' most relevant information is returned by this operation. Further details on individual servers can be requested with the Server.load API.
    
    Parameters:
    args - Request callbacks for the GET /server call.
    Returns:
    Whatever is returned by the AbstractSession for starting an asynchronous request.
    See Also:
    UpCloud API docs for GET /server
  - def storages(def... args)
    
    Fetch a list of all storages.
    A 200 OK response will include a list of Storage instances in the storages property.
```
     upcloud.storages { resp, err ->
         assert resp?.storages instanceof List
         assert resp.storages.every { it instanceof Storage }
     }
 
```
    A keyword argument type can be used to narrow down the list. The type can be access type (public or private), or storage type (normal, backup, cdrom, or template), or favorite.
```
     upcloud.storages type: "template" { resp, err ->
     }
 
```
    Only the storages' most relevant information is returned by this operation. Further details on individual storage can be requested with the Storage.load API.
    
    Parameters:
    args.type - Optional filter for storages: public, private, normal, backup, cdrom, template, or favorite.
    args - Request callbacks for the GET /storage call.
    Returns:
    Whatever is returned by the AbstractSession for starting an asynchronous request.
    See Also:
    UpCloud API docs for GET /storage
  - def tags(def... args)
    
    Fetch a list of all tags associated with this account.
    A 200 OK response will include a list of Tag instances in the tags property.
```
     upcloud.tags { resp, err ->
         assert resp?.tags instanceof List
         assert resp.tags.every { it instanceof Tag }
     }
 
```
    Parameters:
    args - Request callbacks for the GET /tag call.
    Returns:
    Whatever is returned by the AbstractSession for starting an asynchronous request.
    See Also:
    UpCloud API docs for GET /tag
  - def timezones(def... args)
    
    Fetch a list of available timezones.
    A 200 OK response will include a list of Strings in the timezones property.
```
     upcloud.timezones { resp, err ->
         assert resp?.timezones instanceof List
         assert rest.timezones.every { it instanceof String }
     }
 
```
    Parameters:
    args - Request callbacks for the GET /timezone call.
    Returns:
    Whatever is returned by the AbstractSession for starting an asynchronous request.
    See Also:
    UpCloud API docs for GET /timezone
  - def zones(def... args)
    
    Fetch UpCloud zone list.
    A 200 OK response will include a list of Zone instances in the zones property.
```
     upcloud.zones { resp, err ->
         assert resp?.zones instanceof List
         assert rest.zones.every { it instanceof Zone }
     }
 
```
    When zones are listed via this API, they will not include Zone.name properties, but Zone.id properties instead. They are the same.
    
    Parameters:
    args - Request callbacks for the GET /zone call.
    Returns:
    Whatever is returned by the AbstractSession for starting an asynchronous request.
    See Also:
    UpCloud API docs for GET /zone

Summary:
Constructor
Method

| Detail:
Constructor
Method

Groovy Documentation

[Groovy] Class UpCloud

Constructor Summary

Methods Summary

Inherited Methods Summary

Constructor Detail

@Inject UpCloud(AbstractSession SESSION)

Method Detail

def account(def... args)

def create(Resource resource, def... args)

def ipAddresses(def... args)

def plans(def... args)

def prices(def... args)

def serverSizes(def... args)

def servers(def... args)

def storages(def... args)

def tags(def... args)

def timezones(def... args)

def zones(def... args)