kafka_connect_connector_tasks

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

Overview

Name	kafka_connect_connector_tasks
Type	Resource
Id	ovh.public_cloud_analytics.kafka_connect_connector_tasks

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
id	integer	Identifier of the task within the connector
checksum	string	Hash of the resource used for concurrency control
created_at	string (date-time)	Date at which the resource was created (wire: createdAt)
status	string	Current status of the task (FAILED, PAUSED, RUNNING)
trace	string	Error trace if the task is in error state
updated_at	string (date-time)	Date of the last update to the resource (wire: updatedAt)

list

A task running within a Kafka Connect connector

Name	Datatype	Description
id	integer	Identifier of the task within the connector
checksum	string	Hash of the resource used for concurrency control
created_at	string (date-time)	Date at which the resource was created (wire: createdAt)
status	string	Current status of the task (FAILED, PAUSED, RUNNING)
trace	string	Error trace if the task is in error state
updated_at	string (date-time)	Date of the last update to the resource (wire: updatedAt)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	connector_id, service_id, task_id, project_id		Returns the status of the task and, when it failed, its error trace. (Beta version)
list	select	connector_id, service_id, project_id	x_pagination_cursor, x_pagination_size	Returns the tasks of the connector with their status. (Beta version)
restart	exec	connectorId, serviceId, taskId, project_id		Restarts the task and returns it with its new status. (Beta version)

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"}})
connectorId	string (uuid)	Connector ID
connector_id	string (uuid)	Connector ID (wire: connectorId)
project_id	string	The Public Cloud project ID. Resolved from OVH_CLOUD_PROJECT_SERVICE when set.
serviceId	string (uuid)	Service ID
service_id	string (uuid)	Service ID (wire: serviceId)
taskId	integer	Task ID
task_id	integer	Task ID (wire: taskId)
x_pagination_cursor	string	Pagination cursor (wire: X-Pagination-Cursor)
x_pagination_size	integer	Pagination size (wire: X-Pagination-Size)

SELECT examples

get

Returns the status of the task and, when it failed, its error trace. (Beta version)

SELECT
id,
checksum,
created_at,
status,
trace,
updated_at
FROM ovh.public_cloud_analytics.kafka_connect_connector_tasks
WHERE connector_id = '{{ connector_id }}' -- required
AND service_id = '{{ service_id }}' -- required
AND task_id = '{{ task_id }}' -- required
AND project_id = '{{ project_id }}' -- required unless OVH_CLOUD_PROJECT_SERVICE is set
;

list

Returns the tasks of the connector with their status. (Beta version)

SELECT
id,
checksum,
created_at,
status,
trace,
updated_at
FROM ovh.public_cloud_analytics.kafka_connect_connector_tasks
WHERE connector_id = '{{ connector_id }}' -- required
AND service_id = '{{ service_id }}' -- required
AND project_id = '{{ project_id }}' -- required unless OVH_CLOUD_PROJECT_SERVICE is set
AND x_pagination_cursor = '{{ x_pagination_cursor }}'
AND x_pagination_size = '{{ x_pagination_size }}'
;

Lifecycle Methods

EXEC variables use wire (API) names.

restart

Restarts the task and returns it with its new status. (Beta version)

EXEC ovh.public_cloud_analytics.kafka_connect_connector_tasks.restart 
@connectorId='{{ connectorId }}' --required, 
@serviceId='{{ serviceId }}' --required, 
@taskId='{{ taskId }}' --required, 
@project_id='{{ project_id }}' --required unless OVH_CLOUD_PROJECT_SERVICE is set
;