Skip to main content

managed_connector_plugins

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

Overview​

Namemanaged_connector_plugins
TypeResource
Idconfluent.connect.managed_connector_plugins

Fields​

The following fields are returned by SELECT queries:

Connector Plugin.

NameDatatypeDescription
classstringThe connector class name. E.g. BigQuerySink.
typestringType of connector, sink or source. (sink, source)
versionstringThe version string for the connector available.

Methods​

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
list_connectv1_connector_pluginsselectenvironment_id, kafka_cluster_idReturn a list of Managed Connector plugins installed in the Kafka Connect cluster.
validate_connectv1_connector_pluginexecplugin_name, environment_id, kafka_cluster_idValidate the provided configuration values against the configuration definition. This API performs per config validation and returns suggested values and validation error messages.
translate_connectv1_connector_pluginexecplugin_name, environment_id, kafka_cluster_idmask_sensitiveTranslate the provided Self Managed configuration values. This API performs configuration translation
and returns the translated fully managed configuration along with any errors or warnings.
Query Parameter mask_sensitive=true redacts sensitive config values in response.

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
environment_idstringThe unique identifier of the environment this resource belongs to.
kafka_cluster_idstringThe unique identifier for the Kafka cluster.
plugin_namestringThe unique name of the connector plugin.
mask_sensitivestringIndicates whether to redact sensitive config values in response.

SELECT examples​

Return a list of Managed Connector plugins installed in the Kafka Connect cluster.

SELECT
class,
type,
version
FROM confluent.connect.managed_connector_plugins
WHERE environment_id = '{{ environment_id }}' -- required
AND kafka_cluster_id = '{{ kafka_cluster_id }}' -- required
;

Lifecycle Methods​

Validate the provided configuration values against the configuration definition. This API performs per config validation and returns suggested values and validation error messages.

EXEC confluent.connect.managed_connector_plugins.validate_connectv1_connector_plugin
@plugin_name='{{ plugin_name }}' --required,
@environment_id='{{ environment_id }}' --required,
@kafka_cluster_id='{{ kafka_cluster_id }}' --required
;