connector_offsets_requests
Creates, updates, deletes, gets or lists a connector_offsets_requests resource.
Overview
| Name | connector_offsets_requests |
| Type | Resource |
| Id | confluent.connect.connector_offsets_requests |
Fields
The following fields are returned by SELECT queries:
- get_connectv1_connector_offsets_request_status
Connector Offsets Request Status.
| Name | Datatype | Description |
|---|---|---|
applied_at | string (date-time) | The time at which the offsets were applied. The time is in UTC, ISO 8601 format. (example: 2024-02-20T15:14:19.000Z) |
previous_offsets | array | Array of offsets which are categorised into partitions. |
request | object | The request made to alter offsets. |
status | object | The response of the alter offsets operation. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get_connectv1_connector_offsets_request_status | select | connector_name, environment_id, kafka_cluster_id | Get the status of the previous alter offset request. | |
alter_connectv1_connector_offsets_request | exec | connector_name, environment_id, kafka_cluster_id, type | Request to alter the offsets of a connector. This supports the ability to PATCH/DELETE the offsets of a connector. Note, you will see momentary downtime as this will internally stop the connector, while the offsets are being altered. You can only make one alter offsets request at a time for a connector. |
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 |
|---|---|---|
connector_name | string | The unique name of the connector. |
environment_id | string | The unique identifier of the environment this resource belongs to. |
kafka_cluster_id | string | The unique identifier for the Kafka cluster. |
SELECT examples
- get_connectv1_connector_offsets_request_status
Get the status of the previous alter offset request.
SELECT
applied_at,
previous_offsets,
request,
status
FROM confluent.connect.connector_offsets_requests
WHERE connector_name = '{{ connector_name }}' -- required
AND environment_id = '{{ environment_id }}' -- required
AND kafka_cluster_id = '{{ kafka_cluster_id }}' -- required
;
Lifecycle Methods
- alter_connectv1_connector_offsets_request
Request to alter the offsets of a connector. This supports the ability to PATCH/DELETE the offsets of a connector.
Note, you will see momentary downtime as this will internally stop the connector, while the offsets are being altered.
You can only make one alter offsets request at a time for a connector.
EXEC confluent.connect.connector_offsets_requests.alter_connectv1_connector_offsets_request
@connector_name='{{ connector_name }}' --required,
@environment_id='{{ environment_id }}' --required,
@kafka_cluster_id='{{ kafka_cluster_id }}' --required
@@json=
'{
"type": "{{ type }}",
"offsets": "{{ offsets }}"
}'
;