kafka_connect_capabilities_connectors
Creates, updates, deletes, gets or lists a kafka_connect_capabilities_connectors resource.
Overview​
| Name | kafka_connect_capabilities_connectors |
| Type | Resource |
| Id | ovh.cloud_database.kafka_connect_capabilities_connectors |
Fields​
The following fields are returned by SELECT queries:
- get
- list
successful operation
| Name | Datatype | Description |
|---|---|---|
id | string (uuid) | Connector ID |
name | string | Name of the connector |
author | string | Name of the connector's author |
documentation_url | string | URL of the official documentation of the connector (wire: documentationUrl) |
latest | boolean | Defines whether this connector and version is the latest available |
preview | boolean | Defines whether the connector is in preview |
type | string | Type of connector (sink, source) |
version | string | Version of the connector |
KafkaConnect connector capability definition
| Name | Datatype | Description |
|---|---|---|
id | string (uuid) | Connector ID |
name | string | Name of the connector |
author | string | Name of the connector's author |
documentation_url | string | URL of the official documentation of the connector (wire: documentationUrl) |
latest | boolean | Defines whether this connector and version is the latest available |
preview | boolean | Defines whether the connector is in preview |
type | string | Type of connector (sink, source) |
version | string | Version of the connector |
Methods​
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get | select | cluster_id, connector_id, service_name | Get Kafka Connect connector capability | |
list | select | cluster_id, service_name | x_pagination_mode | List Kafka Connect connectors |
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"}}) |
cluster_id | string (uuid) | Cluster ID (wire: clusterId) |
connector_id | string (uuid) | Connector ID (wire: connectorId) |
service_name | string | The Public Cloud project ID. Resolved from OVH_CLOUD_PROJECT_SERVICE when set. |
x_pagination_mode | string | Sent as CachedObjectList-Pages by default so the list returns the full objects rather than their identifiers. (wire: X-Pagination-Mode) |
SELECT examples​
- get
- list
Get Kafka Connect connector capability
SELECT
id,
name,
author,
documentation_url,
latest,
preview,
type,
version
FROM ovh.cloud_database.kafka_connect_capabilities_connectors
WHERE cluster_id = '{{ cluster_id }}' -- required
AND connector_id = '{{ connector_id }}' -- required
AND service_name = '{{ service_name }}' -- required unless OVH_CLOUD_PROJECT_SERVICE is set
;
List Kafka Connect connectors
SELECT
id,
name,
author,
documentation_url,
latest,
preview,
type,
version
FROM ovh.cloud_database.kafka_connect_capabilities_connectors
WHERE cluster_id = '{{ cluster_id }}' -- required
AND service_name = '{{ service_name }}' -- required unless OVH_CLOUD_PROJECT_SERVICE is set
AND x_pagination_mode = '{{ x_pagination_mode }}'
;