DigitalOceanClient (DigitalOcean API Client in Java 2.0 API)

java.lang.Object
- com.myjeeva.digitalocean.impl.DigitalOceanClient

All Implemented Interfaces:

Constants, DigitalOcean
```
public class DigitalOceanClient
extends Object
implements DigitalOcean, Constants
```
DigitalOcean API client wrapper methods Implementation

Author:

Jeevanandam M. ([email protected])

Field Summary

Fields
Modifier and Type	Field and Description
`protected String`	`apiHost` DigitalOcean API Host is `api.digitalocean.com`
`protected String`	`apiVersion` DigitalOcean API version.
`protected String`	`authToken` OAuth Authorization Token for Accessing DigitalOcean API
`protected org.apache.http.client.HttpClient`	`httpClient` Http client

Fields inherited from interface com.myjeeva.digitalocean.common.Constants
DATE_FORMAT, FORM_URLENCODED_CONTENT_TYPE, HTTPS_SCHEME, JSON_CONTENT_TYPE, NO_CONTENT_JSON_STRUCT, PARAM_PAGE_NO, RATE_LIMIT_ELEMENT_NAME, RATE_LIMIT_JSON_STRUCT, START_PAGE_NO, URL_PATH_SEPARATOR, UTF_8

Constructor Summary

Constructors
Constructor and Description
`DigitalOceanClient(String authToken)`
`DigitalOceanClient(String apiVersion, String authToken)` DigitalOcean Client Constructor
`DigitalOceanClient(String apiVersion, String authToken, org.apache.http.client.HttpClient httpClient)` DigitalOcean Client Constructor

Method Summary

Methods
Modifier and Type	Method and Description
`Action`	`changeDropletKernel(Integer dropletId, Integer kernelId)` Method changes a OS kernel for given droplet
`Action`	`convertImage(Integer imageId)` Method allows you to convert image into snapshot
`Domain`	`createDomain(Domain domain)` Method creates a new domain name with an A record for the specified [ip_address].
`DomainRecord`	`createDomainRecord(String domainName, DomainRecord domainRecord)` Method creates a new domain record name with an given domain record values
`Droplet`	`createDroplet(Droplet droplet)` Method allows you to create a new droplet.
`Key`	`createKey(Key newKey)` Method allows you to add a new public SSH key to your account
`Delete`	`deleteDomain(String domainName)` Method deletes the specified domain from DNS control panel
`Delete`	`deleteDomainRecord(String domainName, Integer recordId)` Method deletes the specified domain record from domain.
`Delete`	`deleteDroplet(Integer dropletId)` Method destroys one of your droplet; this is irreversible.
`Delete`	`deleteImage(Integer imageId)` Method allows you to deletes an image.
`Delete`	`deleteKey(Integer sshKeyId)` Method will delete the SSH key from your account.
`Delete`	`deleteKey(String fingerprint)` Method will delete the SSH key from your account.
`Action`	`disableDropletBackups(Integer dropletId)` Method disables automatic backups from running to backup your droplet's data.
`Action`	`enableDropletIpv6(Integer dropletId)` Enabling IP v6 networking capability for droplet.
`Action`	`enableDropletPrivateNetworking(Integer dropletId)` Enabling private networking capability for droplet.
`Account`	`getAccountInfo()` Method returns account information for provided credentials
`Action`	`getActionInfo(Integer actionId)` To retrieve a specific action information by action ID
`Neighbors`	`getAllDropletNeighbors(Integer pageNo)` For an entire account; Method retrieves a list of any droplets that are running on the same physical server (any other droplets that share the same physical hardware).
`String`	`getApiVersion()`
`String`	`getAuthToken()`
`Actions`	`getAvailableActions(Integer pageNo)` Method return all the action informations, regardless of categories.
`Backups`	`getAvailableBackups(Integer dropletId, Integer pageNo)` Method returns all available snapshots for given droplet ID
`Domains`	`getAvailableDomains(Integer pageNo)` Method returns all of your available domains from DNS control panel
`Actions`	`getAvailableDropletActions(Integer dropletId, Integer pageNo)` Method return all the action informations; specific to given Droplet Id
`Droplets`	`getAvailableDroplets(Integer pageNo)` Method returns all active droplets that are currently running in your account.
`Actions`	`getAvailableImageActions(Integer imageId, Integer pageNo)` Method return all the action informations; specific to given Image Id
`Images`	`getAvailableImages(Integer pageNo)` Method returns all the available images that can be accessed by your OAuth Token.
`Images`	`getAvailableImages(Integer pageNo, ActionType type)` Method returns all the available images based on `type={distribution or application}` that can be accessed by your OAuth Token.
`Kernels`	`getAvailableKernels(Integer dropletId, Integer pageNo)` Method returns all available kernels for given droplet ID
`Keys`	`getAvailableKeys(Integer pageNo)` Method lists all the available public SSH keys in your account that can be added to a droplet.
`Regions`	`getAvailableRegions(Integer pageNo)` Method returns all the available regions within the DigitalOcean cloud.
`Sizes`	`getAvailableSizes(Integer pageNo)` Method returns all the available sizes that can be used to create a droplet.
`Snapshots`	`getAvailableSnapshots(Integer dropletId, Integer pageNo)` Method returns all available snapshots for given droplet ID
`Domain`	`getDomainInfo(String domainName)` Method returns the specified domain attributes and zone file info.
`DomainRecord`	`getDomainRecordInfo(String domainName, Integer recordId)` Method returns the specified domain record.
`DomainRecords`	`getDomainRecords(String domainName)` Method returns all of your current domain records from DNS control panel for given domain.
`Droplet`	`getDropletInfo(Integer dropletId)` Method returns complete information for given droplet ID
`Droplets`	`getDropletNeighbors(Integer dropletId, Integer pageNo)` For an individual droplet; Method retrieves a list of droplets that are running on the same physical server (any other droplets that share the same physical hardware).
`org.apache.http.client.HttpClient`	`getHttpClient()`
`Image`	`getImageInfo(Integer imageId)` Method retrieves the attributes of an image.
`Image`	`getImageInfo(String slug)` Method retrieves the attributes of an image.
`Key`	`getKeyInfo(Integer sshKeyId)` Method shows a specific public SSH key information from your account that can be added to a droplet.
`Key`	`getKeyInfo(String fingerprint)` Method shows a specific public SSH key information from your account that can be added to a droplet.
`Images`	`getUserImages(Integer pageNo)` Method retrieves only the private images of a user
`Action`	`powerCycleDroplet(Integer dropletId)` Method allows you to power cycle a droplet.
`Action`	`powerOffDroplet(Integer dropletId)` Method allows you to poweroff a running droplet.
`Action`	`powerOnDroplet(Integer dropletId)` Method allows you to poweron a powered off droplet.
`Action`	`rebootDroplet(Integer dropletId)` Method allows you to reboot a droplet.
`Action`	`rebuildDroplet(Integer dropletId, Integer imageId)` Method allows you to reinstall a droplet with a default image.
`Action`	`renameDroplet(Integer dropletId, String name)` Method renames the droplet to the specified name.
`Action`	`resetDropletPassword(Integer dropletId)` Method will reset the root password for a droplet.
`Action`	`resizeDroplet(Integer dropletId, String size)` Method allows you to resize a specific droplet to a different size.
`Action`	`restoreDroplet(Integer dropletId, Integer imageId)` Method allows you to restore a droplet with a previous image or snapshot.
`void`	`setApiVersion(String apiVersion)`
`void`	`setAuthToken(String authToken)`
`void`	`setHttpClient(org.apache.http.client.HttpClient httpClient)`
`Action`	`shutdownDroplet(Integer dropletId)` Method allows you to shutdown a running droplet.
`Action`	`takeDropletSnapshot(Integer dropletId)` Method allows you to take a snapshot of the running droplet, which can later be restored or used to create a new droplet from the same image.
`Action`	`takeDropletSnapshot(Integer dropletId, String snapshotName)` Method allows you to take a snapshot of the running droplet, which can later be restored or used to create a new droplet from the same image.
`Action`	`transferImage(Integer imageId, String regionSlug)` Method allows you to transfer an image to a specified region.
`DomainRecord`	`updateDomainRecord(String domainName, Integer recordId, String name)` method edits an existing domain record of the given domain.
`Image`	`updateImage(Image image)` Method updates the given details for an image.
`Key`	`updateKey(Integer sshKeyId, String newSshKeyName)` Method allows you to modify an existing SSH key in your account.
`Key`	`updateKey(String fingerprint, String newSshKeyName)` Method allows you to modify an existing SSH key in your account.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - httpClient
```
protected org.apache.http.client.HttpClient httpClient
```
    Http client
  - authToken
```
protected String authToken
```
    OAuth Authorization Token for Accessing DigitalOcean API
  - apiVersion
```
protected String apiVersion
```
    DigitalOcean API version. defaults to v2 from constructor
  - apiHost
```
protected String apiHost
```
    DigitalOcean API Host is api.digitalocean.com
- Constructor Detail
  - DigitalOceanClient
```
public DigitalOceanClient(String authToken)
```
  - DigitalOceanClient
```
public DigitalOceanClient(String apiVersion,
                  String authToken)
```
    DigitalOcean Client Constructor
    
    Parameters:
    apiVersion - a String object
    authToken - a String object
  - DigitalOceanClient
```
public DigitalOceanClient(String apiVersion,
                  String authToken,
                  org.apache.http.client.HttpClient httpClient)
```
    DigitalOcean Client Constructor
    
    Parameters:
    apiVersion - a String object
    authToken - a String object
    httpClient - a HttpClient object
- Method Detail
  - getHttpClient
```
public org.apache.http.client.HttpClient getHttpClient()
```
    Returns:
    the httpClient
  - setHttpClient
```
public void setHttpClient(org.apache.http.client.HttpClient httpClient)
```
    Parameters:
    httpClient - the httpClient to set
  - getAuthToken
```
public String getAuthToken()
```
    Returns:
    the authToken
  - setAuthToken
```
public void setAuthToken(String authToken)
```
    Parameters:
    authToken - the authToken to set
  - getApiVersion
```
public String getApiVersion()
```
    Returns:
    the apiVersion
  - setApiVersion
```
public void setApiVersion(String apiVersion)
```
    Parameters:
    apiVersion - the apiVersion to set
  - getAvailableDroplets
```
public Droplets getAvailableDroplets(Integer pageNo)
                              throws DigitalOceanException,
                                     RequestUnsuccessfulException
```
    Description copied from interface: DigitalOcean
    
    Method returns all active droplets that are currently running in your account. All available API information is presented for each droplet.
    
    Specified by:
    
    getAvailableDroplets in interface DigitalOcean
    
    Parameters:
    pageNo - for pagination
    
    Returns:
    Droplets
    
    Throws:
    
    DigitalOceanException
    
    RequestUnsuccessfulException
  - getAvailableKernels
```
public Kernels getAvailableKernels(Integer dropletId,
                          Integer pageNo)
                            throws DigitalOceanException,
                                   RequestUnsuccessfulException
```
    Description copied from interface: DigitalOcean
    
    Method returns all available kernels for given droplet ID
    
    Specified by:
    
    getAvailableKernels in interface DigitalOcean
    
    Parameters:
    dropletId - for kernel info
    pageNo - for pagination
    
    Returns:
    Kernels
    
    Throws:
    
    DigitalOceanException
    
    RequestUnsuccessfulException
  - getAvailableSnapshots
```
public Snapshots getAvailableSnapshots(Integer dropletId,
                              Integer pageNo)
                                throws DigitalOceanException,
                                       RequestUnsuccessfulException
```
    Description copied from interface: DigitalOcean
    
    Method returns all available snapshots for given droplet ID
    
    Specified by:
    
    getAvailableSnapshots in interface DigitalOcean
    
    Parameters:
    dropletId - for snapshot info
    pageNo - for pagination
    
    Returns:
    Snapshots
    
    Throws:
    
    DigitalOceanException
    
    RequestUnsuccessfulException
  - getAvailableBackups
```
public Backups getAvailableBackups(Integer dropletId,
                          Integer pageNo)
                            throws DigitalOceanException,
                                   RequestUnsuccessfulException
```
    Description copied from interface: DigitalOcean
    
    Method returns all available snapshots for given droplet ID
    
    Specified by:
    
    getAvailableBackups in interface DigitalOcean
    
    Parameters:
    dropletId - for backup info
    pageNo - for pagination
    
    Returns:
    Backups
    
    Throws:
    
    DigitalOceanException
    
    RequestUnsuccessfulException
  - getDropletInfo
```
public Droplet getDropletInfo(Integer dropletId)
                       throws DigitalOceanException,
                              RequestUnsuccessfulException
```
    Description copied from interface: DigitalOcean
    
    Method returns complete information for given droplet ID
    
    Specified by:
    
    getDropletInfo in interface DigitalOcean
    
    Parameters:
    dropletId - the id of the droplet
    
    Returns:
    Droplet
    
    Throws:
    
    DigitalOceanException
    
    RequestUnsuccessfulException
  - createDroplet
```
public Droplet createDroplet(Droplet droplet)
                      throws DigitalOceanException,
                             RequestUnsuccessfulException
```
    Description copied from interface: DigitalOcean
    Method allows you to create a new droplet. See the required parameters section below for an explanation of the variables that are needed to create a new droplet.
    
    Note: Currently return object doesn't include 'action' information of create droplet.
    
    Create a instance of Droplet class and populated the droplet object appropriately. Minimum required values are -
```
 {
   "name": "example-droplet-name",
   "region": "nyc1",
   "size": "512mb",
   "image": 3445812
 }
 
```
    Specified by:
    
    createDroplet in interface DigitalOcean
    
    Parameters:
    droplet - the id of the droplet
    
    Returns:
    Droplet
    
    Throws:
    
    DigitalOceanException
    
    RequestUnsuccessfulException
  - deleteDroplet
```
public Delete deleteDroplet(Integer dropletId)
                     throws DigitalOceanException,
                            RequestUnsuccessfulException
```
    Description copied from interface: DigitalOcean
    
    Method destroys one of your droplet; this is irreversible.
    
    Specified by:
    
    deleteDroplet in interface DigitalOcean
    
    Parameters:
    dropletId - the id of the droplet
    
    Returns:
    Delete
    
    Throws:
    
    DigitalOceanException
    
    RequestUnsuccessfulException
  - getDropletNeighbors
```
public Droplets getDropletNeighbors(Integer dropletId,
                           Integer pageNo)
                             throws DigitalOceanException,
                                    RequestUnsuccessfulException
```
    Description copied from interface: DigitalOcean
    
    For an individual droplet; Method retrieves a list of droplets that are running on the same physical server (any other droplets that share the same physical hardware).
    
    Specified by:
    
    getDropletNeighbors in interface DigitalOcean
    
    Parameters:
    dropletId - the id of the droplet
    pageNo - for pagination
    
    Returns:
    Droplets
    
    Throws:
    
    DigitalOceanException
    
    RequestUnsuccessfulException
  - getAllDropletNeighbors
```
public Neighbors getAllDropletNeighbors(Integer pageNo)
                                 throws DigitalOceanException,
                                        RequestUnsuccessfulException
```
    Description copied from interface: DigitalOcean
    
    For an entire account; Method retrieves a list of any droplets that are running on the same physical server (any other droplets that share the same physical hardware).
    
    Specified by:
    
    getAllDropletNeighbors in interface DigitalOcean
    
    Parameters:
    pageNo - for pagination
    
    Returns:
    Neighbors
    
    Throws:
    
    DigitalOceanException
    
    RequestUnsuccessfulException
  - rebootDroplet
```
public Action rebootDroplet(Integer dropletId)
                     throws DigitalOceanException,
                            RequestUnsuccessfulException
```
    Description copied from interface: DigitalOcean
    
    Method allows you to reboot a droplet. This is the preferred method to use if a server is not responding.
    
    Specified by:
    
    rebootDroplet in interface DigitalOcean
    
    Parameters:
    dropletId - the id of the droplet
    
    Returns:
    Action
    
    Throws:
    
    DigitalOceanException
    
    RequestUnsuccessfulException
  - powerCycleDroplet
```
public Action powerCycleDroplet(Integer dropletId)
                         throws DigitalOceanException,
                                RequestUnsuccessfulException
```
    Description copied from interface: DigitalOcean
    
    Method allows you to power cycle a droplet. This will turn off the droplet and then turn it back on.
    
    Specified by:
    
    powerCycleDroplet in interface DigitalOcean
    
    Parameters:
    dropletId - the id of the droplet
    
    Returns:
    Action
    
    Throws:
    
    DigitalOceanException
    
    RequestUnsuccessfulException
  - shutdownDroplet
```
public Action shutdownDroplet(Integer dropletId)
                       throws DigitalOceanException,
                              RequestUnsuccessfulException
```
    Description copied from interface: DigitalOcean
    
    Method allows you to shutdown a running droplet.
    
    Specified by:
    
    shutdownDroplet in interface DigitalOcean
    
    Parameters:
    dropletId - the id of the droplet
    
    Returns:
    Action
    
    Throws:
    
    DigitalOceanException
    
    RequestUnsuccessfulException
  - powerOffDroplet
```
public Action powerOffDroplet(Integer dropletId)
                       throws DigitalOceanException,
                              RequestUnsuccessfulException
```
    Description copied from interface: DigitalOcean
    
    Method allows you to poweroff a running droplet.
    
    Specified by:
    
    powerOffDroplet in interface DigitalOcean
    
    Parameters:
    dropletId - the id of the droplet
    
    Returns:
    Action
    
    Throws:
    
    DigitalOceanException
    
    RequestUnsuccessfulException
  - powerOnDroplet
```
public Action powerOnDroplet(Integer dropletId)
                      throws DigitalOceanException,
                             RequestUnsuccessfulException
```
    Description copied from interface: DigitalOcean
    
    Method allows you to poweron a powered off droplet.
    
    Specified by:
    
    powerOnDroplet in interface DigitalOcean
    
    Parameters:
    dropletId - the id of the droplet
    
    Returns:
    Action
    
    Throws:
    
    DigitalOceanException
    
    RequestUnsuccessfulException
  - resetDropletPassword
```
public Action resetDropletPassword(Integer dropletId)
                            throws DigitalOceanException,
                                   RequestUnsuccessfulException
```
    Description copied from interface: DigitalOcean
    
    Method will reset the root password for a droplet. Please be aware that this will reboot the droplet to allow resetting the password.
    
    Specified by:
    
    resetDropletPassword in interface DigitalOcean
    
    Parameters:
    dropletId - the id of the droplet
    
    Returns:
    Action
    
    Throws:
    
    DigitalOceanException
    
    RequestUnsuccessfulException
  - resizeDroplet
```
public Action resizeDroplet(Integer dropletId,
                   String size)
                     throws DigitalOceanException,
                            RequestUnsuccessfulException
```
    Description copied from interface: DigitalOcean
    
    Method allows you to resize a specific droplet to a different size. This will affect the number of processors and memory allocated to the droplet.
    
    Specified by:
    
    resizeDroplet in interface DigitalOcean
    
    Parameters:
    dropletId - the id of the droplet
    size - of the droplet
    
    Returns:
    Action
    
    Throws:
    
    DigitalOceanException
    
    RequestUnsuccessfulException
  - takeDropletSnapshot
```
public Action takeDropletSnapshot(Integer dropletId)
                           throws DigitalOceanException,
                                  RequestUnsuccessfulException
```
    Description copied from interface: DigitalOcean
    
    Method allows you to take a snapshot of the running droplet, which can later be restored or used to create a new droplet from the same image. Please be aware this may cause a reboot.
    
    Specified by:
    
    takeDropletSnapshot in interface DigitalOcean
    
    Parameters:
    dropletId - the id of the droplet
    
    Returns:
    Action
    
    Throws:
    
    DigitalOceanException
    
    RequestUnsuccessfulException
  - takeDropletSnapshot
```
public Action takeDropletSnapshot(Integer dropletId,
                         String snapshotName)
                           throws DigitalOceanException,
                                  RequestUnsuccessfulException
```
    Description copied from interface: DigitalOcean
    
    Method allows you to take a snapshot of the running droplet, which can later be restored or used to create a new droplet from the same image. Please be aware this may cause a reboot.
    
    Specified by:
    
    takeDropletSnapshot in interface DigitalOcean
    
    Parameters:
    dropletId - the id of the droplet
    snapshotName - the name the snapshot to be created
    
    Returns:
    Action
    
    Throws:
    
    DigitalOceanException
    
    RequestUnsuccessfulException
  - restoreDroplet
```
public Action restoreDroplet(Integer dropletId,
                    Integer imageId)
                      throws DigitalOceanException,
                             RequestUnsuccessfulException
```
    Description copied from interface: DigitalOcean
    
    Method allows you to restore a droplet with a previous image or snapshot. This will be a mirror copy of the image or snapshot to your droplet. Be sure you have backed up any necessary information prior to restore.
    
    Specified by:
    
    restoreDroplet in interface DigitalOcean
    
    Parameters:
    dropletId - the id of the droplet
    imageId - the id of the DigitalOcean public image or your private image
    
    Returns:
    Action
    
    Throws:
    
    DigitalOceanException
    
    RequestUnsuccessfulException
  - rebuildDroplet
```
public Action rebuildDroplet(Integer dropletId,
                    Integer imageId)
                      throws DigitalOceanException,
                             RequestUnsuccessfulException
```
    Description copied from interface: DigitalOcean
    
    Method allows you to reinstall a droplet with a default image. This is useful if you want to start again but retain the same IP address for your droplet.
    
    Specified by:
    
    rebuildDroplet in interface DigitalOcean
    
    Parameters:
    dropletId - the id of the droplet
    imageId - the id of the DigitalOcean public image or your private image
    
    Returns:
    Action
    
    Throws:
    
    DigitalOceanException
    
    RequestUnsuccessfulException
  - disableDropletBackups
```
public Action disableDropletBackups(Integer dropletId)
                             throws DigitalOceanException,
                                    RequestUnsuccessfulException
```
    Description copied from interface: DigitalOcean
    
    Method disables automatic backups from running to backup your droplet's data.
    
    Specified by:
    
    disableDropletBackups in interface DigitalOcean
    
    Parameters:
    dropletId - the id of the droplet
    
    Returns:
    Action
    
    Throws:
    
    DigitalOceanException
    
    RequestUnsuccessfulException
  - renameDroplet
```
public Action renameDroplet(Integer dropletId,
                   String name)
                     throws DigitalOceanException,
                            RequestUnsuccessfulException
```
    Description copied from interface: DigitalOcean
    
    Method renames the droplet to the specified name.
    
    Specified by:
    
    renameDroplet in interface DigitalOcean
    
    Parameters:
    dropletId - the id of the droplet
    name - the new name of droplet to be called
    
    Returns:
    Action
    
    Throws:
    
    DigitalOceanException
    
    RequestUnsuccessfulException
  - changeDropletKernel
```
public Action changeDropletKernel(Integer dropletId,
                         Integer kernelId)
                           throws DigitalOceanException,
                                  RequestUnsuccessfulException
```
    Description copied from interface: DigitalOcean
    
    Method changes a OS kernel for given droplet
    
    Specified by:
    
    changeDropletKernel in interface DigitalOcean
    
    Parameters:
    dropletId - the id of the droplet
    kernelId - the kernel id to be changed for droplet
    
    Returns:
    Action
    
    Throws:
    
    DigitalOceanException
    
    RequestUnsuccessfulException
  - enableDropletIpv6
```
public Action enableDropletIpv6(Integer dropletId)
                         throws DigitalOceanException,
                                RequestUnsuccessfulException
```
    Description copied from interface: DigitalOcean
    
    Enabling IP v6 networking capability for droplet. It may be dependent on Data Center Features.
    
    Specified by:
    
    enableDropletIpv6 in interface DigitalOcean
    
    Parameters:
    dropletId - the id of the droplet
    
    Returns:
    Action
    
    Throws:
    
    DigitalOceanException
    
    RequestUnsuccessfulException
  - enableDropletPrivateNetworking
```
public Action enableDropletPrivateNetworking(Integer dropletId)
                                      throws DigitalOceanException,
                                             RequestUnsuccessfulException
```
    Description copied from interface: DigitalOcean
    
    Enabling private networking capability for droplet. It may be dependent on Data Center Features.
    
    Specified by:
    
    enableDropletPrivateNetworking in interface DigitalOcean
    
    Parameters:
    dropletId - the id of the droplet
    
    Returns:
    Action
    
    Throws:
    
    DigitalOceanException
    
    RequestUnsuccessfulException
  - getAccountInfo
```
public Account getAccountInfo()
                       throws DigitalOceanException,
                              RequestUnsuccessfulException
```
    Description copied from interface: DigitalOcean
    
    Method returns account information for provided credentials
    
    Specified by:
    
    getAccountInfo in interface DigitalOcean
    
    Returns:
    $Account
    
    Throws:
    
    DigitalOceanException
    
    RequestUnsuccessfulException
  - getAvailableActions
```
public Actions getAvailableActions(Integer pageNo)
                            throws DigitalOceanException,
                                   RequestUnsuccessfulException
```
    Description copied from interface: DigitalOcean
    
    Method return all the action informations, regardless of categories.
    
    Specified by:
    
    getAvailableActions in interface DigitalOcean
    
    Parameters:
    pageNo - for pagination
    
    Returns:
    Actions
    
    Throws:
    
    DigitalOceanException
    
    RequestUnsuccessfulException
  - getActionInfo
```
public Action getActionInfo(Integer actionId)
                     throws DigitalOceanException,
                            RequestUnsuccessfulException
```
    Description copied from interface: DigitalOcean
    
    To retrieve a specific action information by action ID
    
    Specified by:
    
    getActionInfo in interface DigitalOcean
    
    Parameters:
    actionId - the id of action
    
    Returns:
    Action
    
    Throws:
    
    DigitalOceanException
    
    RequestUnsuccessfulException
  - getAvailableDropletActions
```
public Actions getAvailableDropletActions(Integer dropletId,
                                 Integer pageNo)
                                   throws DigitalOceanException,
                                          RequestUnsuccessfulException
```
    Description copied from interface: DigitalOcean
    
    Method return all the action informations; specific to given Droplet Id
    
    Specified by:
    
    getAvailableDropletActions in interface DigitalOcean
    
    Parameters:
    dropletId - the id of the droplet
    pageNo - for pagination
    
    Returns:
    Actions
    
    Throws:
    
    DigitalOceanException
    
    RequestUnsuccessfulException
  - getAvailableImageActions
```
public Actions getAvailableImageActions(Integer imageId,
                               Integer pageNo)
                                 throws DigitalOceanException,
                                        RequestUnsuccessfulException
```
    Description copied from interface: DigitalOcean
    
    Method return all the action informations; specific to given Image Id
    
    Specified by:
    
    getAvailableImageActions in interface DigitalOcean
    
    Parameters:
    imageId - the id of the Image
    pageNo - for pagination
    
    Returns:
    Actions
    
    Throws:
    
    DigitalOceanException
    
    RequestUnsuccessfulException
  - getAvailableImages
```
public Images getAvailableImages(Integer pageNo)
                          throws DigitalOceanException,
                                 RequestUnsuccessfulException
```
    Description copied from interface: DigitalOcean
    
    Method returns all the available images that can be accessed by your OAuth Token. You will have access to all public images by default, and any snapshots or backups that you have created in your own account.
    
    Specified by:
    
    getAvailableImages in interface DigitalOcean
    
    Parameters:
    pageNo - of request pagination
    
    Returns:
    Images
    
    Throws:
    
    DigitalOceanException
    
    RequestUnsuccessfulException
  - getAvailableImages
```
public Images getAvailableImages(Integer pageNo,
                        ActionType type)
                          throws DigitalOceanException,
                                 RequestUnsuccessfulException
```
    Description copied from interface: DigitalOcean
    
    Method returns all the available images based on type={distribution or application} that can be accessed by your OAuth Token.
    
    Specified by:
    
    getAvailableImages in interface DigitalOcean
    
    Parameters:
    pageNo - of request pagination
    type - of action
    
    Returns:
    Images
    
    Throws:
    
    DigitalOceanException
    
    RequestUnsuccessfulException
  - getUserImages
```
public Images getUserImages(Integer pageNo)
                     throws DigitalOceanException,
                            RequestUnsuccessfulException
```
    Description copied from interface: DigitalOcean
    
    Method retrieves only the private images of a user
    
    Specified by:
    
    getUserImages in interface DigitalOcean
    
    Parameters:
    pageNo - of request pagination
    
    Returns:
    Images
    
    Throws:
    
    DigitalOceanException
    
    RequestUnsuccessfulException
  - getImageInfo
```
public Image getImageInfo(Integer imageId)
                   throws DigitalOceanException,
                          RequestUnsuccessfulException
```
    Description copied from interface: DigitalOcean
    
    Method retrieves the attributes of an image.
    
    Specified by:
    
    getImageInfo in interface DigitalOcean
    
    Parameters:
    imageId - the image Id of the droplet/snapshot/backup images
    
    Returns:
    Image
    
    Throws:
    
    DigitalOceanException
    
    RequestUnsuccessfulException
  - getImageInfo
```
public Image getImageInfo(String slug)
                   throws DigitalOceanException,
                          RequestUnsuccessfulException
```
    Description copied from interface: DigitalOcean
    
    Method retrieves the attributes of an image.
    
    Specified by:
    
    getImageInfo in interface DigitalOcean
    
    Parameters:
    slug - of the public image
    
    Returns:
    Image
    
    Throws:
    
    DigitalOceanException
    
    RequestUnsuccessfulException
  - updateImage
```
public Image updateImage(Image image)
                  throws DigitalOceanException,
                         RequestUnsuccessfulException
```
    Description copied from interface: DigitalOcean
    
    Method updates the given details for an image.
    
    Specified by:
    
    updateImage in interface DigitalOcean
    
    Parameters:
    image - object for update
    
    Returns:
    Image
    
    Throws:
    
    DigitalOceanException
    
    RequestUnsuccessfulException
  - deleteImage
```
public Delete deleteImage(Integer imageId)
                   throws DigitalOceanException,
                          RequestUnsuccessfulException
```
    Description copied from interface: DigitalOcean
    
    Method allows you to deletes an image. There is no way to restore a deleted image so be careful and ensure your data is properly backed up.
    
    Specified by:
    
    deleteImage in interface DigitalOcean
    
    Parameters:
    imageId - of the droplet/snapshot/backup images
    
    Returns:
    Delete
    
    Throws:
    
    DigitalOceanException
    
    RequestUnsuccessfulException
  - transferImage
```
public Action transferImage(Integer imageId,
                   String regionSlug)
                     throws DigitalOceanException,
                            RequestUnsuccessfulException
```
    Description copied from interface: DigitalOcean
    
    Method allows you to transfer an image to a specified region.
    
    Specified by:
    
    transferImage in interface DigitalOcean
    
    Parameters:
    imageId - the Id of the droplet/snapshot/backup images
    regionSlug - is code name of the region aka DigitalOcean data centers
    
    Returns:
    Action
    
    Throws:
    
    DigitalOceanException
    
    RequestUnsuccessfulException
  - convertImage
```
public Action convertImage(Integer imageId)
                    throws DigitalOceanException,
                           RequestUnsuccessfulException
```
    Description copied from interface: DigitalOcean
    
    Method allows you to convert image into snapshot
    
    Specified by:
    
    convertImage in interface DigitalOcean
    
    Parameters:
    imageId - the Id of the droplet/snapshot/backup images
    
    Returns:
    Action
    
    Throws:
    
    DigitalOceanException
    
    RequestUnsuccessfulException
  - getAvailableRegions
```
public Regions getAvailableRegions(Integer pageNo)
                            throws DigitalOceanException,
                                   RequestUnsuccessfulException
```
    Description copied from interface: DigitalOcean
    
    Method returns all the available regions within the DigitalOcean cloud.
    
    Specified by:
    
    getAvailableRegions in interface DigitalOcean
    
    Parameters:
    pageNo - for pagination
    
    Returns:
    Regions
    
    Throws:
    
    DigitalOceanException
    
    RequestUnsuccessfulException
  - getAvailableSizes
```
public Sizes getAvailableSizes(Integer pageNo)
                        throws DigitalOceanException,
                               RequestUnsuccessfulException
```
    Description copied from interface: DigitalOcean
    
    Method returns all the available sizes that can be used to create a droplet.
    
    Specified by:
    
    getAvailableSizes in interface DigitalOcean
    
    Parameters:
    pageNo - for pagination
    
    Returns:
    Sizes
    
    Throws:
    
    DigitalOceanException
    
    RequestUnsuccessfulException
  - getAvailableDomains
```
public Domains getAvailableDomains(Integer pageNo)
                            throws DigitalOceanException,
                                   RequestUnsuccessfulException
```
    Description copied from interface: DigitalOcean
    
    Method returns all of your available domains from DNS control panel
    
    Specified by:
    
    getAvailableDomains in interface DigitalOcean
    
    Parameters:
    pageNo - for pagination
    
    Returns:
    Domains
    
    Throws:
    
    DigitalOceanException
    
    RequestUnsuccessfulException
  - getDomainInfo
```
public Domain getDomainInfo(String domainName)
                     throws DigitalOceanException,
                            RequestUnsuccessfulException
```
    Description copied from interface: DigitalOcean
    
    Method returns the specified domain attributes and zone file info.
    
    Specified by:
    
    getDomainInfo in interface DigitalOcean
    
    Parameters:
    domainName - the name of the domain
    
    Returns:
    Domain
    
    Throws:
    
    DigitalOceanException
    
    RequestUnsuccessfulException
  - createDomain
```
public Domain createDomain(Domain domain)
                    throws DigitalOceanException,
                           RequestUnsuccessfulException
```
    Description copied from interface: DigitalOcean
    
    Method creates a new domain name with an A record for the specified [ip_address].
    
    Specified by:
    
    createDomain in interface DigitalOcean
    
    Parameters:
    domain - object with name and IP address for creation
    
    Returns:
    Domain
    
    Throws:
    
    DigitalOceanException
    
    RequestUnsuccessfulException
  - deleteDomain
```
public Delete deleteDomain(String domainName)
                    throws DigitalOceanException,
                           RequestUnsuccessfulException
```
    Description copied from interface: DigitalOcean
    
    Method deletes the specified domain from DNS control panel
    
    Specified by:
    
    deleteDomain in interface DigitalOcean
    
    Parameters:
    domainName - the name of the domain
    
    Returns:
    Delete
    
    Throws:
    
    DigitalOceanException
    
    RequestUnsuccessfulException
  - getDomainRecords
```
public DomainRecords getDomainRecords(String domainName)
                               throws DigitalOceanException,
                                      RequestUnsuccessfulException
```
    Description copied from interface: DigitalOcean
    
    Method returns all of your current domain records from DNS control panel for given domain.
    
    Specified by:
    
    getDomainRecords in interface DigitalOcean
    
    Parameters:
    domainName - of the domain
    
    Returns:
    DomainRecords
    
    Throws:
    
    DigitalOceanException
    
    RequestUnsuccessfulException
  - getDomainRecordInfo
```
public DomainRecord getDomainRecordInfo(String domainName,
                               Integer recordId)
                                 throws DigitalOceanException,
                                        RequestUnsuccessfulException
```
    Description copied from interface: DigitalOcean
    
    Method returns the specified domain record.
    
    Specified by:
    
    getDomainRecordInfo in interface DigitalOcean
    
    Parameters:
    domainName - of the domain
    recordId - of the domain
    
    Returns:
    DomainRecord
    
    Throws:
    
    DigitalOceanException
    
    RequestUnsuccessfulException
  - createDomainRecord
```
public DomainRecord createDomainRecord(String domainName,
                              DomainRecord domainRecord)
                                throws DigitalOceanException,
                                       RequestUnsuccessfulException
```
    Description copied from interface: DigitalOcean
    
    Method creates a new domain record name with an given domain record values
    
    Specified by:
    
    createDomainRecord in interface DigitalOcean
    
    Parameters:
    domainName - of the domain
    domainRecord - the domain record values domain Id, record type, data, name, priority, port, weight
    
    Returns:
    DomainRecord
    
    Throws:
    
    DigitalOceanException
    
    RequestUnsuccessfulException
  - updateDomainRecord
```
public DomainRecord updateDomainRecord(String domainName,
                              Integer recordId,
                              String name)
                                throws DigitalOceanException,
                                       RequestUnsuccessfulException
```
    Description copied from interface: DigitalOcean
    
    method edits an existing domain record of the given domain.
    
    Specified by:
    
    updateDomainRecord in interface DigitalOcean
    
    Parameters:
    domainName - of the domain
    recordId - of the domain
    name - of the domain record
    
    Returns:
    DomainRecord
    
    Throws:
    
    DigitalOceanException
    
    RequestUnsuccessfulException
  - deleteDomainRecord
```
public Delete deleteDomainRecord(String domainName,
                        Integer recordId)
                          throws DigitalOceanException,
                                 RequestUnsuccessfulException
```
    Description copied from interface: DigitalOcean
    
    Method deletes the specified domain record from domain.
    
    Specified by:
    
    deleteDomainRecord in interface DigitalOcean
    
    Parameters:
    domainName - of the domain
    recordId - of the domain
    
    Returns:
    Delete
    
    Throws:
    
    DigitalOceanException
    
    RequestUnsuccessfulException
  - getAvailableKeys
```
public Keys getAvailableKeys(Integer pageNo)
                      throws DigitalOceanException,
                             RequestUnsuccessfulException
```
    Description copied from interface: DigitalOcean
    
    Method lists all the available public SSH keys in your account that can be added to a droplet.
    
    Specified by:
    
    getAvailableKeys in interface DigitalOcean
    
    Parameters:
    pageNo - for pagination
    
    Returns:
    Keys
    
    Throws:
    
    DigitalOceanException
    
    RequestUnsuccessfulException
  - getKeyInfo
```
public Key getKeyInfo(Integer sshKeyId)
               throws DigitalOceanException,
                      RequestUnsuccessfulException
```
    Description copied from interface: DigitalOcean
    
    Method shows a specific public SSH key information from your account that can be added to a droplet.
    
    Specified by:
    
    getKeyInfo in interface DigitalOcean
    
    Parameters:
    sshKeyId - the SSH key Id
    
    Returns:
    Key
    
    Throws:
    
    DigitalOceanException
    
    RequestUnsuccessfulException
  - getKeyInfo
```
public Key getKeyInfo(String fingerprint)
               throws DigitalOceanException,
                      RequestUnsuccessfulException
```
    Description copied from interface: DigitalOcean
    
    Method shows a specific public SSH key information from your account that can be added to a droplet.
    
    Specified by:
    
    getKeyInfo in interface DigitalOcean
    
    Parameters:
    fingerprint - the SSH key fingerprint
    
    Returns:
    Key
    
    Throws:
    
    DigitalOceanException
    
    RequestUnsuccessfulException
  - createKey
```
public Key createKey(Key newKey)
              throws DigitalOceanException,
                     RequestUnsuccessfulException
```
    Description copied from interface: DigitalOcean
    
    Method allows you to add a new public SSH key to your account
    
    Specified by:
    
    createKey in interface DigitalOcean
    
    Parameters:
    newKey - the Key object with sshKeyName and sshPublicKey
    
    Returns:
    Key
    
    Throws:
    
    DigitalOceanException
    
    RequestUnsuccessfulException
  - updateKey
```
public Key updateKey(Integer sshKeyId,
            String newSshKeyName)
              throws DigitalOceanException,
                     RequestUnsuccessfulException
```
    Description copied from interface: DigitalOcean
    
    Method allows you to modify an existing SSH key in your account.
    
    Specified by:
    
    updateKey in interface DigitalOcean
    
    Parameters:
    sshKeyId - the SSH key Id
    newSshKeyName - the new name to give the SSH key
    
    Returns:
    Key
    
    Throws:
    
    DigitalOceanException
    
    RequestUnsuccessfulException
  - updateKey
```
public Key updateKey(String fingerprint,
            String newSshKeyName)
              throws DigitalOceanException,
                     RequestUnsuccessfulException
```
    Description copied from interface: DigitalOcean
    
    Method allows you to modify an existing SSH key in your account.
    
    Specified by:
    
    updateKey in interface DigitalOcean
    
    Parameters:
    fingerprint - the SSH fingerprint
    newSshKeyName - the new name to give the SSH key
    
    Returns:
    Key
    
    Throws:
    
    DigitalOceanException
    
    RequestUnsuccessfulException
  - deleteKey
```
public Delete deleteKey(Integer sshKeyId)
                 throws DigitalOceanException,
                        RequestUnsuccessfulException
```
    Description copied from interface: DigitalOcean
    
    Method will delete the SSH key from your account.
    
    Specified by:
    
    deleteKey in interface DigitalOcean
    
    Parameters:
    sshKeyId - the SSH key Id, you would like to delete
    
    Returns:
    Delete
    
    Throws:
    
    DigitalOceanException
    
    RequestUnsuccessfulException
  - deleteKey
```
public Delete deleteKey(String fingerprint)
                 throws DigitalOceanException,
                        RequestUnsuccessfulException
```
    Description copied from interface: DigitalOcean
    
    Method will delete the SSH key from your account.
    
    Specified by:
    
    deleteKey in interface DigitalOcean
    
    Parameters:
    fingerprint - the SSH fingerprint
    
    Returns:
    Delete
    
    Throws:
    
    DigitalOceanException
    
    RequestUnsuccessfulException

Class DigitalOceanClient

Field Summary

Fields inherited from interface com.myjeeva.digitalocean.common.Constants

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

httpClient

authToken

apiVersion

apiHost

Constructor Detail

DigitalOceanClient

DigitalOceanClient

DigitalOceanClient

Method Detail

getHttpClient

setHttpClient

getAuthToken

setAuthToken

getApiVersion

setApiVersion

getAvailableDroplets

getAvailableKernels

getAvailableSnapshots

getAvailableBackups

getDropletInfo

createDroplet

deleteDroplet

getDropletNeighbors

getAllDropletNeighbors

rebootDroplet

powerCycleDroplet

shutdownDroplet

powerOffDroplet

powerOnDroplet

resetDropletPassword

resizeDroplet

takeDropletSnapshot

takeDropletSnapshot

restoreDroplet

rebuildDroplet

disableDropletBackups

renameDroplet

changeDropletKernel

enableDropletIpv6

enableDropletPrivateNetworking

getAccountInfo

getAvailableActions

getActionInfo

getAvailableDropletActions

getAvailableImageActions

getAvailableImages

getAvailableImages

getUserImages

getImageInfo

getImageInfo

updateImage

deleteImage

transferImage

convertImage

getAvailableRegions

getAvailableSizes

getAvailableDomains

getDomainInfo

createDomain

deleteDomain

getDomainRecords

getDomainRecordInfo

createDomainRecord

updateDomainRecord

deleteDomainRecord

getAvailableKeys

getKeyInfo

getKeyInfo

createKey

updateKey

updateKey

deleteKey

deleteKey