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

The following fields are returned by SELECT queries:

get_connect_v1_custom_connector_plugin

Custom Connector Plugin.

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"). (example: dlz-f3a90de)
display_name	string	Display name of Custom Connector Plugin.
api_version	string	APIVersion defines the schema version of this representation of a resource. (connect/v1)
cloud	string	Cloud provider where the Custom Connector Plugin archive is uploaded. (example: AWS, default: AWS)
connector_class	string	Java class or alias for connector. You can get connector class from connector documentation provided by developer. (pattern: ^(([a-zA-Z][a-zA-Z_$0-9](.[a-zA-Z][a-zA-Z_$0-9])).)?([a-zA-Z][a-zA-Z_$0-9])$, example: io.confluent.kafka.connect.datagen.DatagenConnector)
connector_type	string	Custom Connector type. (example: SOURCE)
content_format	string	Archive format of Custom Connector Plugin. (example: ZIP)
description	string	Description of Custom Connector Plugin.
documentation_link	string	Document link of Custom Connector Plugin. (pattern: ^$|^(http://|https://).+, example: https://github.com/confluentinc/kafka-connect-datagen)
kind	string	Kind defines the object this REST resource represents. (CustomConnectorPlugin)
metadata	object	ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
runtime_language	string	Runtime language of Custom Connector Plugin. (example: JAVA, default: JAVA)
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	Upload source of Custom Connector Plugin. Only required in create request, will be ignored in read, update or list.

list_connect_v1_custom_connector_plugins

Custom Connector Plugin.

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"). (example: dlz-f3a90de)
display_name	string	Display name of Custom Connector Plugin.
api_version	string	APIVersion defines the schema version of this representation of a resource. (connect/v1)
cloud	string	Cloud provider where the Custom Connector Plugin archive is uploaded. (example: AWS, default: AWS)
connector_class	string	Java class or alias for connector. You can get connector class from connector documentation provided by developer. (pattern: ^(([a-zA-Z][a-zA-Z_$0-9](.[a-zA-Z][a-zA-Z_$0-9])).)?([a-zA-Z][a-zA-Z_$0-9])$, example: io.confluent.kafka.connect.datagen.DatagenConnector)
connector_type	string	Custom Connector type. (example: SOURCE)
content_format	string	Archive format of Custom Connector Plugin. (example: ZIP)
description	string	Description of Custom Connector Plugin.
documentation_link	string	Document link of Custom Connector Plugin. (pattern: ^$|^(http://|https://).+, example: https://github.com/confluentinc/kafka-connect-datagen)
kind	string	Kind defines the object this REST resource represents. (CustomConnectorPlugin)
metadata	object	ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
runtime_language	string	Runtime language of Custom Connector Plugin. (example: JAVA, default: JAVA)
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	Upload source of Custom Connector Plugin. Only required in create request, will be ignored in read, update or list.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_connect_v1_custom_connector_plugin	select	id		Make a request to read a custom connector plugin.
list_connect_v1_custom_connector_plugins	select		cloud, page_size, page_token	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_v1_custom_connector_plugin	insert	display_name, connector_class, connector_type, upload_source		Make a request to create a custom connector plugin.
update_connect_v1_custom_connector_plugin	update	id		Make a request to update a custom connector plugin.
delete_connect_v1_custom_connector_plugin	delete	id		Make a request to delete a custom connector plugin.

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
id	string	The unique identifier for the custom connector plugin.
cloud	string	Filter the results by exact match for cloud. (example: AWS)
page_size	integer	A pagination size for collection requests.
page_token	string	An opaque pagination token for collection requests.

SELECT examples

get_connect_v1_custom_connector_plugin

Make a request to read a custom connector plugin.

SELECT
id,
display_name,
api_version,
cloud,
connector_class,
connector_type,
content_format,
description,
documentation_link,
kind,
metadata,
runtime_language,
sensitive_config_properties,
upload_source
FROM confluent.connect.custom_connector_plugins
WHERE id = '{{ id }}' -- required
;

list_connect_v1_custom_connector_plugins

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,
display_name,
api_version,
cloud,
connector_class,
connector_type,
content_format,
description,
documentation_link,
kind,
metadata,
runtime_language,
sensitive_config_properties,
upload_source
FROM confluent.connect.custom_connector_plugins
WHERE cloud = '{{ cloud }}'
AND page_size = '{{ page_size }}'
AND page_token = '{{ page_token }}'
;

INSERT examples

create_connect_v1_custom_connector_plugin

Make a request to create a custom connector plugin.

INSERT INTO confluent.connect.custom_connector_plugins (
display_name,
description,
documentation_link,
connector_class,
connector_type,
cloud,
sensitive_config_properties,
upload_source,
runtime_language
)
SELECT 
'{{ display_name }}' /* required */,
'{{ description }}',
'{{ documentation_link }}',
'{{ connector_class }}' /* required */,
'{{ connector_type }}' /* required */,
'{{ cloud }}',
'{{ sensitive_config_properties }}',
'{{ upload_source }}' /* required */,
'{{ runtime_language }}'
RETURNING
id,
display_name,
api_version,
cloud,
connector_class,
connector_type,
content_format,
description,
documentation_link,
kind,
metadata,
runtime_language,
sensitive_config_properties,
upload_source
;

Manifest

# Description fields are for documentation purposes
- name: custom_connector_plugins
props:
  - name: display_name
    value: "{{ display_name }}"
    description: |
      Display name of Custom Connector Plugin.
  - name: description
    value: "{{ description }}"
    description: |
      Description of Custom Connector Plugin.
  - name: documentation_link
    value: "{{ documentation_link }}"
    description: |
      Document link of Custom Connector Plugin.
  - name: connector_class
    value: "{{ connector_class }}"
    description: |
      Java class or alias for connector. You can get connector class from connector documentation provided by developer.
  - name: connector_type
    value: "{{ connector_type }}"
    description: |
      Custom Connector type.
  - name: cloud
    value: "{{ cloud }}"
    description: |
      Cloud provider where the Custom Connector Plugin archive is uploaded.
    default: AWS
  - name: sensitive_config_properties
    value:
      - "{{ sensitive_config_properties }}"
    description: |
      A sensitive property is a connector configuration property that must be hidden after a user enters property
      value when setting up connector.
  - name: upload_source
    description: |
      Upload source of Custom Connector Plugin. Only required in `create` request, will be ignored in `read`, `update` or `list`.
    value:
      location: "{{ location }}"
      upload_id: "{{ upload_id }}"
  - name: runtime_language
    value: "{{ runtime_language }}"
    description: |
      Runtime language of Custom Connector Plugin.
    default: JAVA

UPDATE examples

update_connect_v1_custom_connector_plugin

Make a request to update a custom connector plugin.

UPDATE confluent.connect.custom_connector_plugins
SET 
display_name = '{{ display_name }}',
description = '{{ description }}',
documentation_link = '{{ documentation_link }}',
connector_class = '{{ connector_class }}',
connector_type = '{{ connector_type }}',
cloud = '{{ cloud }}',
sensitive_config_properties = '{{ sensitive_config_properties }}',
upload_source = '{{ upload_source }}',
runtime_language = '{{ runtime_language }}'
WHERE 
id = '{{ id }}' --required
RETURNING
id,
display_name,
api_version,
cloud,
connector_class,
connector_type,
content_format,
description,
documentation_link,
kind,
metadata,
runtime_language,
sensitive_config_properties,
upload_source;

DELETE examples

delete_connect_v1_custom_connector_plugin

Make a request to delete a custom connector plugin.

DELETE FROM confluent.connect.custom_connector_plugins
WHERE id = '{{ id }}' --required
;