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. (jeeva@myjeeva.com)

Field Summary

Fields

Modifier and Type

Field

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.impl.client.CloseableHttpClient

httpClient

Http client

Fields inherited from interface com.myjeeva.digitalocean.common.Constants
DATE_FORMAT, DEFAULT_PAGE_SIZE, FORM_URLENCODED_CONTENT_TYPE, HDR_AUTHORIZATION, HDR_CONTENT_TYPE, HDR_RATE_LIMIT, HDR_RATE_REMAINING, HDR_RATE_RESET, HDR_USER_AGENT, HTTPS_SCHEME, JSON_CONTENT_TYPE, LINKS_ELEMENT_NAME, META_ELEMENT_NAME, NO_CONTENT_JSON_STRUCT, PARAM_PAGE_NO, PARAM_PER_PAGE, RATE_LIMIT_ELEMENT_NAME, RATE_LIMIT_JSON_STRUCT, START_PAGE_NO, URL_PATH_SEPARATOR, USER_AGENT, UTF_8
Constructor Summary

Constructors

Constructor

Description

DigitalOceanClient(String authToken)

DigitalOcean Client Constructor

DigitalOceanClient(String apiVersion, String authToken)

DigitalOcean Client Constructor

DigitalOceanClient(String apiVersion, String authToken, org.apache.http.impl.client.CloseableHttpClient httpClient)

DigitalOcean Client Constructor
Method Summary

Modifier and Type

Method

Description

Response

addDropletsToFirewall(String firewallId, List<Integer> dropletIds)

Method allows you to assign a Droplet to a Firewall instance.

Response

addDropletsToLoadBalancer(String loadBalancerId, List<Integer> dropletIds)

Method allows you to assign a Droplet to a Load Balancer instance.

Response

addForwardingRulesToLoadBalancer(String loadBalancerId, List<ForwardingRules> forwardingRules)

Method allows you to add an additional forwarding rule to a Load Balancer instance.

Action

assignFloatingIP(Integer dropletId, String ipAddress)

Method will assign Floating IP to a Droplet.

Action

attachVolume(Integer dropletId, String volumeId, String regionSlug)

Method attaches the given volume into droplet by identifier

Action

attachVolumeByName(Integer dropletId, String volumeName, String regionSlug)

Method attaches the given volume into droplet by name

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

Certificate

createCertificate(Certificate certificate)

Method allows you to create a new certificate.

Image

createCustomImage(Image image)

Method creates the custom image.

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.

Droplets

createDroplets(Droplet droplet)

Method allows you to create multiple droplets simultaneously.

Firewall

createFirewall(Firewall firewall)

Method allows you to add a new firewall to restrict network access to and from a Droplet.

FloatingIP

createFloatingIP(Integer dropletId)

Method creates a new Floating IP and assigns to the Droplet.

FloatingIP

createFloatingIP(String region)

Method creates a new Floating IP and its reserved to a Region

Key

createKey(Key newKey)

Method allows you to add a new public SSH key to your account

Certificate

createLetsEncryptCertificate(Certificate certificate)

Method allows you to create a new Let's Encrypt certificate.

LoadBalancer

createLoadBalancer(LoadBalancer loadBalancer)

Method allows you to add a new load balancer to distribute traffic across multiple Droplets.

Project

createProject(Project project)

Method allows you to create a new project.

Tag

createTag(String name)

Method will create a Tag on DigitalOcean aacount.

Volume

createVolume(Volume volume)

Method creates new volume with given details

Delete

deleteCertificate(String certificateId)

Method allows you to delete a Certificate by Id from 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

deleteDropletByTagName(String tagName)

Method destroys one or more of your droplet by given tag name; this is irreversible.

Delete

deleteFirewall(String firewallId)

Method allows you to delete a Firewall instance, disassociating any Droplets assigned to it and removing it from your account.

Delete

deleteFloatingIP(String ipAddress)

Method deletes the Floating IP and removes it from your account.

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.

Delete

deleteLoadBalancer(String loadBalancerId)

Method allows you to delete a Load Balancer instance, disassociating any Droplets assigned to it and removing it from your account.

Delete

deleteProject(String projectId)

Delete

deleteSnapshot(String snapshotId)

Method deletes snapshot by id

Delete

deleteTag(String name)

Method deletes the existing Tag from DigitalOcean account.

Delete

deleteVolume(String volumeId)

Method deletes volume by identifier

Delete

deleteVolume(String volumeName, String regionSlug)

Method deletes volume by name and region slug

Action

detachVolume(Integer dropletId, String volumeId, String regionSlug)

Method detaches volume from the droplet by identifier

Action

detachVolumeByName(Integer dropletId, String volumeName, String regionSlug)

Method detaches volume from the droplet by volume name

Action

disableDropletBackups(Integer dropletId)

Method disables automatic backups from running to backup your droplet's data.

Action

enableDropletBackups(Integer dropletId)

Method enables automatic backups for 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).

Snapshots

getAllDropletSnapshots(Integer pageNo, Integer perPage)

Method return all of the droplet snapshots available on your account

Snapshots

getAllVolumeSnapshots(Integer pageNo, Integer perPage)

Method return all of the volume snapshots available on your account

String

getApiVersion()

String

getAuthToken()

Actions

getAvailableActions(Integer pageNo, Integer perPage)

Method return all the action informations, regardless of categories.

Certificates

getAvailableCertificates(Integer pageNo, Integer perPage)

Method returns all available Certificates from your account.

Domains

getAvailableDomains(Integer pageNo)

Method returns all of your available domains from DNS control panel

Actions

getAvailableDropletActions(Integer dropletId, Integer pageNo, Integer perPage)

Method return all the action informations; specific to given Droplet Id

Droplets

getAvailableDroplets(Integer pageNo, Integer perPage)

Method returns all active droplets that are currently running in your account.

Droplets

getAvailableDropletsByTagName(String tagName, Integer pageNo, Integer perPage)

To list Droplets by a tag.

Firewalls

getAvailableFirewalls(Integer pageNo, Integer perPage)

Method returns all available firewalls that are currently running in your account.

Actions

getAvailableFloatingIPActions(String ipAddress, Integer pageNo, Integer perPage)

Method retrives all actions that have been executed on a Floating IP address.

FloatingIPs

getAvailableFloatingIPs(Integer pageNo, Integer perPage)

Method will list all of the Floating IPs available from your account.

Actions

getAvailableImageActions(Integer imageId, Integer pageNo, Integer perPage)

Method return all the action informations; specific to given Image Id

Images

getAvailableImages(Integer pageNo, Integer perPage)

Method returns all the available images that can be accessed by your OAuth Token.

Images

getAvailableImages(Integer pageNo, Integer perPage, ActionType type)

Method returns all the available images based on type={distribution or application} that can be accessed by your OAuth Token.

Keys

getAvailableKeys(Integer pageNo)

Method lists all the available public SSH keys in your account that can be added to a droplet.

LoadBalancers

getAvailableLoadBalancers(Integer pageNo, Integer perPage)

Method returns all active loadbalancers that are currently running in your account.

Projects

getAvailableProjects()

Method allows you to get all the projects.

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 pageNo, Integer perPage)

Method return all of the snapshots available on your account

Tags

getAvailableTags(Integer pageNo, Integer perPage)

Method will list all of the Tags available from your account.

Actions

getAvailableVolumeActions(String volumeId)

Method will get all the available volume action by volume identifier

Volumes

getAvailableVolumes(String regionSlug)

Method will list all of the Volumes available from your account.

Certificate

getCertificateInfo(String certificateId)

Method returns the Certificate information for given certificate ID.

Project

getDefaultProject()

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, Integer pageNo, Integer perPage)

Method returns all of your current domain records from DNS control panel for given domain.

Backups

getDropletBackups(Integer dropletId, Integer pageNo, Integer perPage)

Method returns all available snapshots for given droplet ID

Droplet

getDropletInfo(Integer dropletId)

Method returns complete information for given droplet ID

Kernels

getDropletKernels(Integer dropletId, Integer pageNo, Integer perPage)

Method returns all available kernels 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).

Snapshots

getDropletSnapshots(Integer dropletId, Integer pageNo, Integer perPage)

Method returns all available snapshots for given droplet ID

Firewall

getFirewallInfo(String firewallId)

Method returns complete information for given firewall ID.

Action

getFloatingIPActionInfo(String ipAddress, Integer actionId)

Method to retrieve the status of a Floating IP action.

FloatingIP

getFloatingIPInfo(String ipAddress)

Method retrieves the information about given Floating IP

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.

LoadBalancer

getLoadBalancerInfo(String loadBalancerId)

Method returns complete information for given load balancer ID.

Project

getProject(String projectId)

Snapshot

getSnaphotInfo(String snapshotId)

Method returns specific snapshot info by id

Tag

getTag(String name)

Method retrieves the Tag from DigitalOcean account.

Images

getUserImages(Integer pageNo, Integer perPage)

Method retrieves only the private images of a user

Action

getVolumeAction(String volumeId, Integer actionId)

Method returns specific volume action by action and volume identifier

Volume

getVolumeInfo(String volumeId)

Method shows specific volume information by identifier

Volumes

getVolumeInfo(String volumeName, String regionSlug)

Method shows volume information by name and region slug

Snapshots

getVolumeSnapshots(String volumeId, Integer pageNo, Integer perPage)

Method return all of the snapshots for given volume Id

Project

patchDefaultProject(Project project)

Project

patchProject(Project project)

ApiResponse

perform(ApiRequest request)

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.

Delete

removeDropletsFromFirewall(String firewallId, List<Integer> dropletIds)

Method allows you to remove a Droplet from a Load Balancer instance.

Delete

removeDropletsFromLoadBalancer(String loadBalancerId, List<Integer> dropletIds)

Method allows you to remove a Droplet from a Load Balancer instance.

Delete

removeForwardingRulesFromLoadBalancer(String loadBalancerId, List<ForwardingRules> forwardingRules)

Method allows you to remove forwarding rules from a Load Balancer instance.

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

resizeDroplet(Integer dropletId, String size, Boolean disk)

Method allows you to resize a specific droplet to a different size.

Action

resizeVolume(String volumeId, String regionSlug, Double sizeGigabytes)

Method resizes volume by identifier

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.impl.client.CloseableHttpClient httpClient)

Action

shutdownDroplet(Integer dropletId)

Method allows you to shutdown a running droplet.

Response

tagResources(String name, List<Resource> resources)

Method tags a tag to given list of resources on DigitalOcean account.

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.

Snapshot

takeVolumeSnapshot(String volumeId, String snapshotName)

Method take snapshot of given volume Id

Action

transferImage(Integer imageId, String regionSlug)

Method allows you to transfer an image to a specified region.

Action

unassignFloatingIP(String ipAddress)

Method will unassign Floating IP from a Droplet.

Response

untagResources(String name, List<Resource> resources)

Method untags a tag from given list of resources on DigitalOcean account.

Project

updateDefaultProject(Project project)

DomainRecord

updateDomainRecord(String domainName, Integer recordId, DomainRecord domainRecord)

method edits an existing domain record of the given domain.

Firewall

updateFirewall(Firewall firewall)

Method allows you to update an existing fireawll.

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.

LoadBalancer

updateLoadBalancer(LoadBalancer loadBalancer)

Method allows you to update an existign load balancer.

Project

updateProject(Project project)

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

Field Details
- httpClient
  
  protected org.apache.http.impl.client.CloseableHttpClient 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 Details
- DigitalOceanClient
  
  public DigitalOceanClient(String authToken)
  
  DigitalOcean Client Constructor
  
  Parameters:
  
  authToken - a String object
- 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.impl.client.CloseableHttpClient httpClient)
  
  DigitalOcean Client Constructor
  
  Parameters:
  
  apiVersion - a String object
  
  authToken - a String object
  
  httpClient - a CloseableHttpClient object
Method Details
- getHttpClient
  
  public org.apache.http.client.HttpClient getHttpClient()
  
  Returns:
  
  the httpClient
- setHttpClient
  
  public void setHttpClient(org.apache.http.impl.client.CloseableHttpClient 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, Integer perPage) 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
  
  perPage - no. of items per page
  
  Returns:
  
  Droplets
  
  Throws:
  
  DigitalOceanException - if request had interruption [ HTTP status code >= 400 && < 510]
  
  RequestUnsuccessfulException - if any RESTful request unsuccessful from wrapper method
- getDropletKernels
  
  public Kernels getDropletKernels(Integer dropletId, Integer pageNo, Integer perPage) throws DigitalOceanException, RequestUnsuccessfulException
  
  Description copied from interface: DigitalOcean
  
  Method returns all available kernels for given droplet ID
  
  Specified by:
  
  getDropletKernels in interface DigitalOcean
  
  Parameters:
  
  dropletId - for kernel info
  
  pageNo - for pagination
  
  perPage - no. of items per page
  
  Returns:
  
  Kernels
  
  Throws:
  
  DigitalOceanException - if request had interruption [ HTTP status code >= 400 && < 510]
  
  RequestUnsuccessfulException - if any RESTful request unsuccessful from wrapper method
- getDropletSnapshots
  
  public Snapshots getDropletSnapshots(Integer dropletId, Integer pageNo, Integer perPage) throws DigitalOceanException, RequestUnsuccessfulException
  
  Description copied from interface: DigitalOcean
  
  Method returns all available snapshots for given droplet ID
  
  Specified by:
  
  getDropletSnapshots in interface DigitalOcean
  
  Parameters:
  
  dropletId - for snapshot info
  
  pageNo - for pagination
  
  perPage - no. of items per page
  
  Returns:
  
  Snapshots
  
  Throws:
  
  DigitalOceanException - if request had interruption [ HTTP status code >= 400 && < 510]
  
  RequestUnsuccessfulException - if any RESTful request unsuccessful from wrapper method
- getDropletBackups
  
  public Backups getDropletBackups(Integer dropletId, Integer pageNo, Integer perPage) throws DigitalOceanException, RequestUnsuccessfulException
  
  Description copied from interface: DigitalOcean
  
  Method returns all available snapshots for given droplet ID
  
  Specified by:
  
  getDropletBackups in interface DigitalOcean
  
  Parameters:
  
  dropletId - for backup info
  
  pageNo - for pagination
  
  perPage - no. of items per page
  
  Returns:
  
  Backups
  
  Throws:
  
  DigitalOceanException - if request had interruption [ HTTP status code >= 400 && < 510]
  
  RequestUnsuccessfulException - if any RESTful request unsuccessful from wrapper method
- 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 - if request had interruption [ HTTP status code >= 400 && < 510]
  
  RequestUnsuccessfulException - if any RESTful request unsuccessful from wrapper method
- 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": "ubuntu-14-04-x64", "backups": false }
  Specified by:
  
  createDroplet in interface DigitalOcean
  
  Parameters:
  
  droplet - the instance of the droplet class
  
  Returns:
  
  Droplet
  
  Throws:
  
  DigitalOceanException - if request had interruption [ HTTP status code >= 400 && < 510]
  
  RequestUnsuccessfulException - if any RESTful request unsuccessful from wrapper method
- createDroplets
  
  public Droplets createDroplets(Droplet droplet) throws DigitalOceanException, RequestUnsuccessfulException
  
  Description copied from interface: DigitalOcean
  Method allows you to create multiple droplets simultaneously. See the required parameters section below for an explanation of the variables that are needed to create multiple droplets.
  Create a instance of Droplet class and populated the droplet object appropriately. Particularly names attribute in the Droplet class. Minimum required values are -
  { "names": [ "sub-01.example.com", "sub-02.example.com" ], "region": "nyc1", "size": "512mb", "image": "ubuntu-14-04-x64", "backups": false }
  Specified by:
  
  createDroplets in interface DigitalOcean
  
  Parameters:
  
  droplet - the instance of the droplet class
  
  Returns:
  
  Droplet
  
  Throws:
  
  DigitalOceanException - if request had interruption [ HTTP status code >= 400 && < 510]
  
  RequestUnsuccessfulException - if any RESTful request unsuccessful from wrapper method
- 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 - if request had interruption [ HTTP status code >= 400 && < 510]
  
  RequestUnsuccessfulException - if any RESTful request unsuccessful from wrapper method
- deleteDropletByTagName
  
  public Delete deleteDropletByTagName(String tagName) throws DigitalOceanException, RequestUnsuccessfulException
  
  Description copied from interface: DigitalOcean
  
  Method destroys one or more of your droplet by given tag name; this is irreversible.
  
  Specified by:
  
  deleteDropletByTagName in interface DigitalOcean
  
  Parameters:
  
  tagName - the associated tag name with droplet
  
  Returns:
  
  Delete
  
  Throws:
  
  DigitalOceanException - if request had interruption [ HTTP status code >= 400 && < 510]
  
  RequestUnsuccessfulException - if any RESTful request unsuccessful from wrapper method
- 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 - if request had interruption [ HTTP status code >= 400 && < 510]
  
  RequestUnsuccessfulException - if any RESTful request unsuccessful from wrapper method
- 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 - if request had interruption [ HTTP status code >= 400 && < 510]
  
  RequestUnsuccessfulException - if any RESTful request unsuccessful from wrapper method
- getAvailableDropletsByTagName
  
  public Droplets getAvailableDropletsByTagName(String tagName, Integer pageNo, Integer perPage) throws DigitalOceanException, RequestUnsuccessfulException
  
  Description copied from interface: DigitalOcean
  
  To list Droplets by a tag.
  The response will match that of regular droplet listing request but will be filtered to only include the tagged Droplets.
  
  Specified by:
  
  getAvailableDropletsByTagName in interface DigitalOcean
  
  Parameters:
  
  tagName - for tagName
  
  pageNo - for pagination
  
  perPage - for pagination
  
  Returns:
  
  Droplets
  
  Throws:
  
  DigitalOceanException - if request had interruption [ HTTP status code >= 400 && < 510]
  
  RequestUnsuccessfulException - if any RESTful request unsuccessful from wrapper method
- 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 - if request had interruption [ HTTP status code >= 400 && < 510]
  
  RequestUnsuccessfulException - if any RESTful request unsuccessful from wrapper method
- 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 - if request had interruption [ HTTP status code >= 400 && < 510]
  
  RequestUnsuccessfulException - if any RESTful request unsuccessful from wrapper method
- 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 - if request had interruption [ HTTP status code >= 400 && < 510]
  
  RequestUnsuccessfulException - if any RESTful request unsuccessful from wrapper method
- 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 - if request had interruption [ HTTP status code >= 400 && < 510]
  
  RequestUnsuccessfulException - if any RESTful request unsuccessful from wrapper method
- 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 - if request had interruption [ HTTP status code >= 400 && < 510]
  
  RequestUnsuccessfulException - if any RESTful request unsuccessful from wrapper method
- 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 - if request had interruption [ HTTP status code >= 400 && < 510]
  
  RequestUnsuccessfulException - if any RESTful request unsuccessful from wrapper method
- 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 - if request had interruption [ HTTP status code >= 400 && < 510]
  
  RequestUnsuccessfulException - if any RESTful request unsuccessful from wrapper method
- resizeDroplet
  
  public Action resizeDroplet(Integer dropletId, String size, Boolean disk) 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 and optionally disk size.
  
  Specified by:
  
  resizeDroplet in interface DigitalOcean
  
  Parameters:
  
  dropletId - the id of the droplet
  
  size - of the droplet
  
  disk - whether to resize disk of the droplet or or not
  
  Returns:
  
  Action
  
  Throws:
  
  DigitalOceanException - if request had interruption [ HTTP status code >= 400 && < 510]
  
  RequestUnsuccessfulException - if any RESTful request unsuccessful from wrapper method
- 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 - if request had interruption [ HTTP status code >= 400 && < 510]
  
  RequestUnsuccessfulException - if any RESTful request unsuccessful from wrapper method
- 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 - if request had interruption [ HTTP status code >= 400 && < 510]
  
  RequestUnsuccessfulException - if any RESTful request unsuccessful from wrapper method
- 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 - if request had interruption [ HTTP status code >= 400 && < 510]
  
  RequestUnsuccessfulException - if any RESTful request unsuccessful from wrapper method
- 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 - if request had interruption [ HTTP status code >= 400 && < 510]
  
  RequestUnsuccessfulException - if any RESTful request unsuccessful from wrapper method
- enableDropletBackups
  
  public Action enableDropletBackups(Integer dropletId) throws DigitalOceanException, RequestUnsuccessfulException
  
  Description copied from interface: DigitalOcean
  
  Method enables automatic backups for your droplet's data.
  
  Specified by:
  
  enableDropletBackups in interface DigitalOcean
  
  Parameters:
  
  dropletId - the id of the droplet
  
  Returns:
  
  Action
  
  Throws:
  
  DigitalOceanException - if request had interruption [ HTTP status code >= 400 && < 510]
  
  RequestUnsuccessfulException - if any RESTful request unsuccessful from wrapper method
- 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 - if request had interruption [ HTTP status code >= 400 && < 510]
  
  RequestUnsuccessfulException - if any RESTful request unsuccessful from wrapper method
- 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 - if request had interruption [ HTTP status code >= 400 && < 510]
  
  RequestUnsuccessfulException - if any RESTful request unsuccessful from wrapper method
- 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 - if request had interruption [ HTTP status code >= 400 && < 510]
  
  RequestUnsuccessfulException - if any RESTful request unsuccessful from wrapper method
- 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 - if request had interruption [ HTTP status code >= 400 && < 510]
  
  RequestUnsuccessfulException - if any RESTful request unsuccessful from wrapper method
- 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 - if request had interruption [ HTTP status code >= 400 && < 510]
  
  RequestUnsuccessfulException - if any RESTful request unsuccessful from wrapper method
- 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 - if request had interruption [ HTTP status code >= 400 && < 510]
  
  RequestUnsuccessfulException - if any RESTful request unsuccessful from wrapper method
- getAvailableActions
  
  public Actions getAvailableActions(Integer pageNo, Integer perPage) 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
  
  perPage - no. of items per page
  
  Returns:
  
  Actions
  
  Throws:
  
  DigitalOceanException - if request had interruption [ HTTP status code >= 400 && < 510]
  
  RequestUnsuccessfulException - if any RESTful request unsuccessful from wrapper method
- 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 - if request had interruption [ HTTP status code >= 400 && < 510]
  
  RequestUnsuccessfulException - if any RESTful request unsuccessful from wrapper method
- getAvailableDropletActions
  
  public Actions getAvailableDropletActions(Integer dropletId, Integer pageNo, Integer perPage) 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
  
  perPage - no. of items per page
  
  Returns:
  
  Actions
  
  Throws:
  
  DigitalOceanException - if request had interruption [ HTTP status code >= 400 && < 510]
  
  RequestUnsuccessfulException - if any RESTful request unsuccessful from wrapper method
- getAvailableImageActions
  
  public Actions getAvailableImageActions(Integer imageId, Integer pageNo, Integer perPage) 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
  
  perPage - no. of items per page
  
  Returns:
  
  Actions
  
  Throws:
  
  DigitalOceanException - if request had interruption [ HTTP status code >= 400 && < 510]
  
  RequestUnsuccessfulException - if any RESTful request unsuccessful from wrapper method
- getAvailableFloatingIPActions
  
  public Actions getAvailableFloatingIPActions(String ipAddress, Integer pageNo, Integer perPage) throws DigitalOceanException, RequestUnsuccessfulException
  
  Description copied from interface: DigitalOcean
  
  Method retrives all actions that have been executed on a Floating IP address.
  
  Specified by:
  
  getAvailableFloatingIPActions in interface DigitalOcean
  
  Parameters:
  
  ipAddress - Floating IP address
  
  pageNo - for pagination
  
  perPage - no. of items per page
  
  Returns:
  
  Actions
  
  Throws:
  
  DigitalOceanException - if request had interruption [ HTTP status code >= 400 && < 510]
  
  RequestUnsuccessfulException - if any RESTful request unsuccessful from wrapper method
- getFloatingIPActionInfo
  
  public Action getFloatingIPActionInfo(String ipAddress, Integer actionId) throws DigitalOceanException, RequestUnsuccessfulException
  
  Description copied from interface: DigitalOcean
  
  Method to retrieve the status of a Floating IP action.
  
  Specified by:
  
  getFloatingIPActionInfo in interface DigitalOcean
  
  Parameters:
  
  ipAddress - Floating IP address
  
  actionId - the id of action
  
  Returns:
  
  Action
  
  Throws:
  
  DigitalOceanException - if request had interruption [ HTTP status code >= 400 && < 510]
  
  RequestUnsuccessfulException - if any RESTful request unsuccessful from wrapper method
- getAvailableVolumeActions
  
  public Actions getAvailableVolumeActions(String volumeId) throws DigitalOceanException, RequestUnsuccessfulException
  
  Description copied from interface: DigitalOcean
  
  Method will get all the available volume action by volume identifier
  
  Specified by:
  
  getAvailableVolumeActions in interface DigitalOcean
  
  Parameters:
  
  volumeId - volume identifier
  
  Returns:
  
  Actions
  
  Throws:
  
  DigitalOceanException - if request had interruption [ HTTP status code >= 400 && < 510]
  
  RequestUnsuccessfulException - if any RESTful request unsuccessful from wrapper method
- getVolumeAction
  
  public Action getVolumeAction(String volumeId, Integer actionId) throws DigitalOceanException, RequestUnsuccessfulException
  
  Description copied from interface: DigitalOcean
  
  Method returns specific volume action by action and volume identifier
  
  Specified by:
  
  getVolumeAction in interface DigitalOcean
  
  Parameters:
  
  volumeId - volume identifier
  
  actionId - the id of action
  
  Returns:
  
  Action
  
  Throws:
  
  DigitalOceanException - if request had interruption [ HTTP status code >= 400 && < 510]
  
  RequestUnsuccessfulException - if any RESTful request unsuccessful from wrapper method
- getAvailableImages
  
  public Images getAvailableImages(Integer pageNo, Integer perPage) 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
  
  perPage - no. of items per page
  
  Returns:
  
  Images
  
  Throws:
  
  DigitalOceanException - if request had interruption [ HTTP status code >= 400 && < 510]
  
  RequestUnsuccessfulException - if any RESTful request unsuccessful from wrapper method
- getAvailableImages
  
  public Images getAvailableImages(Integer pageNo, Integer perPage, 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
  
  perPage - no. of items per page
  
  type - of action
  
  Returns:
  
  Images
  
  Throws:
  
  DigitalOceanException - if request had interruption [ HTTP status code >= 400 && < 510]
  
  RequestUnsuccessfulException - if any RESTful request unsuccessful from wrapper method
- getUserImages
  
  public Images getUserImages(Integer pageNo, Integer perPage) 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
  
  perPage - no. of items per page
  
  Returns:
  
  Images
  
  Throws:
  
  DigitalOceanException - if request had interruption [ HTTP status code >= 400 && < 510]
  
  RequestUnsuccessfulException - if any RESTful request unsuccessful from wrapper method
- 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 - if request had interruption [ HTTP status code >= 400 && < 510]
  
  RequestUnsuccessfulException - if any RESTful request unsuccessful from wrapper method
- 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 - if request had interruption [ HTTP status code >= 400 && < 510]
  
  RequestUnsuccessfulException - if any RESTful request unsuccessful from wrapper method
- createCustomImage
  
  public Image createCustomImage(Image image) throws DigitalOceanException, RequestUnsuccessfulException
  
  Description copied from interface: DigitalOcean
  Method creates the custom image.
  Refer to https://developers.digitalocean.com/documentation/v2/#create-a-custom-image
  Sample Payload:
  { "name": "ubuntu-18.04-minimal", "url": "http://cloud-images.ubuntu.com/minimal/releases/bionic/release/ubuntu-18.04-minimal-cloudimg-amd64.img", "distribution": "Ubuntu", "region": "nyc3", "description": "Cloud-optimized image w/ small footprint", "tags": [ "base-image", "prod" ] }
  Specified by:
  
  createCustomImage in interface DigitalOcean
  
  Parameters:
  
  image - instance with custom image attributes
  
  Returns:
  
  Image
  
  Throws:
  
  DigitalOceanException - if request had interruption [ HTTP status code >= 400 && < 510]
  
  RequestUnsuccessfulException - if any RESTful request unsuccessful from wrapper method
- 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 - if request had interruption [ HTTP status code >= 400 && < 510]
  
  RequestUnsuccessfulException - if any RESTful request unsuccessful from wrapper method
- 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 - if request had interruption [ HTTP status code >= 400 && < 510]
  
  RequestUnsuccessfulException - if any RESTful request unsuccessful from wrapper method
- 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 - if request had interruption [ HTTP status code >= 400 && < 510]
  
  RequestUnsuccessfulException - if any RESTful request unsuccessful from wrapper method
- 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 - if request had interruption [ HTTP status code >= 400 && < 510]
  
  RequestUnsuccessfulException - if any RESTful request unsuccessful from wrapper method
- 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 - if request had interruption [ HTTP status code >= 400 && < 510]
  
  RequestUnsuccessfulException - if any RESTful request unsuccessful from wrapper method
- 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 - if request had interruption [ HTTP status code >= 400 && < 510]
  
  RequestUnsuccessfulException - if any RESTful request unsuccessful from wrapper method
- 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 - if request had interruption [ HTTP status code >= 400 && < 510]
  
  RequestUnsuccessfulException - if any RESTful request unsuccessful from wrapper method
- 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 - if request had interruption [ HTTP status code >= 400 && < 510]
  
  RequestUnsuccessfulException - if any RESTful request unsuccessful from wrapper method
- 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 - if request had interruption [ HTTP status code >= 400 && < 510]
  
  RequestUnsuccessfulException - if any RESTful request unsuccessful from wrapper method
- 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 - if request had interruption [ HTTP status code >= 400 && < 510]
  
  RequestUnsuccessfulException - if any RESTful request unsuccessful from wrapper method
- getDomainRecords
  
  public DomainRecords getDomainRecords(String domainName, Integer pageNo, Integer perPage) 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
  
  pageNo - of request pagination
  
  perPage - no. of items per page
  
  Returns:
  
  DomainRecords
  
  Throws:
  
  DigitalOceanException - if request had interruption [ HTTP status code >= 400 && < 510]
  
  RequestUnsuccessfulException - if any RESTful request unsuccessful from wrapper method
- 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 - if request had interruption [ HTTP status code >= 400 && < 510]
  
  RequestUnsuccessfulException - if any RESTful request unsuccessful from wrapper method
- 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 - if request had interruption [ HTTP status code >= 400 && < 510]
  
  RequestUnsuccessfulException - if any RESTful request unsuccessful from wrapper method
- updateDomainRecord
  
  public DomainRecord updateDomainRecord(String domainName, Integer recordId, DomainRecord domainRecord) 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
  
  domainRecord - the domain record values domain Id, record type, data, name, priority, port, weight
  
  Returns:
  
  DomainRecord
  
  Throws:
  
  DigitalOceanException - if request had interruption [ HTTP status code >= 400 && < 510]
  
  RequestUnsuccessfulException - if any RESTful request unsuccessful from wrapper method
- 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 - if request had interruption [ HTTP status code >= 400 && < 510]
  
  RequestUnsuccessfulException - if any RESTful request unsuccessful from wrapper method
- 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 - if request had interruption [ HTTP status code >= 400 && < 510]
  
  RequestUnsuccessfulException - if any RESTful request unsuccessful from wrapper method
- 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 - if request had interruption [ HTTP status code >= 400 && < 510]
  
  RequestUnsuccessfulException - if any RESTful request unsuccessful from wrapper method
- 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 - if request had interruption [ HTTP status code >= 400 && < 510]
  
  RequestUnsuccessfulException - if any RESTful request unsuccessful from wrapper method
- 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 - if request had interruption [ HTTP status code >= 400 && < 510]
  
  RequestUnsuccessfulException - if any RESTful request unsuccessful from wrapper method
- 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 - if request had interruption [ HTTP status code >= 400 && < 510]
  
  RequestUnsuccessfulException - if any RESTful request unsuccessful from wrapper method
- 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 - if request had interruption [ HTTP status code >= 400 && < 510]
  
  RequestUnsuccessfulException - if any RESTful request unsuccessful from wrapper method
- 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 - if request had interruption [ HTTP status code >= 400 && < 510]
  
  RequestUnsuccessfulException - if any RESTful request unsuccessful from wrapper method
- 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 - if request had interruption [ HTTP status code >= 400 && < 510]
  
  RequestUnsuccessfulException - if any RESTful request unsuccessful from wrapper method
- getAvailableFloatingIPs
  
  public FloatingIPs getAvailableFloatingIPs(Integer pageNo, Integer perPage) throws DigitalOceanException, RequestUnsuccessfulException
  
  Description copied from interface: DigitalOcean
  
  Method will list all of the Floating IPs available from your account.
  
  Specified by:
  
  getAvailableFloatingIPs in interface DigitalOcean
  
  Parameters:
  
  pageNo - for pagination
  
  perPage - no. of items per page
  
  Returns:
  
  FloatingIPs
  
  Throws:
  
  DigitalOceanException - if request had interruption [ HTTP status code >= 400 && < 510]
  
  RequestUnsuccessfulException - if any RESTful request unsuccessful from wrapper method
- createFloatingIP
  
  public FloatingIP createFloatingIP(Integer dropletId) throws DigitalOceanException, RequestUnsuccessfulException
  
  Description copied from interface: DigitalOcean
  
  Method creates a new Floating IP and assigns to the Droplet.
  
  Specified by:
  
  createFloatingIP in interface DigitalOcean
  
  Parameters:
  
  dropletId - the id of the droplet
  
  Returns:
  
  FloatingIP
  
  Throws:
  
  DigitalOceanException - if request had interruption [ HTTP status code >= 400 && < 510]
  
  RequestUnsuccessfulException - if any RESTful request unsuccessful from wrapper method
- createFloatingIP
  
  public FloatingIP createFloatingIP(String region) throws DigitalOceanException, RequestUnsuccessfulException
  
  Description copied from interface: DigitalOcean
  
  Method creates a new Floating IP and its reserved to a Region
  
  Specified by:
  
  createFloatingIP in interface DigitalOcean
  
  Parameters:
  
  region - name of the DigitalOcean region
  
  Returns:
  
  FloatingIP
  
  Throws:
  
  DigitalOceanException - if request had interruption [ HTTP status code >= 400 && < 510]
  
  RequestUnsuccessfulException - if any RESTful request unsuccessful from wrapper method
- getFloatingIPInfo
  
  public FloatingIP getFloatingIPInfo(String ipAddress) throws DigitalOceanException, RequestUnsuccessfulException
  
  Description copied from interface: DigitalOcean
  
  Method retrieves the information about given Floating IP
  
  Specified by:
  
  getFloatingIPInfo in interface DigitalOcean
  
  Parameters:
  
  ipAddress - Floating IP address
  
  Returns:
  
  FloatingIP
  
  Throws:
  
  DigitalOceanException - if request had interruption [ HTTP status code >= 400 && < 510]
  
  RequestUnsuccessfulException - if any RESTful request unsuccessful from wrapper method
- deleteFloatingIP
  
  public Delete deleteFloatingIP(String ipAddress) throws DigitalOceanException, RequestUnsuccessfulException
  
  Description copied from interface: DigitalOcean
  
  Method deletes the Floating IP and removes it from your account.
  
  Specified by:
  
  deleteFloatingIP in interface DigitalOcean
  
  Parameters:
  
  ipAddress - Floating IP address
  
  Returns:
  
  Delete
  
  Throws:
  
  DigitalOceanException - if request had interruption [ HTTP status code >= 400 && < 510]
  
  RequestUnsuccessfulException - if any RESTful request unsuccessful from wrapper method
- assignFloatingIP
  
  public Action assignFloatingIP(Integer dropletId, String ipAddress) throws DigitalOceanException, RequestUnsuccessfulException
  
  Description copied from interface: DigitalOcean
  
  Method will assign Floating IP to a Droplet.
  
  Specified by:
  
  assignFloatingIP in interface DigitalOcean
  
  Parameters:
  
  dropletId - the id of the droplet
  
  ipAddress - Floating IP address
  
  Returns:
  
  Action
  
  Throws:
  
  DigitalOceanException - if request had interruption [ HTTP status code >= 400 && < 510]
  
  RequestUnsuccessfulException - if any RESTful request unsuccessful from wrapper method
- unassignFloatingIP
  
  public Action unassignFloatingIP(String ipAddress) throws DigitalOceanException, RequestUnsuccessfulException
  
  Description copied from interface: DigitalOcean
  
  Method will unassign Floating IP from a Droplet. The Floating IP will be reserved in the region but not assigned to a Droplet.
  
  Specified by:
  
  unassignFloatingIP in interface DigitalOcean
  
  Parameters:
  
  ipAddress - Floating IP address
  
  Returns:
  
  Action
  
  Throws:
  
  DigitalOceanException - if request had interruption [ HTTP status code >= 400 && < 510]
  
  RequestUnsuccessfulException - if any RESTful request unsuccessful from wrapper method
- getAvailableTags
  
  public Tags getAvailableTags(Integer pageNo, Integer perPage) throws DigitalOceanException, RequestUnsuccessfulException
  
  Description copied from interface: DigitalOcean
  
  Method will list all of the Tags available from your account.
  
  Specified by:
  
  getAvailableTags in interface DigitalOcean
  
  Parameters:
  
  pageNo - for pagination
  
  perPage - no. of items per page
  
  Returns:
  
  Tags
  
  Throws:
  
  DigitalOceanException - if request had interruption [ HTTP status code >= 400 && < 510]
  
  RequestUnsuccessfulException - if any RESTful request unsuccessful from wrapper method
- createTag
  
  public Tag createTag(String name) throws DigitalOceanException, RequestUnsuccessfulException
  
  Description copied from interface: DigitalOcean
  
  Method will create a Tag on DigitalOcean aacount.
  
  Specified by:
  
  createTag in interface DigitalOcean
  
  Parameters:
  
  name - Tag Name
  
  Returns:
  
  Tag
  
  Throws:
  
  DigitalOceanException - if request had interruption [ HTTP status code >= 400 && < 510]
  
  RequestUnsuccessfulException - if any RESTful request unsuccessful from wrapper method
- getTag
  
  public Tag getTag(String name) throws DigitalOceanException, RequestUnsuccessfulException
  
  Description copied from interface: DigitalOcean
  
  Method retrieves the Tag from DigitalOcean account.
  
  Specified by:
  
  getTag in interface DigitalOcean
  
  Parameters:
  
  name - Tag Name
  
  Returns:
  
  Tag
  
  Throws:
  
  DigitalOceanException - if request had interruption [ HTTP status code >= 400 && < 510]
  
  RequestUnsuccessfulException - if any RESTful request unsuccessful from wrapper method
- deleteTag
  
  public Delete deleteTag(String name) throws DigitalOceanException, RequestUnsuccessfulException
  
  Description copied from interface: DigitalOcean
  
  Method deletes the existing Tag from DigitalOcean account.
  
  Specified by:
  
  deleteTag in interface DigitalOcean
  
  Parameters:
  
  name - Tag Name
  
  Returns:
  
  Delete
  
  Throws:
  
  DigitalOceanException - if request had interruption [ HTTP status code >= 400 && < 510]
  
  RequestUnsuccessfulException - if any RESTful request unsuccessful from wrapper method
- tagResources
  
  public Response tagResources(String name, List<Resource> resources) throws DigitalOceanException, RequestUnsuccessfulException
  
  Description copied from interface: DigitalOcean
  
  Method tags a tag to given list of resources on DigitalOcean account.
  
  Specified by:
  
  tagResources in interface DigitalOcean
  
  Parameters:
  
  name - Tag Name
  
  resources - list of resource by Resource objects
  
  Returns:
  
  Response
  
  Throws:
  
  DigitalOceanException - if request had interruption [ HTTP status code >= 400 && < 510]
  
  RequestUnsuccessfulException - if any RESTful request unsuccessful from wrapper method
- untagResources
  
  public Response untagResources(String name, List<Resource> resources) throws DigitalOceanException, RequestUnsuccessfulException
  
  Description copied from interface: DigitalOcean
  
  Method untags a tag from given list of resources on DigitalOcean account.
  
  Specified by:
  
  untagResources in interface DigitalOcean
  
  Parameters:
  
  name - Tag Name
  
  resources - list of resource by Resource objects
  
  Returns:
  
  Response
  
  Throws:
  
  DigitalOceanException - if request had interruption [ HTTP status code >= 400 && < 510]
  
  RequestUnsuccessfulException - if any RESTful request unsuccessful from wrapper method
- getAvailableVolumes
  
  public Volumes getAvailableVolumes(String regionSlug) throws DigitalOceanException, RequestUnsuccessfulException
  
  Description copied from interface: DigitalOcean
  
  Method will list all of the Volumes available from your account.
  
  Specified by:
  
  getAvailableVolumes in interface DigitalOcean
  
  Parameters:
  
  regionSlug - is code name of the region aka DigitalOcean data centers
  
  Returns:
  
  Volumes
  
  Throws:
  
  DigitalOceanException - if request had interruption [ HTTP status code >= 400 && < 510]
  
  RequestUnsuccessfulException - if any RESTful request unsuccessful from wrapper method
- createVolume
  
  public Volume createVolume(Volume volume) throws DigitalOceanException, RequestUnsuccessfulException
  
  Description copied from interface: DigitalOcean
  
  Method creates new volume with given details
  
  Specified by:
  
  createVolume in interface DigitalOcean
  
  Parameters:
  
  volume - details to create new volume
  
  Returns:
  
  Volume
  
  Throws:
  
  DigitalOceanException - if request had interruption [ HTTP status code >= 400 && < 510]
  
  RequestUnsuccessfulException - if any RESTful request unsuccessful from wrapper method
- getVolumeInfo
  
  public Volume getVolumeInfo(String volumeId) throws DigitalOceanException, RequestUnsuccessfulException
  
  Description copied from interface: DigitalOcean
  
  Method shows specific volume information by identifier
  
  Specified by:
  
  getVolumeInfo in interface DigitalOcean
  
  Parameters:
  
  volumeId - volume identifier
  
  Returns:
  
  Volume
  
  Throws:
  
  DigitalOceanException - if request had interruption [ HTTP status code >= 400 && < 510]
  
  RequestUnsuccessfulException - if any RESTful request unsuccessful from wrapper method
- getVolumeInfo
  
  public Volumes getVolumeInfo(String volumeName, String regionSlug) throws DigitalOceanException, RequestUnsuccessfulException
  
  Description copied from interface: DigitalOcean
  
  Method shows volume information by name and region slug
  
  Specified by:
  
  getVolumeInfo in interface DigitalOcean
  
  Parameters:
  
  volumeName - name of the volume
  
  regionSlug - is code name of the region aka DigitalOcean data centers
  
  Returns:
  
  Volumes
  
  Throws:
  
  DigitalOceanException - if request had interruption [ HTTP status code >= 400 && < 510]
  
  RequestUnsuccessfulException - if any RESTful request unsuccessful from wrapper method
- deleteVolume
  
  public Delete deleteVolume(String volumeId) throws DigitalOceanException, RequestUnsuccessfulException
  
  Description copied from interface: DigitalOcean
  
  Method deletes volume by identifier
  
  Specified by:
  
  deleteVolume in interface DigitalOcean
  
  Parameters:
  
  volumeId - volume identifier
  
  Returns:
  
  Delete
  
  Throws:
  
  DigitalOceanException - if request had interruption [ HTTP status code >= 400 && < 510]
  
  RequestUnsuccessfulException - if any RESTful request unsuccessful from wrapper method
- deleteVolume
  
  public Delete deleteVolume(String volumeName, String regionSlug) throws DigitalOceanException, RequestUnsuccessfulException
  
  Description copied from interface: DigitalOcean
  
  Method deletes volume by name and region slug
  
  Specified by:
  
  deleteVolume in interface DigitalOcean
  
  Parameters:
  
  volumeName - name of the volume
  
  regionSlug - is code name of the region aka DigitalOcean data centers
  
  Returns:
  
  Delete
  
  Throws:
  
  DigitalOceanException - if request had interruption [ HTTP status code >= 400 && < 510]
  
  RequestUnsuccessfulException - if any RESTful request unsuccessful from wrapper method
- attachVolume
  
  public Action attachVolume(Integer dropletId, String volumeId, String regionSlug) throws DigitalOceanException, RequestUnsuccessfulException
  
  Description copied from interface: DigitalOcean
  
  Method attaches the given volume into droplet by identifier
  
  Specified by:
  
  attachVolume in interface DigitalOcean
  
  Parameters:
  
  dropletId - droplet identifier
  
  volumeId - volume identifier
  
  regionSlug - is code name of the region aka DigitalOcean data centers
  
  Returns:
  
  Action
  
  Throws:
  
  DigitalOceanException - if request had interruption [ HTTP status code >= 400 && < 510]
  
  RequestUnsuccessfulException - if any RESTful request unsuccessful from wrapper method
- attachVolumeByName
  
  public Action attachVolumeByName(Integer dropletId, String volumeName, String regionSlug) throws DigitalOceanException, RequestUnsuccessfulException
  
  Description copied from interface: DigitalOcean
  
  Method attaches the given volume into droplet by name
  
  Specified by:
  
  attachVolumeByName in interface DigitalOcean
  
  Parameters:
  
  dropletId - droplet identifier
  
  volumeName - name of the volume
  
  regionSlug - is code name of the region aka DigitalOcean data centers
  
  Returns:
  
  Action
  
  Throws:
  
  DigitalOceanException - if request had interruption [ HTTP status code >= 400 && < 510]
  
  RequestUnsuccessfulException - if any RESTful request unsuccessful from wrapper method
- detachVolume
  
  public Action detachVolume(Integer dropletId, String volumeId, String regionSlug) throws DigitalOceanException, RequestUnsuccessfulException
  
  Description copied from interface: DigitalOcean
  
  Method detaches volume from the droplet by identifier
  
  Specified by:
  
  detachVolume in interface DigitalOcean
  
  Parameters:
  
  dropletId - droplet identifier
  
  volumeId - volume identifier
  
  regionSlug - is code name of the region aka DigitalOcean data centers
  
  Returns:
  
  Action
  
  Throws:
  
  DigitalOceanException - if request had interruption [ HTTP status code >= 400 && < 510]
  
  RequestUnsuccessfulException - if any RESTful request unsuccessful from wrapper method
- detachVolumeByName
  
  public Action detachVolumeByName(Integer dropletId, String volumeName, String regionSlug) throws DigitalOceanException, RequestUnsuccessfulException
  
  Description copied from interface: DigitalOcean
  
  Method detaches volume from the droplet by volume name
  
  Specified by:
  
  detachVolumeByName in interface DigitalOcean
  
  Parameters:
  
  dropletId - droplet identifier
  
  volumeName - name of the volume
  
  regionSlug - is code name of the region aka DigitalOcean data centers
  
  Returns:
  
  Action
  
  Throws:
  
  DigitalOceanException - if request had interruption [ HTTP status code >= 400 && < 510]
  
  RequestUnsuccessfulException - if any RESTful request unsuccessful from wrapper method
- resizeVolume
  
  public Action resizeVolume(String volumeId, String regionSlug, Double sizeGigabytes) throws DigitalOceanException, RequestUnsuccessfulException
  
  Description copied from interface: DigitalOcean
  
  Method resizes volume by identifier
  
  Specified by:
  
  resizeVolume in interface DigitalOcean
  
  Parameters:
  
  volumeId - volume identifier
  
  regionSlug - is code name of the region aka DigitalOcean data centers
  
  sizeGigabytes - size value in GB
  
  Returns:
  
  Action
  
  Throws:
  
  DigitalOceanException - if request had interruption [ HTTP status code >= 400 && < 510]
  
  RequestUnsuccessfulException - if any RESTful request unsuccessful from wrapper method
- getVolumeSnapshots
  
  public Snapshots getVolumeSnapshots(String volumeId, Integer pageNo, Integer perPage) throws DigitalOceanException, RequestUnsuccessfulException
  
  Description copied from interface: DigitalOcean
  
  Method return all of the snapshots for given volume Id
  
  Specified by:
  
  getVolumeSnapshots in interface DigitalOcean
  
  Parameters:
  
  volumeId - volume identifier
  
  pageNo - for pagination
  
  perPage - no. of items per page
  
  Returns:
  
  Snapshots
  
  Throws:
  
  DigitalOceanException - if request had interruption [ HTTP status code >= 400 && < 510]
  
  RequestUnsuccessfulException - if any RESTful request unsuccessful from wrapper method
- takeVolumeSnapshot
  
  public Snapshot takeVolumeSnapshot(String volumeId, String snapshotName) throws DigitalOceanException, RequestUnsuccessfulException
  
  Description copied from interface: DigitalOcean
  
  Method take snapshot of given volume Id
  
  Specified by:
  
  takeVolumeSnapshot in interface DigitalOcean
  
  Parameters:
  
  volumeId - volume identifier
  
  snapshotName - the name the snapshot to be created
  
  Returns:
  
  Snapshot
  
  Throws:
  
  DigitalOceanException - if request had interruption [ HTTP status code >= 400 && < 510]
  
  RequestUnsuccessfulException - if any RESTful request unsuccessful from wrapper method
- getAvailableSnapshots
  
  public Snapshots getAvailableSnapshots(Integer pageNo, Integer perPage) throws DigitalOceanException, RequestUnsuccessfulException
  
  Description copied from interface: DigitalOcean
  
  Method return all of the snapshots available on your account
  
  Specified by:
  
  getAvailableSnapshots in interface DigitalOcean
  
  Parameters:
  
  pageNo - for pagination
  
  perPage - no. of items per page
  
  Returns:
  
  Snapshots
  
  Throws:
  
  DigitalOceanException - if request had interruption [ HTTP status code >= 400 && < 510]
  
  RequestUnsuccessfulException - if any RESTful request unsuccessful from wrapper method
- getAllDropletSnapshots
  
  public Snapshots getAllDropletSnapshots(Integer pageNo, Integer perPage) throws DigitalOceanException, RequestUnsuccessfulException
  
  Description copied from interface: DigitalOcean
  
  Method return all of the droplet snapshots available on your account
  
  Specified by:
  
  getAllDropletSnapshots in interface DigitalOcean
  
  Parameters:
  
  pageNo - for pagination
  
  perPage - no. of items per page
  
  Returns:
  
  Snapshots
  
  Throws:
  
  DigitalOceanException - if request had interruption [ HTTP status code >= 400 && < 510]
  
  RequestUnsuccessfulException - if any RESTful request unsuccessful from wrapper method
- getAllVolumeSnapshots
  
  public Snapshots getAllVolumeSnapshots(Integer pageNo, Integer perPage) throws DigitalOceanException, RequestUnsuccessfulException
  
  Description copied from interface: DigitalOcean
  
  Method return all of the volume snapshots available on your account
  
  Specified by:
  
  getAllVolumeSnapshots in interface DigitalOcean
  
  Parameters:
  
  pageNo - for pagination
  
  perPage - no. of items per page
  
  Returns:
  
  Snapshots
  
  Throws:
  
  DigitalOceanException - if request had interruption [ HTTP status code >= 400 && < 510]
  
  RequestUnsuccessfulException - if any RESTful request unsuccessful from wrapper method
- getSnaphotInfo
  
  public Snapshot getSnaphotInfo(String snapshotId) throws DigitalOceanException, RequestUnsuccessfulException
  
  Description copied from interface: DigitalOcean
  
  Method returns specific snapshot info by id
  
  Specified by:
  
  getSnaphotInfo in interface DigitalOcean
  
  Parameters:
  
  snapshotId - for snapshot
  
  Returns:
  
  Snapshot
  
  Throws:
  
  DigitalOceanException - if request had interruption [ HTTP status code >= 400 && < 510]
  
  RequestUnsuccessfulException - if any RESTful request unsuccessful from wrapper method
- deleteSnapshot
  
  public Delete deleteSnapshot(String snapshotId) throws DigitalOceanException, RequestUnsuccessfulException
  
  Description copied from interface: DigitalOcean
  
  Method deletes snapshot by id
  
  Specified by:
  
  deleteSnapshot in interface DigitalOcean
  
  Parameters:
  
  snapshotId - for snapsho
  
  Returns:
  
  Delete
  
  Throws:
  
  DigitalOceanException - if request had interruption [ HTTP status code >= 400 && < 510]
  
  RequestUnsuccessfulException - if any RESTful request unsuccessful from wrapper method
- createLoadBalancer
  
  public LoadBalancer createLoadBalancer(LoadBalancer loadBalancer) throws DigitalOceanException, RequestUnsuccessfulException
  
  Description copied from interface: DigitalOcean
  
  Method allows you to add a new load balancer to distribute traffic across multiple Droplets.
  The LoadBalancer object passed in param can have a list of dropletIds set as dropletIds attribute. In this case, given Droplets will be assigned to the Load Balancer.
  You may also use a Droplet tag to assign a group of Droplets to Load Balancer in place of a list of Droplet IDs. In this case, set the tag attribute of the LoadBalancer object passed in param.
  
  Specified by:
  
  createLoadBalancer in interface DigitalOcean
  
  Parameters:
  
  loadBalancer - the instance of the loadBalancer class
  
  Returns:
  
  LoadBalancer
  
  Throws:
  
  DigitalOceanException - if request had interruption [ HTTP status code >= 400 && < 510]
  
  RequestUnsuccessfulException - if any RESTful request unsuccessful from wrapper method
- getLoadBalancerInfo
  
  public LoadBalancer getLoadBalancerInfo(String loadBalancerId) throws DigitalOceanException, RequestUnsuccessfulException
  
  Description copied from interface: DigitalOcean
  
  Method returns complete information for given load balancer ID.
  
  Specified by:
  
  getLoadBalancerInfo in interface DigitalOcean
  
  Parameters:
  
  loadBalancerId - the id of the droplet
  
  Returns:
  
  LoadBalancer
  
  Throws:
  
  DigitalOceanException - if request had interruption [ HTTP status code >= 400 && < 510]
  
  RequestUnsuccessfulException - if any RESTful request unsuccessful from wrapper method
- getAvailableLoadBalancers
  
  public LoadBalancers getAvailableLoadBalancers(Integer pageNo, Integer perPage) throws DigitalOceanException, RequestUnsuccessfulException
  
  Description copied from interface: DigitalOcean
  
  Method returns all active loadbalancers that are currently running in your account. All available API information is presented for each loadbalancer.
  
  Specified by:
  
  getAvailableLoadBalancers in interface DigitalOcean
  
  Parameters:
  
  pageNo - for pagination
  
  perPage - no. of items per page
  
  Returns:
  
  LoadBalancers
  
  Throws:
  
  DigitalOceanException - if request had interruption [ HTTP status code >= 400 && < 510]
  
  RequestUnsuccessfulException - if any RESTful request unsuccessful from wrapper method
- updateLoadBalancer
  
  public LoadBalancer updateLoadBalancer(LoadBalancer loadBalancer) throws DigitalOceanException, RequestUnsuccessfulException
  
  Description copied from interface: DigitalOcean
  
  Method allows you to update an existign load balancer. The LoadBalancer object passed in param should contain a full representation of the Load Balancer including existing attributes. It may contain one of the dropletIds or tag parameter as they are mutually exclusive. Note that any attribute that is not provided will be reset to its default value.
  
  Specified by:
  
  updateLoadBalancer in interface DigitalOcean
  
  Parameters:
  
  loadBalancer - the instance of the loadBalancer class
  
  Returns:
  
  LoadBalancer
  
  Throws:
  
  DigitalOceanException - if request had interruption [ HTTP status code >= 400 && < 510]
  
  RequestUnsuccessfulException - if any RESTful request unsuccessful from wrapper method
- addDropletsToLoadBalancer
  
  public Response addDropletsToLoadBalancer(String loadBalancerId, List<Integer> dropletIds) throws DigitalOceanException, RequestUnsuccessfulException
  
  Description copied from interface: DigitalOcean
  
  Method allows you to assign a Droplet to a Load Balancer instance.
  
  Specified by:
  
  addDropletsToLoadBalancer in interface DigitalOcean
  
  Parameters:
  
  loadBalancerId - the id of the loadBalancer
  
  dropletIds - an array containing the IDs of the Droplets to be assigned to the Load Balancer instance.
  
  Returns:
  
  Response
  
  Throws:
  
  DigitalOceanException - if request had interruption [ HTTP status code >= 400 && < 510]
  
  RequestUnsuccessfulException - if any RESTful request unsuccessful from wrapper method
- removeDropletsFromLoadBalancer
  
  public Delete removeDropletsFromLoadBalancer(String loadBalancerId, List<Integer> dropletIds) throws DigitalOceanException, RequestUnsuccessfulException
  
  Description copied from interface: DigitalOcean
  
  Method allows you to remove a Droplet from a Load Balancer instance.
  
  Specified by:
  
  removeDropletsFromLoadBalancer in interface DigitalOcean
  
  Parameters:
  
  loadBalancerId - the id of the loadBalancer
  
  dropletIds - an array containing the IDs of the Droplets to be removed from the Load Balancer instance.
  
  Returns:
  
  Delete
  
  Throws:
  
  DigitalOceanException - if request had interruption [ HTTP status code >= 400 && < 510]
  
  RequestUnsuccessfulException - if any RESTful request unsuccessful from wrapper method
- addForwardingRulesToLoadBalancer
  
  public Response addForwardingRulesToLoadBalancer(String loadBalancerId, List<ForwardingRules> forwardingRules) throws DigitalOceanException, RequestUnsuccessfulException
  
  Description copied from interface: DigitalOcean
  
  Method allows you to add an additional forwarding rule to a Load Balancer instance.
  
  Specified by:
  
  addForwardingRulesToLoadBalancer in interface DigitalOcean
  
  Parameters:
  
  loadBalancerId - the id of the loadBalancer
  
  forwardingRules - an array containing the Forwarding Rules to add to the Load Balancer instance.
  
  Returns:
  
  Response
  
  Throws:
  
  DigitalOceanException - if request had interruption [ HTTP status code >= 400 && < 510]
  
  RequestUnsuccessfulException - if any RESTful request unsuccessful from wrapper method
- removeForwardingRulesFromLoadBalancer
  
  public Delete removeForwardingRulesFromLoadBalancer(String loadBalancerId, List<ForwardingRules> forwardingRules) throws DigitalOceanException, RequestUnsuccessfulException
  
  Description copied from interface: DigitalOcean
  
  Method allows you to remove forwarding rules from a Load Balancer instance.
  
  Specified by:
  
  removeForwardingRulesFromLoadBalancer in interface DigitalOcean
  
  Parameters:
  
  loadBalancerId - the id of the loadBalancer
  
  forwardingRules - an array containing the Forwarding Rules to remove from the Load Balancer instance.
  
  Returns:
  
  Delete
  
  Throws:
  
  DigitalOceanException - if request had interruption [ HTTP status code >= 400 && < 510]
  
  RequestUnsuccessfulException - if any RESTful request unsuccessful from wrapper method
- deleteLoadBalancer
  
  public Delete deleteLoadBalancer(String loadBalancerId) throws DigitalOceanException, RequestUnsuccessfulException
  
  Description copied from interface: DigitalOcean
  
  Method allows you to delete a Load Balancer instance, disassociating any Droplets assigned to it and removing it from your account.
  
  Specified by:
  
  deleteLoadBalancer in interface DigitalOcean
  
  Parameters:
  
  loadBalancerId - the id of the loadBalancer
  
  Returns:
  
  Delete
  
  Throws:
  
  DigitalOceanException - if request had interruption [ HTTP status code >= 400 && < 510]
  
  RequestUnsuccessfulException - if any RESTful request unsuccessful from wrapper method
- getAvailableCertificates
  
  public Certificates getAvailableCertificates(Integer pageNo, Integer perPage) throws DigitalOceanException, RequestUnsuccessfulException
  
  Description copied from interface: DigitalOcean
  
  Method returns all available Certificates from your account.
  
  Specified by:
  
  getAvailableCertificates in interface DigitalOcean
  
  Parameters:
  
  pageNo - for pagination
  
  perPage - no. of items per page
  
  Returns:
  
  LoadBalancers
  
  Throws:
  
  DigitalOceanException - if request had interruption [ HTTP status code >= 400 && < 510]
  
  RequestUnsuccessfulException - if any RESTful request unsuccessful from wrapper method
- createCertificate
  
  public Certificate createCertificate(Certificate certificate) throws DigitalOceanException, RequestUnsuccessfulException
  
  Description copied from interface: DigitalOcean
  Method allows you to create a new certificate. See the required parameters section below for an explanation of the variables that are needed to create a new certificate.
  Create a instance of Certificate class and populated the certificate object appropriately. Required values are -
  { "name": "web-cert-01", "private_key": "-----BEGIN PRIVATE KEY----- ... -----END PRIVATE KEY-----", "leaf_certificate": "-----BEGIN CERTIFICATE----- ... -----END CERTIFICATE-----", "certificate_chain": "-----BEGIN CERTIFICATE----- ... -----END CERTIFICATE-----" }
  Specified by:
  
  createCertificate in interface DigitalOcean
  
  Parameters:
  
  certificate - the instance of the Certificate class
  
  Returns:
  
  Certificate
  
  Throws:
  
  DigitalOceanException - if request had interruption [ HTTP status code >= 400 && < 510]
  
  RequestUnsuccessfulException - if any RESTful request unsuccessful from wrapper method
- createLetsEncryptCertificate
  
  public Certificate createLetsEncryptCertificate(Certificate certificate) throws DigitalOceanException, RequestUnsuccessfulException
  
  Description copied from interface: DigitalOcean
  Method allows you to create a new Let's Encrypt certificate. See the required parameters section below for an explanation of the variables that are needed to create a new Let's Encrypt certificate.
  Create a instance of Certificate class and populated the certificate object appropriately. Required values are -
  { "name": "le-cert-01", "type": "lets_encrypt", "dns_names": ["www.example.com","example.com"] }
  Specified by:
  
  createLetsEncryptCertificate in interface DigitalOcean
  
  Parameters:
  
  certificate - the instance of the Certificate class
  
  Returns:
  
  Certificate
  
  Throws:
  
  DigitalOceanException - if request had interruption [ HTTP status code >= 400 && < 510]
  
  RequestUnsuccessfulException - if any RESTful request unsuccessful from wrapper method
- getCertificateInfo
  
  public Certificate getCertificateInfo(String certificateId) throws DigitalOceanException, RequestUnsuccessfulException
  
  Description copied from interface: DigitalOcean
  
  Method returns the Certificate information for given certificate ID.
  
  Specified by:
  
  getCertificateInfo in interface DigitalOcean
  
  Parameters:
  
  certificateId - the id of the certificate
  
  Returns:
  
  Certificate
  
  Throws:
  
  DigitalOceanException - if request had interruption [ HTTP status code >= 400 && < 510]
  
  RequestUnsuccessfulException - if any RESTful request unsuccessful from wrapper method
- deleteCertificate
  
  public Delete deleteCertificate(String certificateId) throws DigitalOceanException, RequestUnsuccessfulException
  
  Description copied from interface: DigitalOcean
  
  Method allows you to delete a Certificate by Id from your account.
  
  Specified by:
  
  deleteCertificate in interface DigitalOcean
  
  Parameters:
  
  certificateId - the id of the certificate
  
  Returns:
  
  Delete
  
  Throws:
  
  DigitalOceanException - if request had interruption [ HTTP status code >= 400 && < 510]
  
  RequestUnsuccessfulException - if any RESTful request unsuccessful from wrapper method
- createFirewall
  
  public Firewall createFirewall(Firewall firewall) throws DigitalOceanException, RequestUnsuccessfulException
  
  Description copied from interface: DigitalOcean
  
  Method allows you to add a new firewall to restrict network access to and from a Droplet.
  The Firewall object passed in param can have a list of dropletIds set as dropletIds attribute. In this case, given Droplets will use the Firewall rules.
  You may also use a Droplet tag to assign a group of Droplets to use the Firewall in place of a list of Droplet IDs. In this case, set the tag attribute of the Firewall object passed in param.
  
  Specified by:
  
  createFirewall in interface DigitalOcean
  
  Parameters:
  
  firewall - the instance of the firewall class
  
  Returns:
  
  Firewall
  
  Throws:
  
  DigitalOceanException - if request had interruption [ HTTP status code >= 400 && < 510]
  
  RequestUnsuccessfulException - if any RESTful request unsuccessful from wrapper method
- getFirewallInfo
  
  public Firewall getFirewallInfo(String firewallId) throws DigitalOceanException, RequestUnsuccessfulException
  
  Description copied from interface: DigitalOcean
  
  Method returns complete information for given firewall ID.
  
  Specified by:
  
  getFirewallInfo in interface DigitalOcean
  
  Parameters:
  
  firewallId - the id of the firewall
  
  Returns:
  
  Firewall
  
  Throws:
  
  DigitalOceanException - if request had interruption [ HTTP status code >= 400 && < 510]
  
  RequestUnsuccessfulException - if any RESTful request unsuccessful from wrapper method
- updateFirewall
  
  public Firewall updateFirewall(Firewall firewall) throws DigitalOceanException, RequestUnsuccessfulException
  
  Description copied from interface: DigitalOcean
  
  Method allows you to update an existing fireawll. The Firewall object passed in param should contain a full representation of the Firewall including existing attributes. It may contain one of the dropletIds or tag parameter as they are mutually exclusive. Note that any attribute that is not provided will be reset to its default value.
  
  Specified by:
  
  updateFirewall in interface DigitalOcean
  
  Parameters:
  
  firewall - the instance of the firewall class
  
  Returns:
  
  Firewall
  
  Throws:
  
  DigitalOceanException - if request had interruption [ HTTP status code >= 400 && < 510]
  
  RequestUnsuccessfulException - if any RESTful request unsuccessful from wrapper method
- deleteFirewall
  
  public Delete deleteFirewall(String firewallId) throws DigitalOceanException, RequestUnsuccessfulException
  
  Description copied from interface: DigitalOcean
  
  Method allows you to delete a Firewall instance, disassociating any Droplets assigned to it and removing it from your account.
  
  Specified by:
  
  deleteFirewall in interface DigitalOcean
  
  Parameters:
  
  firewallId - the id of the firewall
  
  Returns:
  
  Delete
  
  Throws:
  
  DigitalOceanException - if request had interruption [ HTTP status code >= 400 && < 510]
  
  RequestUnsuccessfulException - if any RESTful request unsuccessful from wrapper method
- addDropletsToFirewall
  
  public Response addDropletsToFirewall(String firewallId, List<Integer> dropletIds) throws DigitalOceanException, RequestUnsuccessfulException
  
  Description copied from interface: DigitalOcean
  
  Method allows you to assign a Droplet to a Firewall instance.
  
  Specified by:
  
  addDropletsToFirewall in interface DigitalOcean
  
  Parameters:
  
  firewallId - the id of the firewall to add droplets to
  
  dropletIds - the list of of droplet IDs to add to the firewall
  
  Returns:
  
  Response A generic HTTP status response
  
  Throws:
  
  DigitalOceanException - if request had interruption [ HTTP status code >= 400 && < 510]
  
  RequestUnsuccessfulException - if any RESTful request unsuccessful from wrapper method
- removeDropletsFromFirewall
  
  public Delete removeDropletsFromFirewall(String firewallId, List<Integer> dropletIds) throws DigitalOceanException, RequestUnsuccessfulException
  
  Description copied from interface: DigitalOcean
  
  Method allows you to remove a Droplet from a Load Balancer instance.
  
  Specified by:
  
  removeDropletsFromFirewall in interface DigitalOcean
  
  Parameters:
  
  firewallId - the id of the firewall
  
  dropletIds - the list of droplet IDs to be removed from the firewall instance.
  
  Returns:
  
  Delete
  
  Throws:
  
  DigitalOceanException - if request had interruption [ HTTP status code >= 400 && < 510]
  
  RequestUnsuccessfulException - if any RESTful request unsuccessful from wrapper method
- getAvailableFirewalls
  
  public Firewalls getAvailableFirewalls(Integer pageNo, Integer perPage) throws DigitalOceanException, RequestUnsuccessfulException
  
  Description copied from interface: DigitalOcean
  
  Method returns all available firewalls that are currently running in your account. All available API information is presented for each firewall.
  
  Specified by:
  
  getAvailableFirewalls in interface DigitalOcean
  
  Parameters:
  
  pageNo - for pagination
  
  perPage - no. of items per page
  
  Returns:
  
  Firewalls
  
  Throws:
  
  DigitalOceanException - if request had interruption [ HTTP status code >= 400 && < 510]
  
  RequestUnsuccessfulException - if any RESTful request unsuccessful from wrapper method
- createProject
  
  public Project createProject(Project project) throws DigitalOceanException, RequestUnsuccessfulException
  
  Description copied from interface: DigitalOcean
  
  Method allows you to create a new project.
  
  Specified by:
  
  createProject in interface DigitalOcean
  
  Parameters:
  
  project - the project
  
  Returns:
  
  Project
  
  Throws:
  
  DigitalOceanException - if request had interruption [ HTTP status code >= 400 && < 510]
  
  RequestUnsuccessfulException - if any RESTful request unsuccessful from wrapper method
- getAvailableProjects
  
  public Projects getAvailableProjects() throws DigitalOceanException, RequestUnsuccessfulException
  
  Description copied from interface: DigitalOcean
  
  Method allows you to get all the projects.
  
  Specified by:
  
  getAvailableProjects in interface DigitalOcean
  
  Returns:
  
  Projects
  
  Throws:
  
  DigitalOceanException - if request had interruption [ HTTP status code >= 400 && < 510]
  
  RequestUnsuccessfulException - if any RESTful request unsuccessful from wrapper method
- updateProject
  
  public Project updateProject(Project project) throws DigitalOceanException, RequestUnsuccessfulException
  
  Specified by:
  
  updateProject in interface DigitalOcean
  
  Throws:
  
  DigitalOceanException
  
  RequestUnsuccessfulException
- patchProject
  
  public Project patchProject(Project project) throws DigitalOceanException, RequestUnsuccessfulException
  
  Specified by:
  
  patchProject in interface DigitalOcean
  
  Throws:
  
  DigitalOceanException
  
  RequestUnsuccessfulException
- getProject
  
  public Project getProject(String projectId) throws DigitalOceanException, RequestUnsuccessfulException
  
  Specified by:
  
  getProject in interface DigitalOcean
  
  Throws:
  
  DigitalOceanException
  
  RequestUnsuccessfulException
- getDefaultProject
  
  public Project getDefaultProject() throws DigitalOceanException, RequestUnsuccessfulException
  
  Specified by:
  
  getDefaultProject in interface DigitalOcean
  
  Throws:
  
  DigitalOceanException
  
  RequestUnsuccessfulException
- updateDefaultProject
  
  public Project updateDefaultProject(Project project) throws DigitalOceanException, RequestUnsuccessfulException
  
  Specified by:
  
  updateDefaultProject in interface DigitalOcean
  
  Throws:
  
  DigitalOceanException
  
  RequestUnsuccessfulException
- patchDefaultProject
  
  public Project patchDefaultProject(Project project) throws DigitalOceanException, RequestUnsuccessfulException
  
  Specified by:
  
  patchDefaultProject in interface DigitalOcean
  
  Throws:
  
  DigitalOceanException
  
  RequestUnsuccessfulException
- deleteProject
  
  public Delete deleteProject(String projectId) throws DigitalOceanException, RequestUnsuccessfulException
  
  Specified by:
  
  deleteProject in interface DigitalOcean
  
  Throws:
  
  DigitalOceanException
  
  RequestUnsuccessfulException
- perform
  
  public ApiResponse perform(ApiRequest request) throws DigitalOceanException, RequestUnsuccessfulException
  
  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 Details

httpClient

authToken

apiVersion

apiHost

Constructor Details

DigitalOceanClient

DigitalOceanClient

DigitalOceanClient

Method Details

getHttpClient

setHttpClient

getAuthToken

setAuthToken

getApiVersion

setApiVersion

getAvailableDroplets

getDropletKernels

getDropletSnapshots

getDropletBackups

getDropletInfo

createDroplet

createDroplets

deleteDroplet

deleteDropletByTagName

getDropletNeighbors

getAllDropletNeighbors

getAvailableDropletsByTagName

rebootDroplet

powerCycleDroplet

shutdownDroplet

powerOffDroplet

powerOnDroplet

resetDropletPassword

resizeDroplet

resizeDroplet

takeDropletSnapshot

takeDropletSnapshot

restoreDroplet

rebuildDroplet

enableDropletBackups

disableDropletBackups

renameDroplet

changeDropletKernel

enableDropletIpv6

enableDropletPrivateNetworking

getAccountInfo

getAvailableActions

getActionInfo

getAvailableDropletActions

getAvailableImageActions

getAvailableFloatingIPActions

getFloatingIPActionInfo

getAvailableVolumeActions

getVolumeAction

getAvailableImages

getAvailableImages

getUserImages

getImageInfo

getImageInfo

createCustomImage

updateImage

deleteImage

transferImage

convertImage

getAvailableRegions

getAvailableSizes

getAvailableDomains

getDomainInfo

createDomain

deleteDomain

getDomainRecords

getDomainRecordInfo

createDomainRecord