public class DigitalOceanClient extends Object implements DigitalOcean, Constants
Modifier and Type | Field and Description |
---|---|
protected String |
apiHost
DigitalOcean API Host is
api.digitalocean.com |
protected String |
apiVersion
DigitalOcean API version.
|
protected String |
authToken
OAuth Authorization Token for Accessing DigitalOcean API
|
protected org.apache.http.impl.client.CloseableHttpClient |
httpClient
Http client
|
DATE_FORMAT, 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, NO_CONTENT_JSON_STRUCT, PARAM_PAGE_NO, RATE_LIMIT_ELEMENT_NAME, RATE_LIMIT_JSON_STRUCT, START_PAGE_NO, URL_PATH_SEPARATOR, USER_AGENT, UTF_8
Constructor and 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
|
Modifier and Type | Method and Description |
---|---|
Action |
changeDropletKernel(Integer dropletId,
Integer kernelId)
Method changes a OS kernel for given droplet
|
Action |
convertImage(Integer imageId)
Method allows you to convert image into snapshot
|
Domain |
createDomain(Domain domain)
Method creates a new domain name with an A record for the specified [ip_address].
|
DomainRecord |
createDomainRecord(String domainName,
DomainRecord domainRecord)
Method creates a new domain record name with an given domain record values
|
Droplet |
createDroplet(Droplet droplet)
Method allows you to create a new droplet.
|
Key |
createKey(Key newKey)
Method allows you to add a new public SSH key to your account
|
Delete |
deleteDomain(String domainName)
Method deletes the specified domain from DNS control panel
|
Delete |
deleteDomainRecord(String domainName,
Integer recordId)
Method deletes the specified domain record from domain.
|
Delete |
deleteDroplet(Integer dropletId)
Method destroys one of your droplet; this is irreversible.
|
Delete |
deleteImage(Integer imageId)
Method allows you to deletes an image.
|
Delete |
deleteKey(Integer sshKeyId)
Method will delete the SSH key from your account.
|
Delete |
deleteKey(String fingerprint)
Method will delete the SSH key from your account.
|
Action |
disableDropletBackups(Integer dropletId)
Method disables automatic backups from running to backup your droplet's data.
|
Action |
enableDropletIpv6(Integer dropletId)
Enabling IP v6 networking capability for droplet.
|
Action |
enableDropletPrivateNetworking(Integer dropletId)
Enabling private networking capability for droplet.
|
Account |
getAccountInfo()
Method returns account information for provided credentials
|
Action |
getActionInfo(Integer actionId)
To retrieve a specific action information by action ID
|
Neighbors |
getAllDropletNeighbors(Integer pageNo)
For an entire account; Method retrieves a list of any droplets that are
running on the same physical server (any other droplets that share the same physical hardware).
|
String |
getApiVersion() |
String |
getAuthToken() |
Actions |
getAvailableActions(Integer pageNo)
Method return all the action informations, regardless of categories.
|
Backups |
getAvailableBackups(Integer dropletId,
Integer pageNo)
Method returns all available snapshots for given droplet ID
|
Domains |
getAvailableDomains(Integer pageNo)
Method returns all of your available domains from DNS control panel
|
Actions |
getAvailableDropletActions(Integer dropletId,
Integer pageNo)
Method return all the action informations; specific to given Droplet Id
|
Droplets |
getAvailableDroplets(Integer pageNo)
Method returns all active droplets that are currently running in your account.
|
Actions |
getAvailableImageActions(Integer imageId,
Integer pageNo)
Method return all the action informations; specific to given Image Id
|
Images |
getAvailableImages(Integer pageNo)
Method returns all the available images that can be accessed by your OAuth Token.
|
Images |
getAvailableImages(Integer pageNo,
ActionType type)
Method returns all the available images based on
type={distribution or application} that can be accessed by your OAuth Token. |
Kernels |
getAvailableKernels(Integer dropletId,
Integer pageNo)
Method returns all available kernels for given droplet ID
|
Keys |
getAvailableKeys(Integer pageNo)
Method lists all the available public SSH keys in your account that can be added to a droplet.
|
Regions |
getAvailableRegions(Integer pageNo)
Method returns all the available regions within the DigitalOcean cloud.
|
Sizes |
getAvailableSizes(Integer pageNo)
Method returns all the available sizes that can be used to create a droplet.
|
Snapshots |
getAvailableSnapshots(Integer dropletId,
Integer pageNo)
Method returns all available snapshots for given droplet ID
|
Domain |
getDomainInfo(String domainName)
Method returns the specified domain attributes and zone file info.
|
DomainRecord |
getDomainRecordInfo(String domainName,
Integer recordId)
Method returns the specified domain record.
|
DomainRecords |
getDomainRecords(String domainName)
Method returns all of your current domain records from DNS control panel for given domain.
|
Droplet |
getDropletInfo(Integer dropletId)
Method returns complete information for given droplet ID
|
Droplets |
getDropletNeighbors(Integer dropletId,
Integer pageNo)
For an individual droplet; Method retrieves a list of droplets that are running on the same
physical server (any other droplets that share the same physical hardware).
|
org.apache.http.client.HttpClient |
getHttpClient() |
Image |
getImageInfo(Integer imageId)
Method retrieves the attributes of an image.
|
Image |
getImageInfo(String slug)
Method retrieves the attributes of an image.
|
Key |
getKeyInfo(Integer sshKeyId)
Method shows a specific public SSH key information from your account that can be added to a
droplet.
|
Key |
getKeyInfo(String fingerprint)
Method shows a specific public SSH key information from your account that can be added to a
droplet.
|
Images |
getUserImages(Integer pageNo)
Method retrieves only the private images of a user
|
Action |
powerCycleDroplet(Integer dropletId)
Method allows you to power cycle a droplet.
|
Action |
powerOffDroplet(Integer dropletId)
Method allows you to poweroff a running droplet.
|
Action |
powerOnDroplet(Integer dropletId)
Method allows you to poweron a powered off droplet.
|
Action |
rebootDroplet(Integer dropletId)
Method allows you to reboot a droplet.
|
Action |
rebuildDroplet(Integer dropletId,
Integer imageId)
Method allows you to reinstall a droplet with a default image.
|
Action |
renameDroplet(Integer dropletId,
String name)
Method renames the droplet to the specified name.
|
Action |
resetDropletPassword(Integer dropletId)
Method will reset the root password for a droplet.
|
Action |
resizeDroplet(Integer dropletId,
String size)
Method allows you to resize a specific droplet to a different size.
|
Action |
restoreDroplet(Integer dropletId,
Integer imageId)
Method allows you to restore a droplet with a previous image or snapshot.
|
void |
setApiVersion(String apiVersion) |
void |
setAuthToken(String authToken) |
void |
setHttpClient(org.apache.http.impl.client.CloseableHttpClient httpClient) |
Action |
shutdownDroplet(Integer dropletId)
Method allows you to shutdown a running droplet.
|
Action |
takeDropletSnapshot(Integer dropletId)
Method allows you to take a snapshot of the running droplet, which can later be restored or
used to create a new droplet from the same image.
|
Action |
takeDropletSnapshot(Integer dropletId,
String snapshotName)
Method allows you to take a snapshot of the running droplet, which can later be restored or
used to create a new droplet from the same image.
|
Action |
transferImage(Integer imageId,
String regionSlug)
Method allows you to transfer an image to a specified region.
|
DomainRecord |
updateDomainRecord(String domainName,
Integer recordId,
String name)
method edits an existing domain record of the given domain.
|
Image |
updateImage(Image image)
Method updates the given details for an image.
|
Key |
updateKey(Integer sshKeyId,
String newSshKeyName)
Method allows you to modify an existing SSH key in your account.
|
Key |
updateKey(String fingerprint,
String newSshKeyName)
Method allows you to modify an existing SSH key in your account.
|
protected org.apache.http.impl.client.CloseableHttpClient httpClient
protected String authToken
protected String apiVersion
protected String apiHost
api.digitalocean.com
public DigitalOceanClient(String authToken)
authToken
- a String
objectpublic DigitalOceanClient(String apiVersion, String authToken)
public org.apache.http.client.HttpClient getHttpClient()
public void setHttpClient(org.apache.http.impl.client.CloseableHttpClient httpClient)
httpClient
- the httpClient to setpublic String getAuthToken()
public void setAuthToken(String authToken)
authToken
- the authToken to setpublic String getApiVersion()
public void setApiVersion(String apiVersion)
apiVersion
- the apiVersion to setpublic Droplets getAvailableDroplets(Integer pageNo) throws DigitalOceanException, RequestUnsuccessfulException
DigitalOcean
getAvailableDroplets
in interface DigitalOcean
pageNo
- for paginationDroplets
DigitalOceanException
- if request had interruption [
HTTP status code >= 400 && < 510
]RequestUnsuccessfulException
- if any RESTful request unsuccessful from wrapper methodpublic Kernels getAvailableKernels(Integer dropletId, Integer pageNo) throws DigitalOceanException, RequestUnsuccessfulException
DigitalOcean
getAvailableKernels
in interface DigitalOcean
dropletId
- for kernel infopageNo
- for paginationKernels
DigitalOceanException
- if request had interruption [
HTTP status code >= 400 && < 510
]RequestUnsuccessfulException
- if any RESTful request unsuccessful from wrapper methodpublic Snapshots getAvailableSnapshots(Integer dropletId, Integer pageNo) throws DigitalOceanException, RequestUnsuccessfulException
DigitalOcean
getAvailableSnapshots
in interface DigitalOcean
dropletId
- for snapshot infopageNo
- for paginationSnapshots
DigitalOceanException
- if request had interruption [
HTTP status code >= 400 && < 510
]RequestUnsuccessfulException
- if any RESTful request unsuccessful from wrapper methodpublic Backups getAvailableBackups(Integer dropletId, Integer pageNo) throws DigitalOceanException, RequestUnsuccessfulException
DigitalOcean
getAvailableBackups
in interface DigitalOcean
dropletId
- for backup infopageNo
- for paginationBackups
DigitalOceanException
- if request had interruption [
HTTP status code >= 400 && < 510
]RequestUnsuccessfulException
- if any RESTful request unsuccessful from wrapper methodpublic Droplet getDropletInfo(Integer dropletId) throws DigitalOceanException, RequestUnsuccessfulException
DigitalOcean
getDropletInfo
in interface DigitalOcean
dropletId
- the id of the dropletDroplet
DigitalOceanException
- if request had interruption [
HTTP status code >= 400 && < 510
]RequestUnsuccessfulException
- if any RESTful request unsuccessful from wrapper methodpublic Droplet createDroplet(Droplet droplet) throws DigitalOceanException, RequestUnsuccessfulException
DigitalOcean
Method allows you to create a new droplet. See the required parameters section below for an explanation of the variables that are needed to create a new droplet.
Note: Currently return object doesn't include 'action' information of create droplet.
Create a instance of Droplet
class and populated the droplet object appropriately.
Minimum required values are -
{ "name": "example-droplet-name", "region": "nyc1", "size": "512mb", "image": 3445812 }
createDroplet
in interface DigitalOcean
droplet
- the id of the dropletDroplet
DigitalOceanException
- if request had interruption [
HTTP status code >= 400 && < 510
]RequestUnsuccessfulException
- if any RESTful request unsuccessful from wrapper methodpublic Delete deleteDroplet(Integer dropletId) throws DigitalOceanException, RequestUnsuccessfulException
DigitalOcean
deleteDroplet
in interface DigitalOcean
dropletId
- the id of the dropletDelete
DigitalOceanException
- if request had interruption [
HTTP status code >= 400 && < 510
]RequestUnsuccessfulException
- if any RESTful request unsuccessful from wrapper methodpublic Droplets getDropletNeighbors(Integer dropletId, Integer pageNo) throws DigitalOceanException, RequestUnsuccessfulException
DigitalOcean
getDropletNeighbors
in interface DigitalOcean
dropletId
- the id of the dropletpageNo
- for paginationDroplets
DigitalOceanException
- if request had interruption [
HTTP status code >= 400 && < 510
]RequestUnsuccessfulException
- if any RESTful request unsuccessful from wrapper methodpublic Neighbors getAllDropletNeighbors(Integer pageNo) throws DigitalOceanException, RequestUnsuccessfulException
DigitalOcean
getAllDropletNeighbors
in interface DigitalOcean
pageNo
- for paginationNeighbors
DigitalOceanException
- if request had interruption [
HTTP status code >= 400 && < 510
]RequestUnsuccessfulException
- if any RESTful request unsuccessful from wrapper methodpublic Action rebootDroplet(Integer dropletId) throws DigitalOceanException, RequestUnsuccessfulException
DigitalOcean
rebootDroplet
in interface DigitalOcean
dropletId
- the id of the dropletAction
DigitalOceanException
- if request had interruption [
HTTP status code >= 400 && < 510
]RequestUnsuccessfulException
- if any RESTful request unsuccessful from wrapper methodpublic Action powerCycleDroplet(Integer dropletId) throws DigitalOceanException, RequestUnsuccessfulException
DigitalOcean
powerCycleDroplet
in interface DigitalOcean
dropletId
- the id of the dropletAction
DigitalOceanException
- if request had interruption [
HTTP status code >= 400 && < 510
]RequestUnsuccessfulException
- if any RESTful request unsuccessful from wrapper methodpublic Action shutdownDroplet(Integer dropletId) throws DigitalOceanException, RequestUnsuccessfulException
DigitalOcean
shutdownDroplet
in interface DigitalOcean
dropletId
- the id of the dropletAction
DigitalOceanException
- if request had interruption [
HTTP status code >= 400 && < 510
]RequestUnsuccessfulException
- if any RESTful request unsuccessful from wrapper methodpublic Action powerOffDroplet(Integer dropletId) throws DigitalOceanException, RequestUnsuccessfulException
DigitalOcean
powerOffDroplet
in interface DigitalOcean
dropletId
- the id of the dropletAction
DigitalOceanException
- if request had interruption [
HTTP status code >= 400 && < 510
]RequestUnsuccessfulException
- if any RESTful request unsuccessful from wrapper methodpublic Action powerOnDroplet(Integer dropletId) throws DigitalOceanException, RequestUnsuccessfulException
DigitalOcean
powerOnDroplet
in interface DigitalOcean
dropletId
- the id of the dropletAction
DigitalOceanException
- if request had interruption [
HTTP status code >= 400 && < 510
]RequestUnsuccessfulException
- if any RESTful request unsuccessful from wrapper methodpublic Action resetDropletPassword(Integer dropletId) throws DigitalOceanException, RequestUnsuccessfulException
DigitalOcean
resetDropletPassword
in interface DigitalOcean
dropletId
- the id of the dropletAction
DigitalOceanException
- if request had interruption [
HTTP status code >= 400 && < 510
]RequestUnsuccessfulException
- if any RESTful request unsuccessful from wrapper methodpublic Action resizeDroplet(Integer dropletId, String size) throws DigitalOceanException, RequestUnsuccessfulException
DigitalOcean
resizeDroplet
in interface DigitalOcean
dropletId
- the id of the dropletsize
- of the dropletAction
DigitalOceanException
- if request had interruption [
HTTP status code >= 400 && < 510
]RequestUnsuccessfulException
- if any RESTful request unsuccessful from wrapper methodpublic Action takeDropletSnapshot(Integer dropletId) throws DigitalOceanException, RequestUnsuccessfulException
DigitalOcean
takeDropletSnapshot
in interface DigitalOcean
dropletId
- the id of the dropletAction
DigitalOceanException
- if request had interruption [
HTTP status code >= 400 && < 510
]RequestUnsuccessfulException
- if any RESTful request unsuccessful from wrapper methodpublic Action takeDropletSnapshot(Integer dropletId, String snapshotName) throws DigitalOceanException, RequestUnsuccessfulException
DigitalOcean
takeDropletSnapshot
in interface DigitalOcean
dropletId
- the id of the dropletsnapshotName
- the name the snapshot to be createdAction
DigitalOceanException
- if request had interruption [
HTTP status code >= 400 && < 510
]RequestUnsuccessfulException
- if any RESTful request unsuccessful from wrapper methodpublic Action restoreDroplet(Integer dropletId, Integer imageId) throws DigitalOceanException, RequestUnsuccessfulException
DigitalOcean
restoreDroplet
in interface DigitalOcean
dropletId
- the id of the dropletimageId
- the id of the DigitalOcean public image or your private imageAction
DigitalOceanException
- if request had interruption [
HTTP status code >= 400 && < 510
]RequestUnsuccessfulException
- if any RESTful request unsuccessful from wrapper methodpublic Action rebuildDroplet(Integer dropletId, Integer imageId) throws DigitalOceanException, RequestUnsuccessfulException
DigitalOcean
rebuildDroplet
in interface DigitalOcean
dropletId
- the id of the dropletimageId
- the id of the DigitalOcean public image or your private imageAction
DigitalOceanException
- if request had interruption [
HTTP status code >= 400 && < 510
]RequestUnsuccessfulException
- if any RESTful request unsuccessful from wrapper methodpublic Action disableDropletBackups(Integer dropletId) throws DigitalOceanException, RequestUnsuccessfulException
DigitalOcean
disableDropletBackups
in interface DigitalOcean
dropletId
- the id of the dropletAction
DigitalOceanException
- if request had interruption [
HTTP status code >= 400 && < 510
]RequestUnsuccessfulException
- if any RESTful request unsuccessful from wrapper methodpublic Action renameDroplet(Integer dropletId, String name) throws DigitalOceanException, RequestUnsuccessfulException
DigitalOcean
renameDroplet
in interface DigitalOcean
dropletId
- the id of the dropletname
- the new name of droplet to be calledAction
DigitalOceanException
- if request had interruption [
HTTP status code >= 400 && < 510
]RequestUnsuccessfulException
- if any RESTful request unsuccessful from wrapper methodpublic Action changeDropletKernel(Integer dropletId, Integer kernelId) throws DigitalOceanException, RequestUnsuccessfulException
DigitalOcean
changeDropletKernel
in interface DigitalOcean
dropletId
- the id of the dropletkernelId
- the kernel id to be changed for dropletAction
DigitalOceanException
- if request had interruption [
HTTP status code >= 400 && < 510
]RequestUnsuccessfulException
- if any RESTful request unsuccessful from wrapper methodpublic Action enableDropletIpv6(Integer dropletId) throws DigitalOceanException, RequestUnsuccessfulException
DigitalOcean
enableDropletIpv6
in interface DigitalOcean
dropletId
- the id of the dropletAction
DigitalOceanException
- if request had interruption [
HTTP status code >= 400 && < 510
]RequestUnsuccessfulException
- if any RESTful request unsuccessful from wrapper methodpublic Action enableDropletPrivateNetworking(Integer dropletId) throws DigitalOceanException, RequestUnsuccessfulException
DigitalOcean
enableDropletPrivateNetworking
in interface DigitalOcean
dropletId
- the id of the dropletAction
DigitalOceanException
- if request had interruption [
HTTP status code >= 400 && < 510
]RequestUnsuccessfulException
- if any RESTful request unsuccessful from wrapper methodpublic Account getAccountInfo() throws DigitalOceanException, RequestUnsuccessfulException
DigitalOcean
getAccountInfo
in interface DigitalOcean
Account
DigitalOceanException
- if request had interruption [
HTTP status code >= 400 && < 510
]RequestUnsuccessfulException
- if any RESTful request unsuccessful from wrapper methodpublic Actions getAvailableActions(Integer pageNo) throws DigitalOceanException, RequestUnsuccessfulException
DigitalOcean
getAvailableActions
in interface DigitalOcean
pageNo
- for paginationActions
DigitalOceanException
- if request had interruption [
HTTP status code >= 400 && < 510
]RequestUnsuccessfulException
- if any RESTful request unsuccessful from wrapper methodpublic Action getActionInfo(Integer actionId) throws DigitalOceanException, RequestUnsuccessfulException
DigitalOcean
getActionInfo
in interface DigitalOcean
actionId
- the id of actionAction
DigitalOceanException
- if request had interruption [
HTTP status code >= 400 && < 510
]RequestUnsuccessfulException
- if any RESTful request unsuccessful from wrapper methodpublic Actions getAvailableDropletActions(Integer dropletId, Integer pageNo) throws DigitalOceanException, RequestUnsuccessfulException
DigitalOcean
getAvailableDropletActions
in interface DigitalOcean
dropletId
- the id of the dropletpageNo
- for paginationActions
DigitalOceanException
- if request had interruption [
HTTP status code >= 400 && < 510
]RequestUnsuccessfulException
- if any RESTful request unsuccessful from wrapper methodpublic Actions getAvailableImageActions(Integer imageId, Integer pageNo) throws DigitalOceanException, RequestUnsuccessfulException
DigitalOcean
getAvailableImageActions
in interface DigitalOcean
imageId
- the id of the ImagepageNo
- for paginationActions
DigitalOceanException
- if request had interruption [
HTTP status code >= 400 && < 510
]RequestUnsuccessfulException
- if any RESTful request unsuccessful from wrapper methodpublic Images getAvailableImages(Integer pageNo) throws DigitalOceanException, RequestUnsuccessfulException
DigitalOcean
getAvailableImages
in interface DigitalOcean
pageNo
- of request paginationImages
DigitalOceanException
- if request had interruption [
HTTP status code >= 400 && < 510
]RequestUnsuccessfulException
- if any RESTful request unsuccessful from wrapper methodpublic Images getAvailableImages(Integer pageNo, ActionType type) throws DigitalOceanException, RequestUnsuccessfulException
DigitalOcean
type={distribution or application}
that can be accessed by your OAuth Token.getAvailableImages
in interface DigitalOcean
pageNo
- of request paginationtype
- of actionImages
DigitalOceanException
- if request had interruption [
HTTP status code >= 400 && < 510
]RequestUnsuccessfulException
- if any RESTful request unsuccessful from wrapper methodpublic Images getUserImages(Integer pageNo) throws DigitalOceanException, RequestUnsuccessfulException
DigitalOcean
getUserImages
in interface DigitalOcean
pageNo
- of request paginationImages
DigitalOceanException
- if request had interruption [
HTTP status code >= 400 && < 510
]RequestUnsuccessfulException
- if any RESTful request unsuccessful from wrapper methodpublic Image getImageInfo(Integer imageId) throws DigitalOceanException, RequestUnsuccessfulException
DigitalOcean
getImageInfo
in interface DigitalOcean
imageId
- the image Id of the droplet/snapshot/backup imagesImage
DigitalOceanException
- if request had interruption [
HTTP status code >= 400 && < 510
]RequestUnsuccessfulException
- if any RESTful request unsuccessful from wrapper methodpublic Image getImageInfo(String slug) throws DigitalOceanException, RequestUnsuccessfulException
DigitalOcean
getImageInfo
in interface DigitalOcean
slug
- of the public imageImage
DigitalOceanException
- if request had interruption [
HTTP status code >= 400 && < 510
]RequestUnsuccessfulException
- if any RESTful request unsuccessful from wrapper methodpublic Image updateImage(Image image) throws DigitalOceanException, RequestUnsuccessfulException
DigitalOcean
updateImage
in interface DigitalOcean
image
- object for updateImage
DigitalOceanException
- if request had interruption [
HTTP status code >= 400 && < 510
]RequestUnsuccessfulException
- if any RESTful request unsuccessful from wrapper methodpublic Delete deleteImage(Integer imageId) throws DigitalOceanException, RequestUnsuccessfulException
DigitalOcean
deleteImage
in interface DigitalOcean
imageId
- of the droplet/snapshot/backup imagesDelete
DigitalOceanException
- if request had interruption [
HTTP status code >= 400 && < 510
]RequestUnsuccessfulException
- if any RESTful request unsuccessful from wrapper methodpublic Action transferImage(Integer imageId, String regionSlug) throws DigitalOceanException, RequestUnsuccessfulException
DigitalOcean
transferImage
in interface DigitalOcean
imageId
- the Id of the droplet/snapshot/backup imagesregionSlug
- is code name of the region aka DigitalOcean data centersAction
DigitalOceanException
- if request had interruption [
HTTP status code >= 400 && < 510
]RequestUnsuccessfulException
- if any RESTful request unsuccessful from wrapper methodpublic Action convertImage(Integer imageId) throws DigitalOceanException, RequestUnsuccessfulException
DigitalOcean
convertImage
in interface DigitalOcean
imageId
- the Id of the droplet/snapshot/backup imagesAction
DigitalOceanException
- if request had interruption [
HTTP status code >= 400 && < 510
]RequestUnsuccessfulException
- if any RESTful request unsuccessful from wrapper methodpublic Regions getAvailableRegions(Integer pageNo) throws DigitalOceanException, RequestUnsuccessfulException
DigitalOcean
getAvailableRegions
in interface DigitalOcean
pageNo
- for paginationRegions
DigitalOceanException
- if request had interruption [
HTTP status code >= 400 && < 510
]RequestUnsuccessfulException
- if any RESTful request unsuccessful from wrapper methodpublic Sizes getAvailableSizes(Integer pageNo) throws DigitalOceanException, RequestUnsuccessfulException
DigitalOcean
getAvailableSizes
in interface DigitalOcean
pageNo
- for paginationSizes
DigitalOceanException
- if request had interruption [
HTTP status code >= 400 && < 510
]RequestUnsuccessfulException
- if any RESTful request unsuccessful from wrapper methodpublic Domains getAvailableDomains(Integer pageNo) throws DigitalOceanException, RequestUnsuccessfulException
DigitalOcean
getAvailableDomains
in interface DigitalOcean
pageNo
- for paginationDomains
DigitalOceanException
- if request had interruption [
HTTP status code >= 400 && < 510
]RequestUnsuccessfulException
- if any RESTful request unsuccessful from wrapper methodpublic Domain getDomainInfo(String domainName) throws DigitalOceanException, RequestUnsuccessfulException
DigitalOcean
getDomainInfo
in interface DigitalOcean
domainName
- the name of the domainDomain
DigitalOceanException
- if request had interruption [
HTTP status code >= 400 && < 510
]RequestUnsuccessfulException
- if any RESTful request unsuccessful from wrapper methodpublic Domain createDomain(Domain domain) throws DigitalOceanException, RequestUnsuccessfulException
DigitalOcean
createDomain
in interface DigitalOcean
domain
- object with name and IP address for creationDomain
DigitalOceanException
- if request had interruption [
HTTP status code >= 400 && < 510
]RequestUnsuccessfulException
- if any RESTful request unsuccessful from wrapper methodpublic Delete deleteDomain(String domainName) throws DigitalOceanException, RequestUnsuccessfulException
DigitalOcean
deleteDomain
in interface DigitalOcean
domainName
- the name of the domainDelete
DigitalOceanException
- if request had interruption [
HTTP status code >= 400 && < 510
]RequestUnsuccessfulException
- if any RESTful request unsuccessful from wrapper methodpublic DomainRecords getDomainRecords(String domainName) throws DigitalOceanException, RequestUnsuccessfulException
DigitalOcean
getDomainRecords
in interface DigitalOcean
domainName
- of the domainDomainRecords
DigitalOceanException
- if request had interruption [
HTTP status code >= 400 && < 510
]RequestUnsuccessfulException
- if any RESTful request unsuccessful from wrapper methodpublic DomainRecord getDomainRecordInfo(String domainName, Integer recordId) throws DigitalOceanException, RequestUnsuccessfulException
DigitalOcean
getDomainRecordInfo
in interface DigitalOcean
domainName
- of the domainrecordId
- of the domainDomainRecord
DigitalOceanException
- if request had interruption [
HTTP status code >= 400 && < 510
]RequestUnsuccessfulException
- if any RESTful request unsuccessful from wrapper methodpublic DomainRecord createDomainRecord(String domainName, DomainRecord domainRecord) throws DigitalOceanException, RequestUnsuccessfulException
DigitalOcean
createDomainRecord
in interface DigitalOcean
domainName
- of the domaindomainRecord
- the domain record values domain Id, record type, data, name, priority,
port, weightDomainRecord
DigitalOceanException
- if request had interruption [
HTTP status code >= 400 && < 510
]RequestUnsuccessfulException
- if any RESTful request unsuccessful from wrapper methodpublic DomainRecord updateDomainRecord(String domainName, Integer recordId, String name) throws DigitalOceanException, RequestUnsuccessfulException
DigitalOcean
updateDomainRecord
in interface DigitalOcean
domainName
- of the domainrecordId
- of the domainname
- of the domain recordDomainRecord
DigitalOceanException
- if request had interruption [
HTTP status code >= 400 && < 510
]RequestUnsuccessfulException
- if any RESTful request unsuccessful from wrapper methodpublic Delete deleteDomainRecord(String domainName, Integer recordId) throws DigitalOceanException, RequestUnsuccessfulException
DigitalOcean
deleteDomainRecord
in interface DigitalOcean
domainName
- of the domainrecordId
- of the domainDelete
DigitalOceanException
- if request had interruption [
HTTP status code >= 400 && < 510
]RequestUnsuccessfulException
- if any RESTful request unsuccessful from wrapper methodpublic Keys getAvailableKeys(Integer pageNo) throws DigitalOceanException, RequestUnsuccessfulException
DigitalOcean
getAvailableKeys
in interface DigitalOcean
pageNo
- for paginationKeys
DigitalOceanException
- if request had interruption [
HTTP status code >= 400 && < 510
]RequestUnsuccessfulException
- if any RESTful request unsuccessful from wrapper methodpublic Key getKeyInfo(Integer sshKeyId) throws DigitalOceanException, RequestUnsuccessfulException
DigitalOcean
getKeyInfo
in interface DigitalOcean
sshKeyId
- the SSH key IdKey
DigitalOceanException
- if request had interruption [
HTTP status code >= 400 && < 510
]RequestUnsuccessfulException
- if any RESTful request unsuccessful from wrapper methodpublic Key getKeyInfo(String fingerprint) throws DigitalOceanException, RequestUnsuccessfulException
DigitalOcean
getKeyInfo
in interface DigitalOcean
fingerprint
- the SSH key fingerprintKey
DigitalOceanException
- if request had interruption [
HTTP status code >= 400 && < 510
]RequestUnsuccessfulException
- if any RESTful request unsuccessful from wrapper methodpublic Key createKey(Key newKey) throws DigitalOceanException, RequestUnsuccessfulException
DigitalOcean
createKey
in interface DigitalOcean
newKey
- the Key
object with sshKeyName and sshPublicKeyKey
DigitalOceanException
- if request had interruption [
HTTP status code >= 400 && < 510
]RequestUnsuccessfulException
- if any RESTful request unsuccessful from wrapper methodpublic Key updateKey(Integer sshKeyId, String newSshKeyName) throws DigitalOceanException, RequestUnsuccessfulException
DigitalOcean
updateKey
in interface DigitalOcean
sshKeyId
- the SSH key IdnewSshKeyName
- the new name to give the SSH keyKey
DigitalOceanException
- if request had interruption [
HTTP status code >= 400 && < 510
]RequestUnsuccessfulException
- if any RESTful request unsuccessful from wrapper methodpublic Key updateKey(String fingerprint, String newSshKeyName) throws DigitalOceanException, RequestUnsuccessfulException
DigitalOcean
updateKey
in interface DigitalOcean
fingerprint
- the SSH fingerprintnewSshKeyName
- the new name to give the SSH keyKey
DigitalOceanException
- if request had interruption [
HTTP status code >= 400 && < 510
]RequestUnsuccessfulException
- if any RESTful request unsuccessful from wrapper methodpublic Delete deleteKey(Integer sshKeyId) throws DigitalOceanException, RequestUnsuccessfulException
DigitalOcean
deleteKey
in interface DigitalOcean
sshKeyId
- the SSH key Id, you would like to deleteDelete
DigitalOceanException
- if request had interruption [
HTTP status code >= 400 && < 510
]RequestUnsuccessfulException
- if any RESTful request unsuccessful from wrapper methodpublic Delete deleteKey(String fingerprint) throws DigitalOceanException, RequestUnsuccessfulException
DigitalOcean
deleteKey
in interface DigitalOcean
fingerprint
- the SSH fingerprintDelete
DigitalOceanException
- if request had interruption [
HTTP status code >= 400 && < 510
]RequestUnsuccessfulException
- if any RESTful request unsuccessful from wrapper method
The copyright of the pages and contents on this website is with myjeeva.com and the content is licensed under Creative Commons – Attribution-ShareAlike 4.0 International (CC BY-SA 4.0). Libraries and code snippets on myjeeva blog has license information.