Skip to main content

task_domain_progressbars

Creates, updates, deletes, gets or lists a task_domain_progressbars resource.

Overview​

Nametask_domain_progressbars
TypeResource
Idovh.me.task_domain_progressbars

Fields​

The following fields are returned by SELECT queries:

successful operation

NameDatatypeDescription
current_stepobjectCurrent step of the operation (wire: currentStep)
expected_done_datestring (date-time)The estimated end date of the task (wire: expectedDoneDate)
follow_up_stepsarrayAll the steps of the operation (wire: followUpSteps)
last_update_datestring (date-time)The last update date of the task (wire: lastUpdateDate)
progressintegerProgress percentage of the task
task_actionsarrayAction possible on task (wire: taskActions)
task_statusstringThe status of the task (cancelled, doing, done, error, problem, todo) (wire: taskStatus)

Methods​

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
getselectidShow progress of a task

Parameters​

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

NameDatatypeDescription
api_hoststringThe OVHcloud API host. Selected by OVH_ENDPOINT (ovh-eu, ovh-ca or ovh-us; default ovh-eu). (default: api.eu.ovhcloud.com, x-stackQL-envVarSelector: {"envVar":"OVH_ENDPOINT","default":"ovh-eu","values":{"ovh-eu":"api.eu.ovhcloud.com","ovh-ca":"api.ca.ovhcloud.com","ovh-us":"api.us.ovhcloud.com"}})
idintegerId

SELECT examples​

Show progress of a task

SELECT
current_step,
expected_done_date,
follow_up_steps,
last_update_date,
progress,
task_actions,
task_status
FROM ovh.me.task_domain_progressbars
WHERE id = '{{ id }}' -- required
;