net.minidev.ovh.api

Class ApiOvhLicenseworklight

java.lang.Object

net.minidev.ovh.core.ApiOvhBase

net.minidev.ovh.api.ApiOvhLicenseworklight

public class ApiOvhLicenseworklight
extends ApiOvhBase

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

Field Summary

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

core

Constructor Summary

Constructors

Constructor and Description
ApiOvhLicenseworklight(ApiOvhCore core)

Method Summary

Modifier and Type	Method and Description
ArrayList<String>	GET() List available services REST: GET /license/worklight
ArrayList<OvhWorkLightOrderConfiguration>	orderableVersions_GET(String ip) Get the orderable WorkLight versions REST: GET /license/worklight/orderableVersions
ArrayList<String>	serviceName_allowedDestinationIp_GET(String serviceName) Returns an array of ips where the license can be moved to REST: GET /license/worklight/{serviceName}/allowedDestinationIp
OvhChangeIpStatus	serviceName_canLicenseBeMovedTo_GET(String serviceName, String destinationIp) Will tell if the ip can accept the license REST: GET /license/worklight/{serviceName}/canLicenseBeMovedTo
OvhTask	serviceName_changeIp_POST(String serviceName, String destinationIp) Move this license to another Ip REST: POST /license/worklight/{serviceName}/changeIp
String	serviceName_confirmTermination_POST(String serviceName, String commentary, OvhTerminationFutureUseEnum futureUse, OvhTerminationReasonEnum reason, String token) Confirm termination of your service REST: POST /license/worklight/{serviceName}/confirmTermination
OvhWorkLight	serviceName_GET(String serviceName) Get this object properties REST: GET /license/worklight/{serviceName}
void	serviceName_PUT(String serviceName, OvhWorkLight body) Alter this object properties REST: PUT /license/worklight/{serviceName}
OvhService	serviceName_serviceInfos_GET(String serviceName) Get this object properties REST: GET /license/worklight/{serviceName}/serviceInfos
void	serviceName_serviceInfos_PUT(String serviceName, OvhService body) Alter this object properties REST: PUT /license/worklight/{serviceName}/serviceInfos
ArrayList<Long>	serviceName_tasks_GET(String serviceName, OvhActionType action, OvhTaskStateEnum status) Tasks linked to this license REST: GET /license/worklight/{serviceName}/tasks
OvhTask	serviceName_tasks_taskId_GET(String serviceName, Long taskId) Get this object properties REST: GET /license/worklight/{serviceName}/tasks/{taskId}
String	serviceName_terminate_POST(String serviceName) Terminate your service REST: POST /license/worklight/{serviceName}/terminate

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

ApiOvhLicenseworklight

public ApiOvhLicenseworklight(ApiOvhCore core)

Method Detail

GET

public ArrayList<String> GET()
                      throws IOException

List available services REST: GET /license/worklight

Throws:

IOException

orderableVersions_GET

public ArrayList<OvhWorkLightOrderConfiguration> orderableVersions_GET(String ip)
                                                                throws IOException

Get the orderable WorkLight versions REST: GET /license/worklight/orderableVersions

Parameters:

ip - [required] Your license Ip

Throws:

IOException

serviceName_canLicenseBeMovedTo_GET

public OvhChangeIpStatus serviceName_canLicenseBeMovedTo_GET(String serviceName,
                                                             String destinationIp)
                                                      throws IOException

Will tell if the ip can accept the license REST: GET /license/worklight/{serviceName}/canLicenseBeMovedTo

Parameters:

destinationIp - [required] The Ip on which you want to move this license

serviceName - [required] The name of your WorkLight license

Throws:

IOException

serviceName_GET

public OvhWorkLight serviceName_GET(String serviceName)
                             throws IOException

Get this object properties REST: GET /license/worklight/{serviceName}

Parameters:

serviceName - [required] The name of your WorkLight license

Throws:

IOException

serviceName_PUT

public void serviceName_PUT(String serviceName,
                            OvhWorkLight body)
                     throws IOException

Alter this object properties REST: PUT /license/worklight/{serviceName}

Parameters:

body - [required] New object properties

serviceName - [required] The name of your WorkLight license

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 /license/worklight/{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] The name of your WorkLight license

Throws:

IOException

serviceName_terminate_POST

public String serviceName_terminate_POST(String serviceName)
                                  throws IOException

Terminate your service REST: POST /license/worklight/{serviceName}/terminate

Parameters:

serviceName - [required] The name of your WorkLight license

Throws:

IOException

serviceName_serviceInfos_GET

public OvhService serviceName_serviceInfos_GET(String serviceName)
                                        throws IOException

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

Parameters:

serviceName - [required] The name of your WorkLight license

Throws:

IOException

serviceName_serviceInfos_PUT

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

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

Parameters:

body - [required] New object properties

serviceName - [required] The name of your WorkLight license

Throws:

IOException

serviceName_changeIp_POST

public OvhTask serviceName_changeIp_POST(String serviceName,
                                         String destinationIp)
                                  throws IOException

Move this license to another Ip REST: POST /license/worklight/{serviceName}/changeIp

Parameters:

destinationIp - [required] The Ip on which you want to move this license

serviceName - [required] The name of your WorkLight license

Throws:

IOException

serviceName_tasks_GET

public ArrayList<Long> serviceName_tasks_GET(String serviceName,
                                             OvhActionType action,
                                             OvhTaskStateEnum status)
                                      throws IOException

Tasks linked to this license REST: GET /license/worklight/{serviceName}/tasks

Parameters:

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

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

serviceName - [required] The name of your WorkLight license

Throws:

IOException

serviceName_tasks_taskId_GET

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

Get this object properties REST: GET /license/worklight/{serviceName}/tasks/{taskId}

Parameters:

serviceName - [required] The name of your WorkLight license

taskId - [required] This Task id

Throws:

IOException

serviceName_allowedDestinationIp_GET

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

Returns an array of ips where the license can be moved to REST: GET /license/worklight/{serviceName}/allowedDestinationIp

Parameters:

serviceName - [required] The name of your WorkLight license

Throws:

IOException