diff --git a/README.md b/README.md index 2ccacf1..9085518 100644 --- a/README.md +++ b/README.md @@ -324,10 +324,6 @@ d. Fix broken links in the generated pages. The Confluent OpenAPI spec embeds anchors (e.g. `#section/Versioning/API-Lifecycle-Policy`, `#operation/readConnectv1Connector`) and a few regex fragments inside `` blocks (e.g. `[-a-z0-9]*[a-z0-9]`) that Docusaurus flags as broken links / mis-parses as link references. The post-doc-gen script `provider-dev/scripts/fix_doc_links.mjs` rewrites the affected pages from a curated map. ```bash -# preview without writing -node provider-dev/scripts/fix_doc_links.mjs --dry-run - -# apply node provider-dev/scripts/fix_doc_links.mjs ``` diff --git a/website/docs/services/connect/connectors/index.md b/website/docs/services/connect/connectors/index.md index d7cfbec..924d9e6 100644 --- a/website/docs/services/connect/connectors/index.md +++ b/website/docs/services/connect/connectors/index.md @@ -88,6 +88,11 @@ Connector. + + + string + + @@ -235,7 +240,7 @@ Retrieve a list of "names" of the active connectors. You can then make a read re ```sql SELECT -* +connectv1_connector FROM confluent.connect.connectors WHERE environment_id = '{{ environment_id }}' -- required AND kafka_cluster_id = '{{ kafka_cluster_id }}' -- required diff --git a/website/docs/services/encryption_keys/data_encryption_keys/index.md b/website/docs/services/encryption_keys/data_encryption_keys/index.md index 543cdb1..aa03916 100644 --- a/website/docs/services/encryption_keys/data_encryption_keys/index.md +++ b/website/docs/services/encryption_keys/data_encryption_keys/index.md @@ -108,6 +108,11 @@ List of dek subjects + + + string + + @@ -254,7 +259,7 @@ List of dek subjects ```sql SELECT -* +dek_subject FROM confluent.encryption_keys.data_encryption_keys WHERE name = '{{ name }}' -- required AND deleted = '{{ deleted }}' diff --git a/website/docs/services/encryption_keys/dek_versions/index.md b/website/docs/services/encryption_keys/dek_versions/index.md index 8e6983f..1caf217 100644 --- a/website/docs/services/encryption_keys/dek_versions/index.md +++ b/website/docs/services/encryption_keys/dek_versions/index.md @@ -108,6 +108,11 @@ List of version numbers for dek + + + integer + + @@ -253,7 +258,7 @@ List of version numbers for dek ```sql SELECT -* +dek_version FROM confluent.encryption_keys.dek_versions WHERE name = '{{ name }}' -- required AND subject = '{{ subject }}' -- required diff --git a/website/docs/services/encryption_keys/key_encryption_keys/index.md b/website/docs/services/encryption_keys/key_encryption_keys/index.md index 82ee8ef..2fc9c62 100644 --- a/website/docs/services/encryption_keys/key_encryption_keys/index.md +++ b/website/docs/services/encryption_keys/key_encryption_keys/index.md @@ -108,6 +108,11 @@ List of kek names + + + string + + @@ -251,7 +256,7 @@ List of kek names ```sql SELECT -* +kek_name FROM confluent.encryption_keys.key_encryption_keys WHERE deleted = '{{ deleted }}' ; diff --git a/website/docs/services/kafka/acls/index.md b/website/docs/services/kafka/acls/index.md index 7a37af6..c7e8b1b 100644 --- a/website/docs/services/kafka/acls/index.md +++ b/website/docs/services/kafka/acls/index.md @@ -89,28 +89,28 @@ The following methods are available for this resource: - cluster_id + cluster_id, kafka_endpoint_id, region, cloud_provider resource_type, resource_name, pattern_type, principal, host, operation, permission - When calling `/acls` without the `principal` parameter, service
accounts are returned in numeric ID format (e.g., `User:12345`).
- To retrieve service accounts in the `sa-xxx` format, use
`/acls?principal=UserV2:*`.
- The `principal` parameter supports both legacy `User:` format and
new `UserV2:` format for service accounts.
Return a list of ACLs that match the search criteria. - cluster_id, resource_type, resource_name, pattern_type, principal, host, operation, permission + cluster_id, kafka_endpoint_id, region, cloud_provider, resource_type, resource_name, pattern_type, principal, host, operation, permission Create an ACL. - resource_type, pattern_type, operation, permission, cluster_id + resource_type, pattern_type, operation, permission, cluster_id, kafka_endpoint_id, region, cloud_provider resource_name, principal, host Delete the ACLs that match the search criteria. - cluster_id, data + cluster_id, kafka_endpoint_id, region, cloud_provider, data Create ACLs. @@ -130,11 +130,21 @@ Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](# + + + string + Cloud provider, lowercase: aws, gcp, or azure (from the cluster spec.cloud). (default: cloud) + string The Kafka cluster ID. (example: cluster-1) + + + string + Per-cluster Kafka REST endpoint ID (the pkc-* host prefix from the Confluent UI Cluster -> Overview -> REST endpoint, or extract from confluent.managed_kafka_clusters.clusters spec.http_endpoint). (default: pkc-00000) + string @@ -150,6 +160,11 @@ Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](# string The ACL permission. + + + string + Cloud region the cluster runs in, e.g. ap-southeast-2 (from the cluster spec.region). (default: region) + string @@ -212,6 +227,9 @@ kind, metadata FROM confluent.kafka.acls WHERE cluster_id = '{{ cluster_id }}' -- required +AND kafka_endpoint_id = '{{ kafka_endpoint_id }}' -- required +AND region = '{{ region }}' -- required +AND cloud_provider = '{{ cloud_provider }}' -- required AND resource_type = '{{ resource_type }}' AND resource_name = '{{ resource_name }}' AND pattern_type = '{{ pattern_type }}' @@ -247,7 +265,10 @@ principal, host, operation, permission, -cluster_id +cluster_id, +kafka_endpoint_id, +region, +cloud_provider ) SELECT '{{ resource_type }}' /* required */, @@ -257,7 +278,10 @@ SELECT '{{ host }}' /* required */, '{{ operation }}' /* required */, '{{ permission }}' /* required */, -'{{ cluster_id }}' +'{{ cluster_id }}', +'{{ kafka_endpoint_id }}', +'{{ region }}', +'{{ cloud_provider }}' ; ``` @@ -269,6 +293,15 @@ SELECT - name: cluster_id value: "{{ cluster_id }}" description: Required parameter for the acls resource. + - name: kafka_endpoint_id + value: "{{ kafka_endpoint_id }}" + description: Required parameter for the acls resource. + - name: region + value: "{{ region }}" + description: Required parameter for the acls resource. + - name: cloud_provider + value: "{{ cloud_provider }}" + description: Required parameter for the acls resource. - name: resource_type value: "{{ resource_type }}" valid_values: ['UNKNOWN', 'ANY', 'TOPIC', 'GROUP', 'CLUSTER', 'TRANSACTIONAL_ID', 'DELEGATION_TOKEN'] @@ -309,6 +342,9 @@ AND pattern_type = '{{ pattern_type }}' --required AND operation = '{{ operation }}' --required AND permission = '{{ permission }}' --required AND cluster_id = '{{ cluster_id }}' --required +AND kafka_endpoint_id = '{{ kafka_endpoint_id }}' --required +AND region = '{{ region }}' --required +AND cloud_provider = '{{ cloud_provider }}' --required AND resource_name = '{{ resource_name }}' AND principal = '{{ principal }}' AND host = '{{ host }}' @@ -332,7 +368,10 @@ Create ACLs. ```sql EXEC confluent.kafka.acls.batch_create_kafka_acls -@cluster_id='{{ cluster_id }}' --required +@cluster_id='{{ cluster_id }}' --required, +@kafka_endpoint_id='{{ kafka_endpoint_id }}' --required, +@region='{{ region }}' --required, +@cloud_provider='{{ cloud_provider }}' --required @@json= '{ "data": "{{ data }}" diff --git a/website/docs/services/kafka/cluster_configs/index.md b/website/docs/services/kafka/cluster_configs/index.md index 2f613b4..244a8cc 100644 --- a/website/docs/services/kafka/cluster_configs/index.md +++ b/website/docs/services/kafka/cluster_configs/index.md @@ -201,35 +201,35 @@ The following methods are available for this resource: - cluster_id, name + cluster_id, name, kafka_endpoint_id, region, cloud_provider Return the dynamic cluster-wide broker configuration parameter specified by ``name``. - cluster_id + cluster_id, kafka_endpoint_id, region, cloud_provider Return a list of dynamic cluster-wide broker configuration parameters for the specified Kafka
cluster. Returns an empty list if there are no dynamic cluster-wide broker configuration parameters. - cluster_id, name + cluster_id, name, kafka_endpoint_id, region, cloud_provider Update the dynamic cluster-wide broker configuration parameter specified by ``name``. - cluster_id, data + cluster_id, kafka_endpoint_id, region, cloud_provider, data Update or delete a set of dynamic cluster-wide broker configuration parameters. - cluster_id, name + cluster_id, name, kafka_endpoint_id, region, cloud_provider Reset the configuration parameter specified by ``name`` to its
default value by deleting a dynamic cluster-wide configuration. @@ -249,16 +249,31 @@ Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](# + + + string + Cloud provider, lowercase: aws, gcp, or azure (from the cluster spec.cloud). (default: cloud) + string The Kafka cluster ID. (example: cluster-1) + + + string + Per-cluster Kafka REST endpoint ID (the pkc-* host prefix from the Confluent UI Cluster -> Overview -> REST endpoint, or extract from confluent.managed_kafka_clusters.clusters spec.http_endpoint). (default: pkc-00000) + string The configuration parameter name. (example: compression.type) + + + string + Cloud region the cluster runs in, e.g. ap-southeast-2 (from the cluster spec.region). (default: region) + @@ -291,6 +306,9 @@ value FROM confluent.kafka.cluster_configs WHERE cluster_id = '{{ cluster_id }}' -- required AND name = '{{ name }}' -- required +AND kafka_endpoint_id = '{{ kafka_endpoint_id }}' -- required +AND region = '{{ region }}' -- required +AND cloud_provider = '{{ cloud_provider }}' -- required ; ``` @@ -313,6 +331,9 @@ synonyms, value FROM confluent.kafka.cluster_configs WHERE cluster_id = '{{ cluster_id }}' -- required +AND kafka_endpoint_id = '{{ kafka_endpoint_id }}' -- required +AND region = '{{ region }}' -- required +AND cloud_provider = '{{ cloud_provider }}' -- required ; ``` @@ -338,7 +359,10 @@ SET value = '{{ value }}' WHERE cluster_id = '{{ cluster_id }}' --required -AND name = '{{ name }}' --required; +AND name = '{{ name }}' --required +AND kafka_endpoint_id = '{{ kafka_endpoint_id }}' --required +AND region = '{{ region }}' --required +AND cloud_provider = '{{ cloud_provider }}' --required; ``` @@ -352,6 +376,9 @@ data = '{{ data }}', validate_only = {{ validate_only }} WHERE cluster_id = '{{ cluster_id }}' --required +AND kafka_endpoint_id = '{{ kafka_endpoint_id }}' --required +AND region = '{{ region }}' --required +AND cloud_provider = '{{ cloud_provider }}' --required AND data = '{{ data }}' --required; ``` @@ -374,6 +401,9 @@ Reset the configuration parameter specified by ``name`` to its
default valu DELETE FROM confluent.kafka.cluster_configs WHERE cluster_id = '{{ cluster_id }}' --required AND name = '{{ name }}' --required +AND kafka_endpoint_id = '{{ kafka_endpoint_id }}' --required +AND region = '{{ region }}' --required +AND cloud_provider = '{{ cloud_provider }}' --required ; ``` diff --git a/website/docs/services/kafka/cluster_link_configs/index.md b/website/docs/services/kafka/cluster_link_configs/index.md index 9e35eb6..9d34752 100644 --- a/website/docs/services/kafka/cluster_link_configs/index.md +++ b/website/docs/services/kafka/cluster_link_configs/index.md @@ -201,35 +201,35 @@ The following methods are available for this resource: - cluster_id, link_name, config_name + cluster_id, link_name, config_name, kafka_endpoint_id, region, cloud_provider - cluster_id, link_name + cluster_id, link_name, kafka_endpoint_id, region, cloud_provider - cluster_id, link_name, config_name, value + cluster_id, link_name, config_name, kafka_endpoint_id, region, cloud_provider, value - cluster_id, link_name, data + cluster_id, link_name, kafka_endpoint_id, region, cloud_provider, data validate_only Batch Alter Cluster Link Configs - cluster_id, link_name, config_name + cluster_id, link_name, config_name, kafka_endpoint_id, region, cloud_provider @@ -249,6 +249,11 @@ Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](# + + + string + Cloud provider, lowercase: aws, gcp, or azure (from the cluster spec.cloud). (default: cloud) + string @@ -259,11 +264,21 @@ Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](# string The link config name (example: consumer.offset.sync.enable) + + + string + Per-cluster Kafka REST endpoint ID (the pkc-* host prefix from the Confluent UI Cluster -> Overview -> REST endpoint, or extract from confluent.managed_kafka_clusters.clusters spec.http_endpoint). (default: pkc-00000) + string The link name (example: link-sb1) + + + string + Cloud region the cluster runs in, e.g. ap-southeast-2 (from the cluster spec.region). (default: region) + boolean @@ -302,6 +317,9 @@ FROM confluent.kafka.cluster_link_configs WHERE cluster_id = '{{ cluster_id }}' -- required AND link_name = '{{ link_name }}' -- required AND config_name = '{{ config_name }}' -- required +AND kafka_endpoint_id = '{{ kafka_endpoint_id }}' -- required +AND region = '{{ region }}' -- required +AND cloud_provider = '{{ cloud_provider }}' -- required ; ``` @@ -325,6 +343,9 @@ value FROM confluent.kafka.cluster_link_configs WHERE cluster_id = '{{ cluster_id }}' -- required AND link_name = '{{ link_name }}' -- required +AND kafka_endpoint_id = '{{ kafka_endpoint_id }}' -- required +AND region = '{{ region }}' -- required +AND cloud_provider = '{{ cloud_provider }}' -- required ; ``` @@ -352,6 +373,9 @@ WHERE cluster_id = '{{ cluster_id }}' --required AND link_name = '{{ link_name }}' --required AND config_name = '{{ config_name }}' --required +AND kafka_endpoint_id = '{{ kafka_endpoint_id }}' --required +AND region = '{{ region }}' --required +AND cloud_provider = '{{ cloud_provider }}' --required AND value = '{{ value }}' --required; ``` @@ -367,6 +391,9 @@ validate_only = {{ validate_only }} WHERE cluster_id = '{{ cluster_id }}' --required AND link_name = '{{ link_name }}' --required +AND kafka_endpoint_id = '{{ kafka_endpoint_id }}' --required +AND region = '{{ region }}' --required +AND cloud_provider = '{{ cloud_provider }}' --required AND data = '{{ data }}' --required AND validate_only = {{ validate_only}}; ``` @@ -391,6 +418,9 @@ DELETE FROM confluent.kafka.cluster_link_configs WHERE cluster_id = '{{ cluster_id }}' --required AND link_name = '{{ link_name }}' --required AND config_name = '{{ config_name }}' --required +AND kafka_endpoint_id = '{{ kafka_endpoint_id }}' --required +AND region = '{{ region }}' --required +AND cloud_provider = '{{ cloud_provider }}' --required ; ``` diff --git a/website/docs/services/kafka/cluster_links/index.md b/website/docs/services/kafka/cluster_links/index.md index 10a9bf8..096f985 100644 --- a/website/docs/services/kafka/cluster_links/index.md +++ b/website/docs/services/kafka/cluster_links/index.md @@ -231,28 +231,28 @@ The following methods are available for this resource: - cluster_id, link_name + cluster_id, link_name, kafka_endpoint_id, region, cloud_provider include_tasks ``link_id`` in ``ListLinksResponseData`` is deprecated and may be removed in a future release. Use the new ``cluster_link_id`` instead. - cluster_id + cluster_id, kafka_endpoint_id, region, cloud_provider ``link_id`` in ``ListLinksResponseData`` is deprecated and may be removed in a future release. Use the new ``cluster_link_id`` instead. - link_name, cluster_id + link_name, cluster_id, kafka_endpoint_id, region, cloud_provider validate_only, validate_link Cluster link creation requires source cluster security configurations in
the configs JSON section of the data request payload. - cluster_id, link_name + cluster_id, link_name, kafka_endpoint_id, region, cloud_provider force, validate_only @@ -272,16 +272,31 @@ Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](# + + + string + Cloud provider, lowercase: aws, gcp, or azure (from the cluster spec.cloud). (default: cloud) + string The Kafka cluster ID. (example: cluster-1) + + + string + Per-cluster Kafka REST endpoint ID (the pkc-* host prefix from the Confluent UI Cluster -> Overview -> REST endpoint, or extract from confluent.managed_kafka_clusters.clusters spec.http_endpoint). (default: pkc-00000) + string The link name (example: link-sb1) + + + string + Cloud region the cluster runs in, e.g. ap-southeast-2 (from the cluster spec.region). (default: region) + boolean @@ -337,6 +352,9 @@ topic_names FROM confluent.kafka.cluster_links WHERE cluster_id = '{{ cluster_id }}' -- required AND link_name = '{{ link_name }}' -- required +AND kafka_endpoint_id = '{{ kafka_endpoint_id }}' -- required +AND region = '{{ region }}' -- required +AND cloud_provider = '{{ cloud_provider }}' -- required AND include_tasks = '{{ include_tasks }}' ; ``` @@ -363,6 +381,9 @@ tasks, topic_names FROM confluent.kafka.cluster_links WHERE cluster_id = '{{ cluster_id }}' -- required +AND kafka_endpoint_id = '{{ kafka_endpoint_id }}' -- required +AND region = '{{ region }}' -- required +AND cloud_provider = '{{ cloud_provider }}' -- required ; ``` @@ -391,6 +412,9 @@ cluster_link_id, configs, link_name, cluster_id, +kafka_endpoint_id, +region, +cloud_provider, validate_only, validate_link ) @@ -402,6 +426,9 @@ SELECT '{{ configs }}', '{{ link_name }}', '{{ cluster_id }}', +'{{ kafka_endpoint_id }}', +'{{ region }}', +'{{ cloud_provider }}', '{{ validate_only }}', '{{ validate_link }}' ; @@ -418,6 +445,15 @@ SELECT - name: cluster_id value: "{{ cluster_id }}" description: Required parameter for the cluster_links resource. + - name: kafka_endpoint_id + value: "{{ kafka_endpoint_id }}" + description: Required parameter for the cluster_links resource. + - name: region + value: "{{ region }}" + description: Required parameter for the cluster_links resource. + - name: cloud_provider + value: "{{ cloud_provider }}" + description: Required parameter for the cluster_links resource. - name: source_cluster_id value: "{{ source_cluster_id }}" - name: destination_cluster_id @@ -464,6 +500,9 @@ SELECT DELETE FROM confluent.kafka.cluster_links WHERE cluster_id = '{{ cluster_id }}' --required AND link_name = '{{ link_name }}' --required +AND kafka_endpoint_id = '{{ kafka_endpoint_id }}' --required +AND region = '{{ region }}' --required +AND cloud_provider = '{{ cloud_provider }}' --required AND force = '{{ force }}' AND validate_only = '{{ validate_only }}' ; diff --git a/website/docs/services/kafka/clusters/index.md b/website/docs/services/kafka/clusters/index.md index 8c18298..68abab0 100644 --- a/website/docs/services/kafka/clusters/index.md +++ b/website/docs/services/kafka/clusters/index.md @@ -124,7 +124,7 @@ The following methods are available for this resource: - cluster_id + cluster_id, kafka_endpoint_id, region, cloud_provider Return the Kafka cluster with the specified ``cluster_id``. @@ -144,11 +144,26 @@ Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](# + + + string + Cloud provider, lowercase: aws, gcp, or azure (from the cluster spec.cloud). (default: cloud) + string The Kafka cluster ID. (example: cluster-1) + + + string + Per-cluster Kafka REST endpoint ID (the pkc-* host prefix from the Confluent UI Cluster -> Overview -> REST endpoint, or extract from confluent.managed_kafka_clusters.clusters spec.http_endpoint). (default: pkc-00000) + + + + string + Cloud region the cluster runs in, e.g. ap-southeast-2 (from the cluster spec.region). (default: region) + @@ -178,6 +193,9 @@ partition_reassignments, topics FROM confluent.kafka.clusters WHERE cluster_id = '{{ cluster_id }}' -- required +AND kafka_endpoint_id = '{{ kafka_endpoint_id }}' -- required +AND region = '{{ region }}' -- required +AND cloud_provider = '{{ cloud_provider }}' -- required ; ``` diff --git a/website/docs/services/kafka/consumer_groups/index.md b/website/docs/services/kafka/consumer_groups/index.md index b5698b9..997ca66 100644 --- a/website/docs/services/kafka/consumer_groups/index.md +++ b/website/docs/services/kafka/consumer_groups/index.md @@ -211,14 +211,14 @@ The following methods are available for this resource: - cluster_id, consumer_group_id + cluster_id, consumer_group_id, kafka_endpoint_id, region, cloud_provider Return the consumer group specified by the ``consumer_group_id``. - cluster_id + cluster_id, kafka_endpoint_id, region, cloud_provider Return the list of consumer groups that belong to the specified
Kafka cluster. @@ -238,6 +238,11 @@ Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](# + + + string + Cloud provider, lowercase: aws, gcp, or azure (from the cluster spec.cloud). (default: cloud) + string @@ -248,6 +253,16 @@ Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](# string The consumer group ID. (example: consumer-group-1) + + + string + Per-cluster Kafka REST endpoint ID (the pkc-* host prefix from the Confluent UI Cluster -> Overview -> REST endpoint, or extract from confluent.managed_kafka_clusters.clusters spec.http_endpoint). (default: pkc-00000) + + + + string + Cloud region the cluster runs in, e.g. ap-southeast-2 (from the cluster spec.region). (default: region) + @@ -281,6 +296,9 @@ type FROM confluent.kafka.consumer_groups WHERE cluster_id = '{{ cluster_id }}' -- required AND consumer_group_id = '{{ consumer_group_id }}' -- required +AND kafka_endpoint_id = '{{ kafka_endpoint_id }}' -- required +AND region = '{{ region }}' -- required +AND cloud_provider = '{{ cloud_provider }}' -- required ; ``` @@ -304,6 +322,9 @@ state, type FROM confluent.kafka.consumer_groups WHERE cluster_id = '{{ cluster_id }}' -- required +AND kafka_endpoint_id = '{{ kafka_endpoint_id }}' -- required +AND region = '{{ region }}' -- required +AND cloud_provider = '{{ cloud_provider }}' -- required ; ``` diff --git a/website/docs/services/kafka/consumers/index.md b/website/docs/services/kafka/consumers/index.md index dbf2045..3e1efbd 100644 --- a/website/docs/services/kafka/consumers/index.md +++ b/website/docs/services/kafka/consumers/index.md @@ -171,14 +171,14 @@ The following methods are available for this resource: - cluster_id, consumer_group_id, consumer_id + cluster_id, consumer_group_id, consumer_id, kafka_endpoint_id, region, cloud_provider Return the consumer specified by the ``consumer_id``. - cluster_id, consumer_group_id + cluster_id, consumer_group_id, kafka_endpoint_id, region, cloud_provider Return a list of consumers that belong to the specified consumer
group. @@ -198,6 +198,11 @@ Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](# + + + string + Cloud provider, lowercase: aws, gcp, or azure (from the cluster spec.cloud). (default: cloud) + string @@ -213,6 +218,16 @@ Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](# string The consumer ID. (example: consumer-1) + + + string + Per-cluster Kafka REST endpoint ID (the pkc-* host prefix from the Confluent UI Cluster -> Overview -> REST endpoint, or extract from confluent.managed_kafka_clusters.clusters spec.http_endpoint). (default: pkc-00000) + + + + string + Cloud region the cluster runs in, e.g. ap-southeast-2 (from the cluster spec.region). (default: region) + @@ -243,6 +258,9 @@ FROM confluent.kafka.consumers WHERE cluster_id = '{{ cluster_id }}' -- required AND consumer_group_id = '{{ consumer_group_id }}' -- required AND consumer_id = '{{ consumer_id }}' -- required +AND kafka_endpoint_id = '{{ kafka_endpoint_id }}' -- required +AND region = '{{ region }}' -- required +AND cloud_provider = '{{ cloud_provider }}' -- required ; ``` @@ -263,6 +281,9 @@ metadata FROM confluent.kafka.consumers WHERE cluster_id = '{{ cluster_id }}' -- required AND consumer_group_id = '{{ consumer_group_id }}' -- required +AND kafka_endpoint_id = '{{ kafka_endpoint_id }}' -- required +AND region = '{{ region }}' -- required +AND cloud_provider = '{{ cloud_provider }}' -- required ; ``` diff --git a/website/docs/services/kafka/consumers_lag_summary/index.md b/website/docs/services/kafka/consumers_lag_summary/index.md index f36fa03..cbfae5a 100644 --- a/website/docs/services/kafka/consumers_lag_summary/index.md +++ b/website/docs/services/kafka/consumers_lag_summary/index.md @@ -139,7 +139,7 @@ The following methods are available for this resource: - cluster_id, consumer_group_id + cluster_id, consumer_group_id, kafka_endpoint_id, region, cloud_provider Return the maximum and total lag of the consumers belonging to the
specified consumer group. @@ -159,6 +159,11 @@ Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](# + + + string + Cloud provider, lowercase: aws, gcp, or azure (from the cluster spec.cloud). (default: cloud) + string @@ -169,6 +174,16 @@ Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](# string The consumer group ID. (example: consumer-group-1) + + + string + Per-cluster Kafka REST endpoint ID (the pkc-* host prefix from the Confluent UI Cluster -> Overview -> REST endpoint, or extract from confluent.managed_kafka_clusters.clusters spec.http_endpoint). (default: pkc-00000) + + + + string + Cloud region the cluster runs in, e.g. ap-southeast-2 (from the cluster spec.region). (default: region) + @@ -202,6 +217,9 @@ total_lag FROM confluent.kafka.consumers_lag_summary WHERE cluster_id = '{{ cluster_id }}' -- required AND consumer_group_id = '{{ consumer_group_id }}' -- required +AND kafka_endpoint_id = '{{ kafka_endpoint_id }}' -- required +AND region = '{{ region }}' -- required +AND cloud_provider = '{{ cloud_provider }}' -- required ; ``` diff --git a/website/docs/services/kafka/consumers_lags/index.md b/website/docs/services/kafka/consumers_lags/index.md index 20046f2..85d7a5f 100644 --- a/website/docs/services/kafka/consumers_lags/index.md +++ b/website/docs/services/kafka/consumers_lags/index.md @@ -211,14 +211,14 @@ The following methods are available for this resource: - cluster_id, consumer_group_id, topic_name, partition_id + cluster_id, consumer_group_id, topic_name, partition_id, kafka_endpoint_id, region, cloud_provider Return the consumer lag on a partition with the given `partition_id`. - cluster_id, consumer_group_id + cluster_id, consumer_group_id, kafka_endpoint_id, region, cloud_provider Return a list of consumer lags of the consumers belonging to the
specified consumer group. @@ -238,6 +238,11 @@ Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](# + + + string + Cloud provider, lowercase: aws, gcp, or azure (from the cluster spec.cloud). (default: cloud) + string @@ -248,11 +253,21 @@ Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](# string The consumer group ID. (example: consumer-group-1) + + + string + Per-cluster Kafka REST endpoint ID (the pkc-* host prefix from the Confluent UI Cluster -> Overview -> REST endpoint, or extract from confluent.managed_kafka_clusters.clusters spec.http_endpoint). (default: pkc-00000) + integer The partition ID. (example: 0) + + + string + Cloud region the cluster runs in, e.g. ap-southeast-2 (from the cluster spec.region). (default: region) + string @@ -293,6 +308,9 @@ WHERE cluster_id = '{{ cluster_id }}' -- required AND consumer_group_id = '{{ consumer_group_id }}' -- required AND topic_name = '{{ topic_name }}' -- required AND partition_id = '{{ partition_id }}' -- required +AND kafka_endpoint_id = '{{ kafka_endpoint_id }}' -- required +AND region = '{{ region }}' -- required +AND cloud_provider = '{{ cloud_provider }}' -- required ; ``` @@ -317,6 +335,9 @@ metadata FROM confluent.kafka.consumers_lags WHERE cluster_id = '{{ cluster_id }}' -- required AND consumer_group_id = '{{ consumer_group_id }}' -- required +AND kafka_endpoint_id = '{{ kafka_endpoint_id }}' -- required +AND region = '{{ region }}' -- required +AND cloud_provider = '{{ cloud_provider }}' -- required ; ``` diff --git a/website/docs/services/kafka/default_topic_configs/index.md b/website/docs/services/kafka/default_topic_configs/index.md index dfc0d32..bb91c24 100644 --- a/website/docs/services/kafka/default_topic_configs/index.md +++ b/website/docs/services/kafka/default_topic_configs/index.md @@ -129,7 +129,7 @@ The following methods are available for this resource: - cluster_id, topic_name + cluster_id, topic_name, kafka_endpoint_id, region, cloud_provider List the default configuration parameters used if the topic were to be newly created. @@ -149,11 +149,26 @@ Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](# + + + string + Cloud provider, lowercase: aws, gcp, or azure (from the cluster spec.cloud). (default: cloud) + string The Kafka cluster ID. (example: cluster-1) + + + string + Per-cluster Kafka REST endpoint ID (the pkc-* host prefix from the Confluent UI Cluster -> Overview -> REST endpoint, or extract from confluent.managed_kafka_clusters.clusters spec.http_endpoint). (default: pkc-00000) + + + + string + Cloud region the cluster runs in, e.g. ap-southeast-2 (from the cluster spec.region). (default: region) + string @@ -190,6 +205,9 @@ value FROM confluent.kafka.default_topic_configs WHERE cluster_id = '{{ cluster_id }}' -- required AND topic_name = '{{ topic_name }}' -- required +AND kafka_endpoint_id = '{{ kafka_endpoint_id }}' -- required +AND region = '{{ region }}' -- required +AND cloud_provider = '{{ cloud_provider }}' -- required ; ``` diff --git a/website/docs/services/kafka/group_configs/index.md b/website/docs/services/kafka/group_configs/index.md index 05347f1..831e66c 100644 --- a/website/docs/services/kafka/group_configs/index.md +++ b/website/docs/services/kafka/group_configs/index.md @@ -201,35 +201,35 @@ The following methods are available for this resource: - cluster_id, group_id, name + cluster_id, group_id, name, kafka_endpoint_id, region, cloud_provider Get the configuration with the specified name for the specified group. This API supports consumer groups, share groups, and streams groups. - cluster_id, group_id + cluster_id, group_id, kafka_endpoint_id, region, cloud_provider List all configurations for the specified group. This API supports consumer groups, share groups, and streams groups. - cluster_id, group_id, name, value + cluster_id, group_id, name, kafka_endpoint_id, region, cloud_provider, value Update the configuration with the specified name for the specified group. This API supports consumer groups, share groups, and streams groups. - cluster_id, group_id, name + cluster_id, group_id, name, kafka_endpoint_id, region, cloud_provider Delete the dynamic configuration override with the specified name for the specified group. After deletion, the default group configuration will be applied. This API supports consumer groups, share groups, and streams groups. - cluster_id, group_id, data + cluster_id, group_id, kafka_endpoint_id, region, cloud_provider, data validate_only Batch alter configurations for the specified group. This API supports consumer groups, share groups, and streams groups. @@ -249,6 +249,11 @@ Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](# + + + string + Cloud provider, lowercase: aws, gcp, or azure (from the cluster spec.cloud). (default: cloud) + string @@ -259,11 +264,21 @@ Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](# string The group ID. (example: group-1) + + + string + Per-cluster Kafka REST endpoint ID (the pkc-* host prefix from the Confluent UI Cluster -> Overview -> REST endpoint, or extract from confluent.managed_kafka_clusters.clusters spec.http_endpoint). (default: pkc-00000) + string The configuration parameter name. (example: compression.type) + + + string + Cloud region the cluster runs in, e.g. ap-southeast-2 (from the cluster spec.region). (default: region) + boolean @@ -302,6 +317,9 @@ FROM confluent.kafka.group_configs WHERE cluster_id = '{{ cluster_id }}' -- required AND group_id = '{{ group_id }}' -- required AND name = '{{ name }}' -- required +AND kafka_endpoint_id = '{{ kafka_endpoint_id }}' -- required +AND region = '{{ region }}' -- required +AND cloud_provider = '{{ cloud_provider }}' -- required ; ``` @@ -325,6 +343,9 @@ value FROM confluent.kafka.group_configs WHERE cluster_id = '{{ cluster_id }}' -- required AND group_id = '{{ group_id }}' -- required +AND kafka_endpoint_id = '{{ kafka_endpoint_id }}' -- required +AND region = '{{ region }}' -- required +AND cloud_provider = '{{ cloud_provider }}' -- required ; ``` @@ -351,6 +372,9 @@ WHERE cluster_id = '{{ cluster_id }}' --required AND group_id = '{{ group_id }}' --required AND name = '{{ name }}' --required +AND kafka_endpoint_id = '{{ kafka_endpoint_id }}' --required +AND region = '{{ region }}' --required +AND cloud_provider = '{{ cloud_provider }}' --required AND value = '{{ value }}' --required; ``` @@ -374,6 +398,9 @@ DELETE FROM confluent.kafka.group_configs WHERE cluster_id = '{{ cluster_id }}' --required AND group_id = '{{ group_id }}' --required AND name = '{{ name }}' --required +AND kafka_endpoint_id = '{{ kafka_endpoint_id }}' --required +AND region = '{{ region }}' --required +AND cloud_provider = '{{ cloud_provider }}' --required ; ``` @@ -396,6 +423,9 @@ Batch alter configurations for the specified group. This API supports consumer g EXEC confluent.kafka.group_configs.update_kafka_group_config_batch @cluster_id='{{ cluster_id }}' --required, @group_id='{{ group_id }}' --required, +@kafka_endpoint_id='{{ kafka_endpoint_id }}' --required, +@region='{{ region }}' --required, +@cloud_provider='{{ cloud_provider }}' --required, @validate_only={{ validate_only }} @@json= '{ diff --git a/website/docs/services/kafka/mirror_topics/index.md b/website/docs/services/kafka/mirror_topics/index.md index 3335832..d0c5ed4 100644 --- a/website/docs/services/kafka/mirror_topics/index.md +++ b/website/docs/services/kafka/mirror_topics/index.md @@ -273,77 +273,77 @@ The following methods are available for this resource: - cluster_id, link_name, mirror_topic_name + cluster_id, link_name, mirror_topic_name, kafka_endpoint_id, region, cloud_provider include_state_transition_errors - cluster_id, link_name + cluster_id, link_name, kafka_endpoint_id, region, cloud_provider mirror_status List all mirror topics under the link - cluster_id + cluster_id, kafka_endpoint_id, region, cloud_provider mirror_status List all mirror topics in the cluster - cluster_id, link_name, source_topic_name + cluster_id, link_name, kafka_endpoint_id, region, cloud_provider, source_topic_name Create a topic in the destination cluster mirroring a topic in
the source cluster - cluster_id, link_name + cluster_id, link_name, kafka_endpoint_id, region, cloud_provider validate_only - cluster_id, link_name + cluster_id, link_name, kafka_endpoint_id, region, cloud_provider validate_only - cluster_id, link_name + cluster_id, link_name, kafka_endpoint_id, region, cloud_provider validate_only - cluster_id, link_name + cluster_id, link_name, kafka_endpoint_id, region, cloud_provider validate_only - cluster_id, link_name + cluster_id, link_name, kafka_endpoint_id, region, cloud_provider validate_only - cluster_id, link_name + cluster_id, link_name, kafka_endpoint_id, region, cloud_provider validate_only - cluster_id, link_name + cluster_id, link_name, kafka_endpoint_id, region, cloud_provider include_partition_level_truncation_data, validate_only @@ -363,11 +363,21 @@ Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](# + + + string + Cloud provider, lowercase: aws, gcp, or azure (from the cluster spec.cloud). (default: cloud) + string The Kafka cluster ID. (example: cluster-1) + + + string + Per-cluster Kafka REST endpoint ID (the pkc-* host prefix from the Confluent UI Cluster -> Overview -> REST endpoint, or extract from confluent.managed_kafka_clusters.clusters spec.http_endpoint). (default: pkc-00000) + string @@ -378,6 +388,11 @@ Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](# string Cluster Linking mirror topic name (example: topic-1) + + + string + Cloud region the cluster runs in, e.g. ap-southeast-2 (from the cluster spec.region). (default: region) + boolean @@ -432,6 +447,9 @@ FROM confluent.kafka.mirror_topics WHERE cluster_id = '{{ cluster_id }}' -- required AND link_name = '{{ link_name }}' -- required AND mirror_topic_name = '{{ mirror_topic_name }}' -- required +AND kafka_endpoint_id = '{{ kafka_endpoint_id }}' -- required +AND region = '{{ region }}' -- required +AND cloud_provider = '{{ cloud_provider }}' -- required AND include_state_transition_errors = '{{ include_state_transition_errors }}' ; ``` @@ -456,6 +474,9 @@ state_time_ms FROM confluent.kafka.mirror_topics WHERE cluster_id = '{{ cluster_id }}' -- required AND link_name = '{{ link_name }}' -- required +AND kafka_endpoint_id = '{{ kafka_endpoint_id }}' -- required +AND region = '{{ region }}' -- required +AND cloud_provider = '{{ cloud_provider }}' -- required AND mirror_status = '{{ mirror_status }}' ; ``` @@ -479,6 +500,9 @@ num_partitions, state_time_ms FROM confluent.kafka.mirror_topics WHERE cluster_id = '{{ cluster_id }}' -- required +AND kafka_endpoint_id = '{{ kafka_endpoint_id }}' -- required +AND region = '{{ region }}' -- required +AND cloud_provider = '{{ cloud_provider }}' -- required AND mirror_status = '{{ mirror_status }}' ; ``` @@ -506,7 +530,10 @@ mirror_topic_name, replication_factor, configs, cluster_id, -link_name +link_name, +kafka_endpoint_id, +region, +cloud_provider ) SELECT '{{ source_topic_name }}' /* required */, @@ -514,7 +541,10 @@ SELECT {{ replication_factor }}, '{{ configs }}', '{{ cluster_id }}', -'{{ link_name }}' +'{{ link_name }}', +'{{ kafka_endpoint_id }}', +'{{ region }}', +'{{ cloud_provider }}' ; ``` @@ -529,6 +559,15 @@ SELECT - name: link_name value: "{{ link_name }}" description: Required parameter for the mirror_topics resource. + - name: kafka_endpoint_id + value: "{{ kafka_endpoint_id }}" + description: Required parameter for the mirror_topics resource. + - name: region + value: "{{ region }}" + description: Required parameter for the mirror_topics resource. + - name: cloud_provider + value: "{{ cloud_provider }}" + description: Required parameter for the mirror_topics resource. - name: source_topic_name value: "{{ source_topic_name }}" - name: mirror_topic_name @@ -567,6 +606,9 @@ SELECT EXEC confluent.kafka.mirror_topics.update_kafka_mirror_topics_promote @cluster_id='{{ cluster_id }}' --required, @link_name='{{ link_name }}' --required, +@kafka_endpoint_id='{{ kafka_endpoint_id }}' --required, +@region='{{ region }}' --required, +@cloud_provider='{{ cloud_provider }}' --required, @validate_only={{ validate_only }} @@json= '{ @@ -584,6 +626,9 @@ EXEC confluent.kafka.mirror_topics.update_kafka_mirror_topics_promote EXEC confluent.kafka.mirror_topics.update_kafka_mirror_topics_failover @cluster_id='{{ cluster_id }}' --required, @link_name='{{ link_name }}' --required, +@kafka_endpoint_id='{{ kafka_endpoint_id }}' --required, +@region='{{ region }}' --required, +@cloud_provider='{{ cloud_provider }}' --required, @validate_only={{ validate_only }} @@json= '{ @@ -601,6 +646,9 @@ EXEC confluent.kafka.mirror_topics.update_kafka_mirror_topics_failover EXEC confluent.kafka.mirror_topics.update_kafka_mirror_topics_pause @cluster_id='{{ cluster_id }}' --required, @link_name='{{ link_name }}' --required, +@kafka_endpoint_id='{{ kafka_endpoint_id }}' --required, +@region='{{ region }}' --required, +@cloud_provider='{{ cloud_provider }}' --required, @validate_only={{ validate_only }} @@json= '{ @@ -618,6 +666,9 @@ EXEC confluent.kafka.mirror_topics.update_kafka_mirror_topics_pause EXEC confluent.kafka.mirror_topics.update_kafka_mirror_topics_resume @cluster_id='{{ cluster_id }}' --required, @link_name='{{ link_name }}' --required, +@kafka_endpoint_id='{{ kafka_endpoint_id }}' --required, +@region='{{ region }}' --required, +@cloud_provider='{{ cloud_provider }}' --required, @validate_only={{ validate_only }} @@json= '{ @@ -635,6 +686,9 @@ EXEC confluent.kafka.mirror_topics.update_kafka_mirror_topics_resume EXEC confluent.kafka.mirror_topics.update_kafka_mirror_topics_reverse_and_start_mirror @cluster_id='{{ cluster_id }}' --required, @link_name='{{ link_name }}' --required, +@kafka_endpoint_id='{{ kafka_endpoint_id }}' --required, +@region='{{ region }}' --required, +@cloud_provider='{{ cloud_provider }}' --required, @validate_only={{ validate_only }} @@json= '{ @@ -652,6 +706,9 @@ EXEC confluent.kafka.mirror_topics.update_kafka_mirror_topics_reverse_and_start_ EXEC confluent.kafka.mirror_topics.update_kafka_mirror_topics_reverse_and_pause_mirror @cluster_id='{{ cluster_id }}' --required, @link_name='{{ link_name }}' --required, +@kafka_endpoint_id='{{ kafka_endpoint_id }}' --required, +@region='{{ region }}' --required, +@cloud_provider='{{ cloud_provider }}' --required, @validate_only={{ validate_only }} @@json= '{ @@ -669,6 +726,9 @@ EXEC confluent.kafka.mirror_topics.update_kafka_mirror_topics_reverse_and_pause_ EXEC confluent.kafka.mirror_topics.update_kafka_mirror_topics_truncate_and_restore_mirror @cluster_id='{{ cluster_id }}' --required, @link_name='{{ link_name }}' --required, +@kafka_endpoint_id='{{ kafka_endpoint_id }}' --required, +@region='{{ region }}' --required, +@cloud_provider='{{ cloud_provider }}' --required, @include_partition_level_truncation_data={{ include_partition_level_truncation_data }}, @validate_only={{ validate_only }} @@json= diff --git a/website/docs/services/kafka/records/index.md b/website/docs/services/kafka/records/index.md index 0bcac54..7260e73 100644 --- a/website/docs/services/kafka/records/index.md +++ b/website/docs/services/kafka/records/index.md @@ -53,7 +53,7 @@ The following methods are available for this resource: - cluster_id, topic_name + cluster_id, topic_name, kafka_endpoint_id, region, cloud_provider Produce records to the given topic, returning delivery reports for each
record produced. This API can be used in streaming mode by setting
"Transfer-Encoding: chunked" header. For as long as the connection is
kept open, the server will keep accepting records. Records are streamed
to and from the server as Concatenated JSON. For each record sent to the
server, the server will asynchronously send back a delivery report, in
the same order, each with its own error_code. An error_code of 200
indicates success. The HTTP status code will be HTTP 200 OK as long as
the connection is successfully established. To identify records that
have encountered an error, check the error_code of each delivery report.

Note that the cluster_id is validated only when running in Confluent Cloud.

This API currently does not support Schema Registry integration. Sending
schemas is not supported. Only BINARY, JSON, and STRING formats are
supported. @@ -73,11 +73,26 @@ Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](# + + + string + Cloud provider, lowercase: aws, gcp, or azure (from the cluster spec.cloud). (default: cloud) + string The Kafka cluster ID. (example: cluster-1) + + + string + Per-cluster Kafka REST endpoint ID (the pkc-* host prefix from the Confluent UI Cluster -> Overview -> REST endpoint, or extract from confluent.managed_kafka_clusters.clusters spec.http_endpoint). (default: pkc-00000) + + + + string + Cloud region the cluster runs in, e.g. ap-southeast-2 (from the cluster spec.region). (default: region) + string @@ -107,7 +122,10 @@ key, value, timestamp, cluster_id, -topic_name +topic_name, +kafka_endpoint_id, +region, +cloud_provider ) SELECT {{ partition_id }}, @@ -116,7 +134,10 @@ SELECT '{{ value }}', '{{ timestamp }}', '{{ cluster_id }}', -'{{ topic_name }}' +'{{ topic_name }}', +'{{ kafka_endpoint_id }}', +'{{ region }}', +'{{ cloud_provider }}' RETURNING cluster_id, partition_id, @@ -141,6 +162,15 @@ value - name: topic_name value: "{{ topic_name }}" description: Required parameter for the records resource. + - name: kafka_endpoint_id + value: "{{ kafka_endpoint_id }}" + description: Required parameter for the records resource. + - name: region + value: "{{ region }}" + description: Required parameter for the records resource. + - name: cloud_provider + value: "{{ cloud_provider }}" + description: Required parameter for the records resource. - name: partition_id value: {{ partition_id }} - name: headers diff --git a/website/docs/services/kafka/topic_configs/index.md b/website/docs/services/kafka/topic_configs/index.md index 391676e..37a1cb9 100644 --- a/website/docs/services/kafka/topic_configs/index.md +++ b/website/docs/services/kafka/topic_configs/index.md @@ -273,42 +273,42 @@ The following methods are available for this resource: - cluster_id, topic_name, name + cluster_id, topic_name, name, kafka_endpoint_id, region, cloud_provider Return the configuration parameter with the given `name`. - cluster_id, topic_name + cluster_id, topic_name, kafka_endpoint_id, region, cloud_provider Return the list of configuration parameters that belong to the specified topic. - cluster_id + cluster_id, kafka_endpoint_id, region, cloud_provider Return the list of configuration parameters for all topics hosted by the specified
cluster. - cluster_id, topic_name, name + cluster_id, topic_name, name, kafka_endpoint_id, region, cloud_provider Update the configuration parameter with given `name`. To update the
number of partitions, see
https://docs.confluent.io/cloud/current/api.html#tag/Topic-(v3)/operation/updatePartitionCountKafkaTopic. - cluster_id, topic_name, data + cluster_id, topic_name, kafka_endpoint_id, region, cloud_provider, data Update or delete a set of topic configuration parameters.
Also supports a dry-run mode that only validates whether the operation would succeed if the
``validate_only`` request property is explicitly specified and set to true. - cluster_id, topic_name, name + cluster_id, topic_name, name, kafka_endpoint_id, region, cloud_provider Reset the configuration parameter with given `name` to its default value. @@ -328,16 +328,31 @@ Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](# + + + string + Cloud provider, lowercase: aws, gcp, or azure (from the cluster spec.cloud). (default: cloud) + string The Kafka cluster ID. (example: cluster-1) + + + string + Per-cluster Kafka REST endpoint ID (the pkc-* host prefix from the Confluent UI Cluster -> Overview -> REST endpoint, or extract from confluent.managed_kafka_clusters.clusters spec.http_endpoint). (default: pkc-00000) + string The configuration parameter name. (example: compression.type) + + + string + Cloud region the cluster runs in, e.g. ap-southeast-2 (from the cluster spec.region). (default: region) + string @@ -377,6 +392,9 @@ FROM confluent.kafka.topic_configs WHERE cluster_id = '{{ cluster_id }}' -- required AND topic_name = '{{ topic_name }}' -- required AND name = '{{ name }}' -- required +AND kafka_endpoint_id = '{{ kafka_endpoint_id }}' -- required +AND region = '{{ region }}' -- required +AND cloud_provider = '{{ cloud_provider }}' -- required ; ``` @@ -400,6 +418,9 @@ value FROM confluent.kafka.topic_configs WHERE cluster_id = '{{ cluster_id }}' -- required AND topic_name = '{{ topic_name }}' -- required +AND kafka_endpoint_id = '{{ kafka_endpoint_id }}' -- required +AND region = '{{ region }}' -- required +AND cloud_provider = '{{ cloud_provider }}' -- required ; ``` @@ -422,6 +443,9 @@ synonyms, value FROM confluent.kafka.topic_configs WHERE cluster_id = '{{ cluster_id }}' -- required +AND kafka_endpoint_id = '{{ kafka_endpoint_id }}' -- required +AND region = '{{ region }}' -- required +AND cloud_provider = '{{ cloud_provider }}' -- required ; ``` @@ -448,7 +472,10 @@ value = '{{ value }}' WHERE cluster_id = '{{ cluster_id }}' --required AND topic_name = '{{ topic_name }}' --required -AND name = '{{ name }}' --required; +AND name = '{{ name }}' --required +AND kafka_endpoint_id = '{{ kafka_endpoint_id }}' --required +AND region = '{{ region }}' --required +AND cloud_provider = '{{ cloud_provider }}' --required; ``` @@ -463,6 +490,9 @@ validate_only = {{ validate_only }} WHERE cluster_id = '{{ cluster_id }}' --required AND topic_name = '{{ topic_name }}' --required +AND kafka_endpoint_id = '{{ kafka_endpoint_id }}' --required +AND region = '{{ region }}' --required +AND cloud_provider = '{{ cloud_provider }}' --required AND data = '{{ data }}' --required; ``` @@ -486,6 +516,9 @@ DELETE FROM confluent.kafka.topic_configs WHERE cluster_id = '{{ cluster_id }}' --required AND topic_name = '{{ topic_name }}' --required AND name = '{{ name }}' --required +AND kafka_endpoint_id = '{{ kafka_endpoint_id }}' --required +AND region = '{{ region }}' --required +AND cloud_provider = '{{ cloud_provider }}' --required ; ``` diff --git a/website/docs/services/kafka/topic_partitions/index.md b/website/docs/services/kafka/topic_partitions/index.md index b9f3f70..900a2cc 100644 --- a/website/docs/services/kafka/topic_partitions/index.md +++ b/website/docs/services/kafka/topic_partitions/index.md @@ -171,14 +171,14 @@ The following methods are available for this resource: - cluster_id, topic_name, partition_id + cluster_id, topic_name, partition_id, kafka_endpoint_id, region, cloud_provider Return the partition with the given `partition_id`. - cluster_id, topic_name + cluster_id, topic_name, kafka_endpoint_id, region, cloud_provider Return the list of partitions that belong to the specified topic. @@ -198,16 +198,31 @@ Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](# + + + string + Cloud provider, lowercase: aws, gcp, or azure (from the cluster spec.cloud). (default: cloud) + string The Kafka cluster ID. (example: cluster-1) + + + string + Per-cluster Kafka REST endpoint ID (the pkc-* host prefix from the Confluent UI Cluster -> Overview -> REST endpoint, or extract from confluent.managed_kafka_clusters.clusters spec.http_endpoint). (default: pkc-00000) + integer The partition ID. (example: 0) + + + string + Cloud region the cluster runs in, e.g. ap-southeast-2 (from the cluster spec.region). (default: region) + string @@ -243,6 +258,9 @@ FROM confluent.kafka.topic_partitions WHERE cluster_id = '{{ cluster_id }}' -- required AND topic_name = '{{ topic_name }}' -- required AND partition_id = '{{ partition_id }}' -- required +AND kafka_endpoint_id = '{{ kafka_endpoint_id }}' -- required +AND region = '{{ region }}' -- required +AND cloud_provider = '{{ cloud_provider }}' -- required ; ``` @@ -263,6 +281,9 @@ replicas FROM confluent.kafka.topic_partitions WHERE cluster_id = '{{ cluster_id }}' -- required AND topic_name = '{{ topic_name }}' -- required +AND kafka_endpoint_id = '{{ kafka_endpoint_id }}' -- required +AND region = '{{ region }}' -- required +AND cloud_provider = '{{ cloud_provider }}' -- required ; ``` diff --git a/website/docs/services/kafka/topics/index.md b/website/docs/services/kafka/topics/index.md index 6b791d3..707d1d6 100644 --- a/website/docs/services/kafka/topics/index.md +++ b/website/docs/services/kafka/topics/index.md @@ -201,35 +201,35 @@ The following methods are available for this resource: - cluster_id, topic_name + cluster_id, topic_name, kafka_endpoint_id, region, cloud_provider include_authorized_operations Return the topic with the given `topic_name`. - cluster_id + cluster_id, kafka_endpoint_id, region, cloud_provider Return the list of topics that belong to the specified Kafka cluster. - cluster_id, topic_name + cluster_id, kafka_endpoint_id, region, cloud_provider, topic_name Create a topic.
Also supports a dry-run mode that only validates whether the topic creation would succeed
if the ``validate_only`` request property is explicitly specified and set to true. Note that
when dry-run mode is being used the response status would be 200 OK instead of 201 Created. - cluster_id, topic_name, partitions_count + cluster_id, topic_name, kafka_endpoint_id, region, cloud_provider, partitions_count Increase the number of partitions for a topic. To update other topic
configurations, see https://docs.confluent.io/cloud/current/api.html#tag/Configs-(v3)/operation/updateKafkaTopicConfig. - cluster_id, topic_name + cluster_id, topic_name, kafka_endpoint_id, region, cloud_provider Delete the topic with the given `topic_name`. @@ -249,11 +249,26 @@ Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](# + + + string + Cloud provider, lowercase: aws, gcp, or azure (from the cluster spec.cloud). (default: cloud) + string The Kafka cluster ID. (example: cluster-1) + + + string + Per-cluster Kafka REST endpoint ID (the pkc-* host prefix from the Confluent UI Cluster -> Overview -> REST endpoint, or extract from confluent.managed_kafka_clusters.clusters spec.http_endpoint). (default: pkc-00000) + + + + string + Cloud region the cluster runs in, e.g. ap-southeast-2 (from the cluster spec.region). (default: region) + string @@ -296,6 +311,9 @@ replication_factor FROM confluent.kafka.topics WHERE cluster_id = '{{ cluster_id }}' -- required AND topic_name = '{{ topic_name }}' -- required +AND kafka_endpoint_id = '{{ kafka_endpoint_id }}' -- required +AND region = '{{ region }}' -- required +AND cloud_provider = '{{ cloud_provider }}' -- required AND include_authorized_operations = '{{ include_authorized_operations }}' ; ``` @@ -319,6 +337,9 @@ partitions_count, replication_factor FROM confluent.kafka.topics WHERE cluster_id = '{{ cluster_id }}' -- required +AND kafka_endpoint_id = '{{ kafka_endpoint_id }}' -- required +AND region = '{{ region }}' -- required +AND cloud_provider = '{{ cloud_provider }}' -- required ; ``` @@ -345,7 +366,10 @@ partitions_count, replication_factor, configs, validate_only, -cluster_id +cluster_id, +kafka_endpoint_id, +region, +cloud_provider ) SELECT '{{ topic_name }}' /* required */, @@ -353,7 +377,10 @@ SELECT {{ replication_factor }}, '{{ configs }}', {{ validate_only }}, -'{{ cluster_id }}' +'{{ cluster_id }}', +'{{ kafka_endpoint_id }}', +'{{ region }}', +'{{ cloud_provider }}' RETURNING cluster_id, topic_name, @@ -377,6 +404,15 @@ replication_factor - name: cluster_id value: "{{ cluster_id }}" description: Required parameter for the topics resource. + - name: kafka_endpoint_id + value: "{{ kafka_endpoint_id }}" + description: Required parameter for the topics resource. + - name: region + value: "{{ region }}" + description: Required parameter for the topics resource. + - name: cloud_provider + value: "{{ cloud_provider }}" + description: Required parameter for the topics resource. - name: topic_name value: "{{ topic_name }}" - name: partitions_count @@ -414,6 +450,9 @@ partitions_count = {{ partitions_count }} WHERE cluster_id = '{{ cluster_id }}' --required AND topic_name = '{{ topic_name }}' --required +AND kafka_endpoint_id = '{{ kafka_endpoint_id }}' --required +AND region = '{{ region }}' --required +AND cloud_provider = '{{ cloud_provider }}' --required AND partitions_count = '{{ partitions_count }}' --required RETURNING cluster_id, @@ -448,6 +487,9 @@ Delete the topic with the given `topic_name`. DELETE FROM confluent.kafka.topics WHERE cluster_id = '{{ cluster_id }}' --required AND topic_name = '{{ topic_name }}' --required +AND kafka_endpoint_id = '{{ kafka_endpoint_id }}' --required +AND region = '{{ region }}' --required +AND cloud_provider = '{{ cloud_provider }}' --required ; ``` diff --git a/website/docs/services/schema_registry/contexts/index.md b/website/docs/services/schema_registry/contexts/index.md index 9f9f554..b8c78b2 100644 --- a/website/docs/services/schema_registry/contexts/index.md +++ b/website/docs/services/schema_registry/contexts/index.md @@ -51,6 +51,11 @@ The contexts. + + + string + + @@ -121,7 +126,7 @@ Retrieves a list of contexts. ```sql SELECT -* +context FROM confluent.schema_registry.contexts WHERE offset = '{{ offset }}' AND limit = '{{ limit }}' diff --git a/website/docs/services/schema_registry/exporters/index.md b/website/docs/services/schema_registry/exporters/index.md index ab4f8de..f3d41c6 100644 --- a/website/docs/services/schema_registry/exporters/index.md +++ b/website/docs/services/schema_registry/exporters/index.md @@ -103,6 +103,11 @@ Name of the exporter + + + string + + @@ -236,7 +241,7 @@ Retrieves a list of schema exporters that have been created. ```sql SELECT -* +exporter FROM confluent.schema_registry.exporters ; ``` diff --git a/website/docs/services/schema_registry/subjects/index.md b/website/docs/services/schema_registry/subjects/index.md index b136bb4..0e1e1be 100644 --- a/website/docs/services/schema_registry/subjects/index.md +++ b/website/docs/services/schema_registry/subjects/index.md @@ -52,6 +52,11 @@ List of subjects matching the specified parameters. + + + string + + @@ -68,6 +73,11 @@ List of subjects matching the specified parameters. + + + string + + @@ -205,7 +215,7 @@ Retrieves all the subjects associated with a particular schema ID. ```sql SELECT -* +subject FROM confluent.schema_registry.subjects WHERE id = '{{ id }}' -- required AND subject = '{{ subject }}' @@ -222,7 +232,7 @@ Retrieves a list of registered subjects matching specified parameters. ```sql SELECT -* +item FROM confluent.schema_registry.subjects WHERE subjectPrefix = '{{ subjectPrefix }}' AND deleted = '{{ deleted }}' diff --git a/website/docs/services/schema_registry/subjects_referenced_by/index.md b/website/docs/services/schema_registry/subjects_referenced_by/index.md index f6f6e5f..c0548e0 100644 --- a/website/docs/services/schema_registry/subjects_referenced_by/index.md +++ b/website/docs/services/schema_registry/subjects_referenced_by/index.md @@ -51,6 +51,11 @@ List of IDs for schemas that reference the specified schema. + + + integer + + @@ -131,7 +136,7 @@ Retrieves the IDs of schemas that reference the specified schema. ```sql SELECT -* +referenced_by FROM confluent.schema_registry.subjects_referenced_by WHERE subject = '{{ subject }}' -- required AND version = '{{ version }}' -- required diff --git a/website/docs/services/schema_registry/types/index.md b/website/docs/services/schema_registry/types/index.md index 18a9f12..ad3460b 100644 --- a/website/docs/services/schema_registry/types/index.md +++ b/website/docs/services/schema_registry/types/index.md @@ -51,6 +51,11 @@ List of supported schema types. + + + string + + @@ -111,7 +116,7 @@ Retrieve the schema types supported by this registry. ```sql SELECT -* +schema_type FROM confluent.schema_registry.types ; ``` diff --git a/website/docs/services/schema_registry/versions/index.md b/website/docs/services/schema_registry/versions/index.md index f79594e..cf29610 100644 --- a/website/docs/services/schema_registry/versions/index.md +++ b/website/docs/services/schema_registry/versions/index.md @@ -140,6 +140,11 @@ List of version numbers matching the specified parameters. + + + integer + + @@ -325,7 +330,7 @@ Retrieves a list of versions registered under the specified subject. ```sql SELECT -* +version FROM confluent.schema_registry.versions WHERE subject = '{{ subject }}' -- required AND deleted = '{{ deleted }}'