custom_connector_plugins

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

Overview

Name	custom_connector_plugins
Type	Resource
Id	confluent.connect.custom_connector_plugins

Fields

Name	Datatype	Description
id	string	ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object kinds or objects of the same kind within a different scope/namespace ("space").
description	string	Description of Custom Connector Plugin.
api_version	string	APIVersion defines the schema version of this representation of a resource.
cloud	string	Cloud provider where the Custom Connector Plugin archive is uploaded.
connector_class	string	Java class or alias for connector. You can get connector class from connector documentation provided by developer.
connector_type	string	Custom Connector type.
content_format	string	Archive format of Custom Connector Plugin.
display_name	string	Display name of Custom Connector Plugin.
documentation_link	string	Document link of Custom Connector Plugin.
kind	string	Kind defines the object this REST resource represents.
metadata	``	ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
sensitive_config_properties	array	A sensitive property is a connector configuration property that must be hidden after a user enters property value when setting up connector.
upload_source	object	[immutable] Upload source of Custom Connector Plugin. Only required in create request, will be ignored in read, update or list.

Methods

Name	Accessible by	Required Params	Description
get_connect_v1custom_connector_plugin	SELECT	id	Make a request to read a custom connector plugin.
list_connect_v1custom_connector_plugins	SELECT		Retrieve a sorted, filtered, paginated list of all custom connector plugins. If no cloud filter is specified, returns custom connector plugins from all clouds.
create_connect_v1custom_connector_plugin	INSERT		Make a request to create a custom connector plugin.
delete_connect_v1custom_connector_plugin	DELETE	id	Make a request to delete a custom connector plugin.
update_connect_v1custom_connector_plugin	UPDATE	id	Make a request to update a custom connector plugin.

SELECT examples

Retrieve a sorted, filtered, paginated list of all custom connector plugins. If no cloud filter is specified, returns custom connector plugins from all clouds.

SELECT
id,
description,
api_version,
cloud,
connector_class,
connector_type,
content_format,
display_name,
documentation_link,
kind,
metadata,
sensitive_config_properties,
upload_source
FROM confluent.connect.custom_connector_plugins
;

INSERT example

Use the following StackQL query and manifest file to create a new custom_connector_plugins resource.

Required Properties

/*+ create */
INSERT INTO confluent.connect.custom_connector_plugins (
data__display_name,
data__description,
data__documentation_link,
data__connector_class,
data__connector_type,
data__cloud,
data__sensitive_config_properties,
data__upload_source
)
SELECT 
'{{ display_name }}',
'{{ description }}',
'{{ documentation_link }}',
'{{ connector_class }}',
'{{ connector_type }}',
'{{ cloud }}',
'{{ sensitive_config_properties }}',
'{{ upload_source }}'
;

All Properties

/*+ create */
INSERT INTO confluent.connect.custom_connector_plugins (
data__display_name,
data__connector_class,
data__connector_type,
data__upload_source
)
SELECT 
'{{ display_name }}',
'{{ connector_class }}',
'{{ connector_type }}',
'{{ upload_source }}'
;

Manifest

- name: custom_connector_plugins
  props:
    - name: display_name
      value: string
    - name: description
      value: string
    - name: documentation_link
      value: string
    - name: connector_class
      value: string
    - name: connector_type
      value: string
    - name: cloud
      value: string
    - name: sensitive_config_properties
      value: array
    - name: upload_source
      props:
        - name: location
          value: string
        - name: upload_id
          value: string

UPDATE example

Updates a custom_connector_plugins resource.

/*+ update */
UPDATE confluent.connect.custom_connector_plugins
SET 
display_name = '{{ display_name }}',
description = '{{ description }}',
documentation_link = '{{ documentation_link }}',
sensitive_config_properties = '{{ sensitive_config_properties }}',
upload_source = '{{ upload_source }}'
WHERE 
id = '{{ id }}';

DELETE example

Deletes the specified custom_connector_plugins resource.

/*+ delete */
DELETE FROM confluent.connect.custom_connector_plugins
WHERE id = '{{ id }}';