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.cloud_database.kafka_connect_connector_tasks

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
id	integer	Task ID
status	string	Status of the task (FAILED, PAUSED, RUNNING)
trace	string	Trace of the task

list

KafkaConnect connector definition

Name	Datatype	Description
id	integer	Task ID
status	string	Status of the task (FAILED, PAUSED, RUNNING)
trace	string	Trace of the task

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	cluster_id, connector_id, task_id, service_name		Get connector task
list	select	cluster_id, connector_id, service_name	x_pagination_mode	List the connector tasks
restart	exec	clusterId, connectorId, taskId, service_name		Restart the kafka connector task execution

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"}})
clusterId	string (uuid)	Cluster ID
cluster_id	string (uuid)	Cluster ID (wire: clusterId)
connectorId	string (uuid)	Connector ID
connector_id	string (uuid)	Connector ID (wire: connectorId)
service_name	string	The Public Cloud project ID. Resolved from OVH_CLOUD_PROJECT_SERVICE when set.
taskId	integer	Task ID
task_id	integer	Task ID (wire: taskId)
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 connector task

SELECT
id,
status,
trace
FROM ovh.cloud_database.kafka_connect_connector_tasks
WHERE cluster_id = '{{ cluster_id }}' -- required
AND connector_id = '{{ connector_id }}' -- required
AND task_id = '{{ task_id }}' -- required
AND service_name = '{{ service_name }}' -- required unless OVH_CLOUD_PROJECT_SERVICE is set
;

list

List the connector tasks

SELECT
id,
status,
trace
FROM ovh.cloud_database.kafka_connect_connector_tasks
WHERE cluster_id = '{{ cluster_id }}' -- required
AND connector_id = '{{ connector_id }}' -- required
AND service_name = '{{ service_name }}' -- required unless OVH_CLOUD_PROJECT_SERVICE is set
AND x_pagination_mode = '{{ x_pagination_mode }}'
;

Lifecycle Methods

EXEC variables use wire (API) names.

restart

Restart the kafka connector task execution

EXEC ovh.cloud_database.kafka_connect_connector_tasks.restart 
@clusterId='{{ clusterId }}' --required, 
@connectorId='{{ connectorId }}' --required, 
@taskId='{{ taskId }}' --required, 
@service_name='{{ service_name }}' --required unless OVH_CLOUD_PROJECT_SERVICE is set
;