net.minidev.ovh.api

Class ApiOvhDeskaas

java.lang.Object

net.minidev.ovh.core.ApiOvhBase

net.minidev.ovh.api.ApiOvhDeskaas

public class ApiOvhDeskaas
extends ApiOvhBase

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

Field Summary

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

core

Constructor Summary

Constructors

Constructor and Description
ApiOvhDeskaas(ApiOvhCore core)

Method Summary

Modifier and Type	Method and Description
ArrayList<String>	GET() List available services REST: GET /deskaas
OvhTask	serviceName_changeAlias_POST(String serviceName, String alias) Change the Virtual Desktop alias REST: POST /deskaas/{serviceName}/changeAlias
ArrayList<Long>	serviceName_changeContact_POST(String serviceName, String contactAdmin, String contactBilling, String contactTech) Launch a contact change procedure REST: POST /deskaas/{serviceName}/changeContact
String	serviceName_confirmTermination_POST(String serviceName, String commentary, OvhTerminationFutureUseEnum futureUse, OvhTerminationReasonEnum reason, String token) Confirm termination of your service REST: POST /deskaas/{serviceName}/confirmTermination
OvhTask	serviceName_console_POST(String serviceName) New console access REST: POST /deskaas/{serviceName}/console
OvhDeskaas	serviceName_GET(String serviceName) Get this object properties REST: GET /deskaas/{serviceName}
OvhPasswordPolicy	serviceName_passwordPolicy_GET(String serviceName) Get the current password policy for your Desktop As A Service REST: GET /deskaas/{serviceName}/passwordPolicy
OvhTask	serviceName_reboot_POST(String serviceName) Reboot the Operating system of the Cloud Desktop.
OvhTask	serviceName_refresh_POST(String serviceName) Refresh the Operating system of the Desktop As A Service.
OvhService	serviceName_serviceInfos_GET(String serviceName) Get this object properties REST: GET /deskaas/{serviceName}/serviceInfos
void	serviceName_serviceInfos_PUT(String serviceName, OvhService body) Alter this object properties REST: PUT /deskaas/{serviceName}/serviceInfos
ArrayList<Long>	serviceName_task_GET(String serviceName, OvhTaskStateEnum state) Tasks associated with this Desktop As A Service REST: GET /deskaas/{serviceName}/task
OvhTask	serviceName_task_taskId_GET(String serviceName, Long taskId) Get this object properties REST: GET /deskaas/{serviceName}/task/{taskId}
String	serviceName_terminate_POST(String serviceName) Terminate your service REST: POST /deskaas/{serviceName}/terminate
OvhTask	serviceName_upgrade_POST(String serviceName, String newReference, String planCode) Upgrading the Desktop As A Service to another profile.
OvhTask	serviceName_user_changePassword_POST(String serviceName, String password) Change Desktop As A Service user password REST: POST /deskaas/{serviceName}/user/changePassword
OvhTask	serviceName_user_changeProperties_POST(String serviceName, String email) Change Desktop As A Service user properties REST: POST /deskaas/{serviceName}/user/changeProperties
OvhUser	serviceName_user_GET(String serviceName) Get this object properties REST: GET /deskaas/{serviceName}/user
ArrayList<Long>	serviceName_user_task_GET(String serviceName, OvhTaskStateEnum state) Tasks associated with this User REST: GET /deskaas/{serviceName}/user/task
OvhTask	serviceName_user_task_taskId_GET(String serviceName, Long taskId) Get this object properties REST: GET /deskaas/{serviceName}/user/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

ApiOvhDeskaas

public ApiOvhDeskaas(ApiOvhCore core)

Method Detail

serviceName_changeContact_POST

public ArrayList<Long> serviceName_changeContact_POST(String serviceName,
                                                      String contactAdmin,
                                                      String contactBilling,
                                                      String contactTech)
                                               throws IOException

Launch a contact change procedure REST: POST /deskaas/{serviceName}/changeContact

Parameters:

contactAdmin - The contact to set as admin contact

contactTech - The contact to set as tech contact

contactBilling - The contact to set as billing contact

serviceName - [required] Domain of the service

Throws:

IOException

serviceName_confirmTermination_POST

public String serviceName_confirmTermination_POST(String serviceName,
                                                  String commentary,
                                                  OvhTerminationFutureUseEnum futureUse,
                                                  OvhTerminationReasonEnum reason,
                                                  String token)
                                           throws IOException

Confirm termination of your service REST: POST /deskaas/{serviceName}/confirmTermination

Parameters:

futureUse - What next after your termination request

reason - Reason of your termination request

commentary - Commentary about your termination request

token - [required] The termination token sent by mail to the admin contact

serviceName - [required] Domain of the service

Throws:

IOException

serviceName_serviceInfos_GET

public OvhService serviceName_serviceInfos_GET(String serviceName)
                                        throws IOException

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

Parameters:

serviceName - [required] Domain of the service

Throws:

IOException

serviceName_serviceInfos_PUT

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

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

Parameters:

body - [required] New object properties

serviceName - [required] Domain of the service

Throws:

IOException

serviceName_refresh_POST

public OvhTask serviceName_refresh_POST(String serviceName)
                                 throws IOException

Refresh the Operating system of the Desktop As A Service. All your personnal data are kept. REST: POST /deskaas/{serviceName}/refresh

Parameters:

serviceName - [required] Domain of the service

Throws:

IOException

serviceName_upgrade_POST

public OvhTask serviceName_upgrade_POST(String serviceName,
                                        String newReference,
                                        String planCode)
                                 throws IOException

Upgrading the Desktop As A Service to another profile. The Virtual Desktop will not be available during upgrade and has to be restarted. You cannot downgrade a Virtual Desktop REST: POST /deskaas/{serviceName}/upgrade

Parameters:

planCode - [required] New plan of Desktop As A Service

newReference - [required] New reference of Desktop As A Service

serviceName - [required] Domain of the service

Throws:

IOException

serviceName_changeAlias_POST

public OvhTask serviceName_changeAlias_POST(String serviceName,
                                            String alias)
                                     throws IOException

Change the Virtual Desktop alias REST: POST /deskaas/{serviceName}/changeAlias

Parameters:

alias - [required] New alias of Desktop As A Service

serviceName - [required] Domain of the service

Throws:

IOException

serviceName_terminate_POST

public String serviceName_terminate_POST(String serviceName)
                                  throws IOException

Terminate your service REST: POST /deskaas/{serviceName}/terminate

Parameters:

serviceName - [required] Domain of the service

Throws:

IOException

serviceName_passwordPolicy_GET

public OvhPasswordPolicy serviceName_passwordPolicy_GET(String serviceName)
                                                 throws IOException

Get the current password policy for your Desktop As A Service REST: GET /deskaas/{serviceName}/passwordPolicy

Parameters:

serviceName - [required] Domain of the service

Throws:

IOException

serviceName_user_GET

public OvhUser serviceName_user_GET(String serviceName)
                             throws IOException

Get this object properties REST: GET /deskaas/{serviceName}/user

Parameters:

serviceName - [required] Domain of the service

Throws:

IOException

serviceName_user_changePassword_POST

public OvhTask serviceName_user_changePassword_POST(String serviceName,
                                                    String password)
                                             throws IOException

Change Desktop As A Service user password REST: POST /deskaas/{serviceName}/user/changePassword

Parameters:

password - [required] New password for this Desktop As A Service user. It must fits your Desktop As A Service password policy. If this field is empty, a random password will be generated and sent by email.

serviceName - [required] Domain of the service

Throws:

IOException

serviceName_user_task_GET

public ArrayList<Long> serviceName_user_task_GET(String serviceName,
                                                 OvhTaskStateEnum state)
                                          throws IOException

Tasks associated with this User REST: GET /deskaas/{serviceName}/user/task

Parameters:

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

serviceName - [required] Domain of the service

Throws:

IOException

serviceName_user_task_taskId_GET

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

Get this object properties REST: GET /deskaas/{serviceName}/user/task/{taskId}

Parameters:

serviceName - [required] Domain of the service

taskId - [required] Task id

Throws:

IOException

serviceName_user_changeProperties_POST

public OvhTask serviceName_user_changeProperties_POST(String serviceName,
                                                      String email)
                                               throws IOException

Change Desktop As A Service user properties REST: POST /deskaas/{serviceName}/user/changeProperties

Parameters:

email - [required]

serviceName - [required] Domain of the service

Throws:

IOException

serviceName_console_POST

public OvhTask serviceName_console_POST(String serviceName)
                                 throws IOException

New console access REST: POST /deskaas/{serviceName}/console

Parameters:

serviceName - [required] Domain of the service

Throws:

IOException

serviceName_GET

public OvhDeskaas serviceName_GET(String serviceName)
                           throws IOException

Get this object properties REST: GET /deskaas/{serviceName}

Parameters:

serviceName - [required] Domain of the service

Throws:

IOException

serviceName_reboot_POST

public OvhTask serviceName_reboot_POST(String serviceName)
                                throws IOException

Reboot the Operating system of the Cloud Desktop. REST: POST /deskaas/{serviceName}/reboot

Parameters:

serviceName - [required] Domain of the service

Throws:

IOException

serviceName_task_taskId_GET

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

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

Parameters:

serviceName - [required] Domain of the service

taskId - [required] Task id

Throws:

IOException

serviceName_task_GET

public ArrayList<Long> serviceName_task_GET(String serviceName,
                                            OvhTaskStateEnum state)
                                     throws IOException

Tasks associated with this Desktop As A Service REST: GET /deskaas/{serviceName}/task

Parameters:

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

serviceName - [required] Domain of the service

Throws:

IOException

GET

public ArrayList<String> GET()
                      throws IOException

List available services REST: GET /deskaas

Throws:

IOException