net.minidev.ovh.api

Class ApiOvhDedicatedhousing

java.lang.Object

net.minidev.ovh.core.ApiOvhBase

net.minidev.ovh.api.ApiOvhDedicatedhousing

public class ApiOvhDedicatedhousing
extends ApiOvhBase

BasePath:https://eu.api.ovh.com/1.0 ResourcePath:/dedicated/housing version:1.0

Field Summary

Fields inherited from class net.minidev.ovh.core.ApiOvhBase

core

Constructor Summary

Constructors

Constructor and Description
ApiOvhDedicatedhousing(ApiOvhCore core)

Method Summary

Modifier and Type	Method and Description
ArrayList<String>	GET() List available services REST: GET /dedicated/housing
ArrayList<String>	serviceName_features_backupFTP_access_GET(String serviceName) List of IP blocks (and protocols to allow on these blocks) authorized on your backup FTP REST: GET /dedicated/housing/{serviceName}/features/backupFTP/access
OvhTask	serviceName_features_backupFTP_access_ipBlock_DELETE(String serviceName, String ipBlock) Revoke this ACL REST: DELETE /dedicated/housing/{serviceName}/features/backupFTP/access/{ipBlock}
OvhBackupFtpAcl	serviceName_features_backupFTP_access_ipBlock_GET(String serviceName, String ipBlock) Get this object properties REST: GET /dedicated/housing/{serviceName}/features/backupFTP/access/{ipBlock}
void	serviceName_features_backupFTP_access_ipBlock_PUT(String serviceName, String ipBlock, OvhBackupFtpAcl body) Alter this object properties REST: PUT /dedicated/housing/{serviceName}/features/backupFTP/access/{ipBlock}
OvhTask	serviceName_features_backupFTP_access_POST(String serviceName, Boolean cifs, Boolean ftp, String ipBlock, Boolean nfs) Create a new Backup FTP ACL REST: POST /dedicated/housing/{serviceName}/features/backupFTP/access
ArrayList<String>	serviceName_features_backupFTP_authorizableBlocks_GET(String serviceName) Get all IP blocks that can be used in the ACL REST: GET /dedicated/housing/{serviceName}/features/backupFTP/authorizableBlocks
OvhTask	serviceName_features_backupFTP_DELETE(String serviceName) Terminate your Backup FTP service, ALL DATA WILL BE PERMANENTLY DELETED REST: DELETE /dedicated/housing/{serviceName}/features/backupFTP
OvhBackupFtp	serviceName_features_backupFTP_GET(String serviceName) Get this object properties REST: GET /dedicated/housing/{serviceName}/features/backupFTP
OvhTask	serviceName_features_backupFTP_password_POST(String serviceName) Change your Backup FTP password REST: POST /dedicated/housing/{serviceName}/features/backupFTP/password
OvhTask	serviceName_features_backupFTP_POST(String serviceName) Create a new Backup FTP space REST: POST /dedicated/housing/{serviceName}/features/backupFTP
OvhHousing	serviceName_GET(String serviceName) Get this object properties REST: GET /dedicated/housing/{serviceName}
OvhApcOrderable	serviceName_orderable_APC_GET(String serviceName) Is an APC orderable for this housing bay REST: GET /dedicated/housing/{serviceName}/orderable/APC
OvhService	serviceName_serviceInfos_GET(String serviceName) Get this object properties REST: GET /dedicated/housing/{serviceName}/serviceInfos
void	serviceName_serviceInfos_PUT(String serviceName, OvhService body) Alter this object properties REST: PUT /dedicated/housing/{serviceName}/serviceInfos
ArrayList<Long>	serviceName_task_GET(String serviceName, OvhTaskFunctionEnum function, OvhTaskStatusEnum status) View task list REST: GET /dedicated/housing/{serviceName}/task
void	serviceName_task_taskId_cancel_POST(String serviceName, Long taskId) this action stop the task progression if it's possible REST: POST /dedicated/housing/{serviceName}/task/{taskId}/cancel
OvhTask	serviceName_task_taskId_GET(String serviceName, Long taskId) Get this object properties REST: GET /dedicated/housing/{serviceName}/task/{taskId}

Methods inherited from class net.minidev.ovh.core.ApiOvhBase

addBody, convertTo, convertTo, exec, execN, getCore, getNic, path, query

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ApiOvhDedicatedhousing

public ApiOvhDedicatedhousing(ApiOvhCore core)

Method Detail

GET

public ArrayList<String> GET()
                      throws IOException

List available services REST: GET /dedicated/housing

Throws:

IOException

serviceName_orderable_APC_GET

public OvhApcOrderable serviceName_orderable_APC_GET(String serviceName)
                                              throws IOException

Is an APC orderable for this housing bay REST: GET /dedicated/housing/{serviceName}/orderable/APC

Parameters:

serviceName - [required] The internal name of your Housing bay

Throws:

IOException

serviceName_GET

public OvhHousing serviceName_GET(String serviceName)
                           throws IOException

Get this object properties REST: GET /dedicated/housing/{serviceName}

Parameters:

serviceName - [required] The internal name of your Housing bay

Throws:

IOException

serviceName_task_taskId_GET

public OvhTask serviceName_task_taskId_GET(String serviceName,
                                           Long taskId)
                                    throws IOException

Get this object properties REST: GET /dedicated/housing/{serviceName}/task/{taskId}

Parameters:

serviceName - [required] The internal name of your Housing bay

taskId - [required] the id of the task

Throws:

IOException

serviceName_task_taskId_cancel_POST

public void serviceName_task_taskId_cancel_POST(String serviceName,
                                                Long taskId)
                                         throws IOException

this action stop the task progression if it's possible REST: POST /dedicated/housing/{serviceName}/task/{taskId}/cancel

Parameters:

serviceName - [required] The internal name of your Housing bay

taskId - [required] the id of the task

Throws:

IOException

serviceName_task_GET

public ArrayList<Long> serviceName_task_GET(String serviceName,
                                            OvhTaskFunctionEnum function,
                                            OvhTaskStatusEnum status)
                                     throws IOException

View task list REST: GET /dedicated/housing/{serviceName}/task

Parameters:

status - [required] Filter the value of status property (=)

function - [required] Filter the value of function property (=)

serviceName - [required] The internal name of your Housing bay

Throws:

IOException

serviceName_features_backupFTP_access_ipBlock_GET

public OvhBackupFtpAcl serviceName_features_backupFTP_access_ipBlock_GET(String serviceName,
                                                                         String ipBlock)
                                                                  throws IOException

Get this object properties REST: GET /dedicated/housing/{serviceName}/features/backupFTP/access/{ipBlock}

Parameters:

serviceName - [required] The internal name of your Housing bay

ipBlock - [required] The IP Block specific to this ACL

Throws:

IOException

serviceName_features_backupFTP_access_ipBlock_PUT

public void serviceName_features_backupFTP_access_ipBlock_PUT(String serviceName,
                                                              String ipBlock,
                                                              OvhBackupFtpAcl body)
                                                       throws IOException

Alter this object properties REST: PUT /dedicated/housing/{serviceName}/features/backupFTP/access/{ipBlock}

Parameters:

body - [required] New object properties

serviceName - [required] The internal name of your Housing bay

ipBlock - [required] The IP Block specific to this ACL

Throws:

IOException

serviceName_features_backupFTP_access_ipBlock_DELETE

public OvhTask serviceName_features_backupFTP_access_ipBlock_DELETE(String serviceName,
                                                                    String ipBlock)
                                                             throws IOException

Revoke this ACL REST: DELETE /dedicated/housing/{serviceName}/features/backupFTP/access/{ipBlock}

Parameters:

serviceName - [required] The internal name of your Housing bay

ipBlock - [required] The IP Block specific to this ACL

Throws:

IOException

serviceName_features_backupFTP_access_GET

public ArrayList<String> serviceName_features_backupFTP_access_GET(String serviceName)
                                                            throws IOException

List of IP blocks (and protocols to allow on these blocks) authorized on your backup FTP REST: GET /dedicated/housing/{serviceName}/features/backupFTP/access

Parameters:

serviceName - [required] The internal name of your Housing bay

Throws:

IOException

serviceName_features_backupFTP_access_POST

public OvhTask serviceName_features_backupFTP_access_POST(String serviceName,
                                                          Boolean cifs,
                                                          Boolean ftp,
                                                          String ipBlock,
                                                          Boolean nfs)
                                                   throws IOException

Create a new Backup FTP ACL REST: POST /dedicated/housing/{serviceName}/features/backupFTP/access

Parameters:

ftp - [required] Wether to allow the FTP protocol for this ACL

ipBlock - [required] The IP Block specific to this ACL. It musts belong to your server.

nfs - [required] Wether to allow the NFS protocol for this ACL

cifs - [required] Wether to allow the CIFS (SMB) protocol for this ACL

serviceName - [required] The internal name of your Housing bay

Throws:

IOException

serviceName_features_backupFTP_GET

public OvhBackupFtp serviceName_features_backupFTP_GET(String serviceName)
                                                throws IOException

Get this object properties REST: GET /dedicated/housing/{serviceName}/features/backupFTP

Parameters:

serviceName - [required] The internal name of your Housing bay

Throws:

IOException

serviceName_features_backupFTP_POST

public OvhTask serviceName_features_backupFTP_POST(String serviceName)
                                            throws IOException

Create a new Backup FTP space REST: POST /dedicated/housing/{serviceName}/features/backupFTP

Parameters:

serviceName - [required] The internal name of your Housing bay

Throws:

IOException

serviceName_features_backupFTP_DELETE

public OvhTask serviceName_features_backupFTP_DELETE(String serviceName)
                                              throws IOException

Terminate your Backup FTP service, ALL DATA WILL BE PERMANENTLY DELETED REST: DELETE /dedicated/housing/{serviceName}/features/backupFTP

Parameters:

serviceName - [required] The internal name of your Housing bay

Throws:

IOException

serviceName_features_backupFTP_authorizableBlocks_GET

public ArrayList<String> serviceName_features_backupFTP_authorizableBlocks_GET(String serviceName)
                                                                        throws IOException

Get all IP blocks that can be used in the ACL REST: GET /dedicated/housing/{serviceName}/features/backupFTP/authorizableBlocks

Parameters:

serviceName - [required] The internal name of your Housing bay

Throws:

IOException

serviceName_features_backupFTP_password_POST

public OvhTask serviceName_features_backupFTP_password_POST(String serviceName)
                                                     throws IOException

Change your Backup FTP password REST: POST /dedicated/housing/{serviceName}/features/backupFTP/password

Parameters:

serviceName - [required] The internal name of your Housing bay

Throws:

IOException

serviceName_serviceInfos_GET

public OvhService serviceName_serviceInfos_GET(String serviceName)
                                        throws IOException

Get this object properties REST: GET /dedicated/housing/{serviceName}/serviceInfos

Parameters:

serviceName - [required] The internal name of your Housing bay

Throws:

IOException

serviceName_serviceInfos_PUT

public void serviceName_serviceInfos_PUT(String serviceName,
                                         OvhService body)
                                  throws IOException

Alter this object properties REST: PUT /dedicated/housing/{serviceName}/serviceInfos

Parameters:

body - [required] New object properties

serviceName - [required] The internal name of your Housing bay

Throws:

IOException