tasks

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

Overview

Name	tasks
Type	Resource
Id	ovh.cluster_hadoop.tasks

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
name	string	Operation name
task_id	integer	(wire: taskId)
status	string	Current Task state (cancelled, doing, done, error, todo)

list

Operation on a Hadoop Cluster component

Name	Datatype	Description
name	string	Operation name
task_id	integer	(wire: taskId)
status	string	Current Task state (cancelled, doing, done, error, todo)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	service_name, task_id		Get this object properties
list	select	service_name	status, x_pagination_mode	Tasks associated with this Hadoop Cluster

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.

Name	Datatype	Description
api_host	string	The 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"}})
service_name	string	The internal name of your cluster (wire: serviceName)
task_id	integer	(wire: taskId)
status	string	Filter the value of status property (=)
x_pagination_mode	string	Sent as CachedObjectList-Pages by default so the list returns the full objects rather than their identifiers. (wire: X-Pagination-Mode)

SELECT examples

get

Get this object properties

SELECT
name,
task_id,
status
FROM ovh.cluster_hadoop.tasks
WHERE service_name = '{{ service_name }}' -- required
AND task_id = '{{ task_id }}' -- required
;

list

Tasks associated with this Hadoop Cluster

SELECT
name,
task_id,
status
FROM ovh.cluster_hadoop.tasks
WHERE service_name = '{{ service_name }}' -- required
AND status = '{{ status }}'
AND x_pagination_mode = '{{ x_pagination_mode }}'
;