custom_connect_plugin_versions

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

Overview

Name	custom_connect_plugin_versions
Type	Resource
Id	confluent.ccpm.custom_connect_plugin_versions

Fields

The following fields are returned by SELECT queries:

get_ccpm_v1_custom_connect_plugin_version

Custom Connect Plugin Version.

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)
api_version	string	APIVersion defines the schema version of this representation of a resource. (ccpm/v1)
kind	string	Kind defines the object this REST resource represents. (CustomConnectPluginVersion)
metadata	object	ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
spec	object	The desired state of the Custom Connect Plugin Version
status	object	The status of the Custom Connect Plugin Version

list_ccpm_v1_custom_connect_plugin_versions

Custom Connect Plugin Version.

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)
api_version	string	APIVersion defines the schema version of this representation of a resource. (ccpm/v1)
kind	string	Kind defines the object this REST resource represents. (CustomConnectPluginVersion)
metadata	object	ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
spec	object	The desired state of the Custom Connect Plugin Version
status	object	The status of the Custom Connect Plugin Version

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_ccpm_v1_custom_connect_plugin_version	select	environment, plugin_id, id		Make a request to read a custom connect plugin version.
list_ccpm_v1_custom_connect_plugin_versions	select	environment, plugin_id		Retrieve a sorted, filtered, paginated list of all custom connect plugin versions.
create_ccpm_v1_custom_connect_plugin_version	insert	plugin_id, spec		Make a request to create a custom connect plugin version.
delete_ccpm_v1_custom_connect_plugin_version	delete	environment, plugin_id, id		Make a request to delete a custom connect plugin version.

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	string	Scope the operation to the given environment. (example: env-00000)
id	string	The unique identifier for the custom connect plugin version.
plugin_id	string	The Plugin

SELECT examples

get_ccpm_v1_custom_connect_plugin_version

Make a request to read a custom connect plugin version.

SELECT
id,
api_version,
kind,
metadata,
spec,
status
FROM confluent.ccpm.custom_connect_plugin_versions
WHERE environment = '{{ environment }}' -- required
AND plugin_id = '{{ plugin_id }}' -- required
AND id = '{{ id }}' -- required
;

list_ccpm_v1_custom_connect_plugin_versions

Retrieve a sorted, filtered, paginated list of all custom connect plugin versions.

SELECT
id,
api_version,
kind,
metadata,
spec,
status
FROM confluent.ccpm.custom_connect_plugin_versions
WHERE environment = '{{ environment }}' -- required
AND plugin_id = '{{ plugin_id }}' -- required
;

INSERT examples

create_ccpm_v1_custom_connect_plugin_version

Make a request to create a custom connect plugin version.

INSERT INTO confluent.ccpm.custom_connect_plugin_versions (
spec,
plugin_id
)
SELECT 
'{{ spec }}' /* required */,
'{{ plugin_id }}'
RETURNING
id,
api_version,
kind,
metadata,
spec,
status
;

Manifest

# Description fields are for documentation purposes
- name: custom_connect_plugin_versions
props:
  - name: plugin_id
    value: "{{ plugin_id }}"
    description: Required parameter for the custom_connect_plugin_versions resource.
  - name: spec
    description: |
      The desired state of the Custom Connect Plugin Version
    value:
      version: "{{ version }}"
      sensitive_config_properties:
        - "{{ sensitive_config_properties }}"
      documentation_link: "{{ documentation_link }}"
      content_format: "{{ content_format }}"
      connector_classes:
        - class_name: "{{ class_name }}"
          type: "{{ type }}"
      upload_source:
        location: "{{ location }}"
        upload_id: "{{ upload_id }}"
      environment:
        id: "{{ id }}"
        environment: "{{ environment }}"
        related: "{{ related }}"
        resource_name: "{{ resource_name }}"

DELETE examples

delete_ccpm_v1_custom_connect_plugin_version

Make a request to delete a custom connect plugin version.

DELETE FROM confluent.ccpm.custom_connect_plugin_versions
WHERE environment = '{{ environment }}' --required
AND plugin_id = '{{ plugin_id }}' --required
AND id = '{{ id }}' --required
;