managed_connector_plugins
Creates, updates, deletes, gets or lists a managed_connector_plugins resource.
Overview
| Name | managed_connector_plugins |
| Type | Resource |
| Id | confluent.connect.managed_connector_plugins |
Fields
The following fields are returned by SELECT queries:
- list_connectv1_connector_plugins
Connector Plugin.
| Name | Datatype | Description |
|---|---|---|
class | string | The connector class name. E.g. BigQuerySink. |
type | string | Type of connector, sink or source. (sink, source) |
version | string | The version string for the connector available. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
list_connectv1_connector_plugins | select | environment_id, kafka_cluster_id | Return a list of Managed Connector plugins installed in the Kafka Connect cluster. | |
validate_connectv1_connector_plugin | exec | plugin_name, environment_id, kafka_cluster_id | Validate 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_plugin | exec | plugin_name, environment_id, kafka_cluster_id | mask_sensitive | Translate 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.
| Name | Datatype | Description |
|---|---|---|
environment_id | string | The unique identifier of the environment this resource belongs to. |
kafka_cluster_id | string | The unique identifier for the Kafka cluster. |
plugin_name | string | The unique name of the connector plugin. |
mask_sensitive | string | Indicates whether to redact sensitive config values in response. |
SELECT examples
- list_connectv1_connector_plugins
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_connectv1_connector_plugin
- translate_connectv1_connector_plugin
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
;
Translate 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.
EXEC confluent.connect.managed_connector_plugins.translate_connectv1_connector_plugin
@plugin_name='{{ plugin_name }}' --required,
@environment_id='{{ environment_id }}' --required,
@kafka_cluster_id='{{ kafka_cluster_id }}' --required,
@mask_sensitive='{{ mask_sensitive }}'
;