Skip to main content

connector_tasks

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

Overview

Nameconnector_tasks
TypeResource
Idconfluent.connect.connector_tasks

Fields

The following fields are returned by SELECT queries:

Connector Task.

NameDatatypeDescription
idobjectThe ID of task.
configobjectConfiguration parameters for the connector. These configurations are the minimum set of key-value pairs (KVP) which can be used to define how the connector connects Kafka to the external system. Some of these KVPs are common to all the connectors, such as connection parameters to Kafka, connector metadata, etc. The list of common connector configurations is as follows - cloud.environment - cloud.provider - connector.class - kafka.api.key - kafka.api.secret - kafka.endpoint - kafka.region - name A specific connector such as GcsSink would have additional parameters such as gcs.bucket.name, flush.size, etc.

Methods

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
list_connectv1_connector_tasksselectconnector_name, environment_id, kafka_cluster_idGet a list of tasks currently running for the connector.

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
connector_namestringThe unique name of the connector.
environment_idstringThe unique identifier of the environment this resource belongs to.
kafka_cluster_idstringThe unique identifier for the Kafka cluster.

SELECT examples

Get a list of tasks currently running for the connector.

SELECT
id,
config
FROM confluent.connect.connector_tasks
WHERE connector_name = '{{ connector_name }}' -- required
AND environment_id = '{{ environment_id }}' -- required
AND kafka_cluster_id = '{{ kafka_cluster_id }}' -- required
;