kafka_connect_connectors

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

Overview

Name	kafka_connect_connectors
Type	Resource
Id	ovh.public_cloud_analytics.kafka_connect_connectors

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
id	string (uuid)	Unique identifier of the connector
name	string	Name of the connector
connector_capability_id	string (uuid)	Identifier of the connector type from capabilities (wire: connectorCapabilityId)
checksum	string	Hash of the resource used for concurrency control
configuration	object	Connector configuration key-value pairs
created_at	string (date-time)	Date at which the resource was created (wire: createdAt)
status	string	Current status of the connector (CREATING, FAILED, PAUSED, RUNNING, UNASSIGNED)
updated_at	string (date-time)	Date of the last update to the resource (wire: updatedAt)

list

A connector on a managed Kafka Connect service

Name	Datatype	Description
id	string (uuid)	Unique identifier of the connector
name	string	Name of the connector
connector_capability_id	string (uuid)	Identifier of the connector type from capabilities (wire: connectorCapabilityId)
checksum	string	Hash of the resource used for concurrency control
configuration	object	Connector configuration key-value pairs
created_at	string (date-time)	Date at which the resource was created (wire: createdAt)
status	string	Current status of the connector (CREATING, FAILED, PAUSED, RUNNING, UNASSIGNED)
updated_at	string (date-time)	Date of the last update to the resource (wire: updatedAt)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	connector_id, service_id, project_id		Returns the connector type, its configuration and its status. (Beta version)
list	select	service_id, project_id	x_pagination_cursor, x_pagination_size	Returns the connectors of the service with their status. (Beta version)
create	insert	service_id, project_id, configuration, connector_capability_id, name		Creates a connector of a type listed in the capabilities, with its configuration key-value pairs. (Beta version)
update	update	connector_id, service_id, project_id, action		Pauses, resumes or restarts the connector, depending on the requested action. (Beta version)
delete	delete	connector_id, service_id, project_id		Deletes the connector. (Beta version)
replace	exec	connectorId, serviceId, project_id, configuration		Updates the configuration of the connector. Keys omitted from the request are removed. (Beta 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
api_host	string	The OVHcloud API host. Selected by OVH_ENDPOINT (ovh-eu, ovh-ca or ovh-us; default ovh-eu). (default: api.eu.ovhcloud.com, x-stackQL-envVarSelector: {"envVar":"OVH_ENDPOINT","default":"ovh-eu","values":{"ovh-eu":"api.eu.ovhcloud.com","ovh-ca":"api.ca.ovhcloud.com","ovh-us":"api.us.ovhcloud.com"}})
connectorId	string (uuid)	Connector ID
connector_id	string (uuid)	Connector ID (wire: connectorId)
project_id	string	The Public Cloud project ID. Resolved from OVH_CLOUD_PROJECT_SERVICE when set.
serviceId	string (uuid)	Service ID
service_id	string (uuid)	Service ID (wire: serviceId)
x_pagination_cursor	string	Pagination cursor (wire: X-Pagination-Cursor)
x_pagination_size	integer	Pagination size (wire: X-Pagination-Size)

SELECT examples

get

Returns the connector type, its configuration and its status. (Beta version)

SELECT
id,
name,
connector_capability_id,
checksum,
configuration,
created_at,
status,
updated_at
FROM ovh.public_cloud_analytics.kafka_connect_connectors
WHERE connector_id = '{{ connector_id }}' -- required
AND service_id = '{{ service_id }}' -- required
AND project_id = '{{ project_id }}' -- required unless OVH_CLOUD_PROJECT_SERVICE is set
;

list

Returns the connectors of the service with their status. (Beta version)

SELECT
id,
name,
connector_capability_id,
checksum,
configuration,
created_at,
status,
updated_at
FROM ovh.public_cloud_analytics.kafka_connect_connectors
WHERE service_id = '{{ service_id }}' -- required
AND project_id = '{{ project_id }}' -- required unless OVH_CLOUD_PROJECT_SERVICE is set
AND x_pagination_cursor = '{{ x_pagination_cursor }}'
AND x_pagination_size = '{{ x_pagination_size }}'
;

INSERT examples

create

Creates a connector of a type listed in the capabilities, with its configuration key-value pairs. (Beta version)

INSERT INTO ovh.public_cloud_analytics.kafka_connect_connectors (
configuration,
connector_capability_id,
name,
service_id,
project_id
)
SELECT 
'{{ configuration }}' /* required */,
'{{ connector_capability_id }}' /* required */,
'{{ name }}' /* required */,
'{{ service_id }}',
'{{ project_id }}'
RETURNING
id,
name,
connector_capability_id,
checksum,
configuration,
created_at,
status,
updated_at
;

Manifest

# Description fields are for documentation purposes
- name: kafka_connect_connectors
props:
  - name: service_id
    value: "{{ service_id }}"
    description: Required parameter for the kafka_connect_connectors resource.
  - name: project_id
    value: "{{ project_id }}"
    description: Required parameter for the kafka_connect_connectors resource.
  - name: configuration
    value: "{{ configuration }}"
    description: |
      Connector configuration key-value pairs
  - name: connector_capability_id
    value: "{{ connector_capability_id }}"
    description: |
      Identifier of the connector type from capabilities
  - name: name
    value: "{{ name }}"
    description: |
      Name of the connector

UPDATE examples

update

Pauses, resumes or restarts the connector, depending on the requested action. (Beta version)

UPDATE ovh.public_cloud_analytics.kafka_connect_connectors
SET 
action = '{{ action }}'
WHERE 
connector_id = '{{ connector_id }}' --required
AND service_id = '{{ service_id }}' --required
AND project_id = '{{ project_id }}' --required unless OVH_CLOUD_PROJECT_SERVICE is set
AND action = '{{ action }}' --required
RETURNING
id,
name,
connector_capability_id,
checksum,
configuration,
created_at,
status,
updated_at;

DELETE examples

delete

Deletes the connector. (Beta version)

DELETE FROM ovh.public_cloud_analytics.kafka_connect_connectors
WHERE connector_id = '{{ connector_id }}' --required
AND service_id = '{{ service_id }}' --required
AND project_id = '{{ project_id }}' --required unless OVH_CLOUD_PROJECT_SERVICE is set
;

Lifecycle Methods

EXEC variables use wire (API) names.

replace

Updates the configuration of the connector. Keys omitted from the request are removed. (Beta version)

EXEC ovh.public_cloud_analytics.kafka_connect_connectors.replace 
@connectorId='{{ connectorId }}' --required, 
@serviceId='{{ serviceId }}' --required, 
@project_id='{{ project_id }}' --required unless OVH_CLOUD_PROJECT_SERVICE is set 
@@json=
'{
"configuration": "{{ configuration }}"
}'
;