connect_clusters

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

Overview

Name	connect_clusters
Type	Resource
Id	google.managedkafka.connect_clusters

Fields

The following fields are returned by SELECT queries:

get

Successful response

Name	Datatype	Description
name	string	Identifier. The name of the Kafka Connect cluster. Structured like: projects/{project_number}/locations/{location}/connectClusters/{connect_cluster_id}
capacityConfig	object	Required. Capacity configuration for the Kafka Connect cluster. (id: CapacityConfig)
config	object	Optional. Configurations for the worker that are overridden from the defaults. The key of the map is a Kafka Connect worker property name, for example: exactly.once.source.support.
createTime	string (google-datetime)	Output only. The time when the cluster was created.
gcpConfig	object	Required. Configuration properties for a Kafka Connect cluster deployed to Google Cloud Platform. (id: ConnectGcpConfig)
kafkaCluster	string	Required. Immutable. The name of the Kafka cluster this Kafka Connect cluster is attached to. Structured like: projects/{project}/locations/{location}/clusters/{cluster}
labels	object	Optional. Labels as key value pairs.
satisfiesPzi	boolean	Output only. Reserved for future use.
satisfiesPzs	boolean	Output only. Reserved for future use.
state	string	Output only. The current state of the cluster.
updateTime	string (google-datetime)	Output only. The time when the cluster was last updated.

list

Successful response

Name	Datatype	Description
name	string	Identifier. The name of the Kafka Connect cluster. Structured like: projects/{project_number}/locations/{location}/connectClusters/{connect_cluster_id}
capacityConfig	object	Required. Capacity configuration for the Kafka Connect cluster. (id: CapacityConfig)
config	object	Optional. Configurations for the worker that are overridden from the defaults. The key of the map is a Kafka Connect worker property name, for example: exactly.once.source.support.
createTime	string (google-datetime)	Output only. The time when the cluster was created.
gcpConfig	object	Required. Configuration properties for a Kafka Connect cluster deployed to Google Cloud Platform. (id: ConnectGcpConfig)
kafkaCluster	string	Required. Immutable. The name of the Kafka cluster this Kafka Connect cluster is attached to. Structured like: projects/{project}/locations/{location}/clusters/{cluster}
labels	object	Optional. Labels as key value pairs.
satisfiesPzi	boolean	Output only. Reserved for future use.
satisfiesPzs	boolean	Output only. Reserved for future use.
state	string	Output only. The current state of the cluster.
updateTime	string (google-datetime)	Output only. The time when the cluster was last updated.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	projectsId, locationsId, connectClustersId		Returns the properties of a single Kafka Connect cluster.
list	select	projectsId, locationsId	pageSize, pageToken, filter, orderBy	Lists the Kafka Connect clusters in a given project and location.
create	insert	projectsId, locationsId	connectClusterId, requestId	Creates a new Kafka Connect cluster in a given project and location.
patch	update	projectsId, locationsId, connectClustersId	updateMask, requestId	Updates the properties of a single Kafka Connect cluster.
delete	delete	projectsId, locationsId, connectClustersId	requestId	Deletes a single Connect cluster.

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
connectClustersId	string
locationsId	string
projectsId	string
connectClusterId	string
filter	string
orderBy	string
pageSize	integer (int32)
pageToken	string
requestId	string
updateMask	string (google-fieldmask)

SELECT examples

get

Returns the properties of a single Kafka Connect cluster.

SELECT
name,
capacityConfig,
config,
createTime,
gcpConfig,
kafkaCluster,
labels,
satisfiesPzi,
satisfiesPzs,
state,
updateTime
FROM google.managedkafka.connect_clusters
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND connectClustersId = '{{ connectClustersId }}' -- required;

list

Lists the Kafka Connect clusters in a given project and location.

SELECT
name,
capacityConfig,
config,
createTime,
gcpConfig,
kafkaCluster,
labels,
satisfiesPzi,
satisfiesPzs,
state,
updateTime
FROM google.managedkafka.connect_clusters
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}'
AND filter = '{{ filter }}'
AND orderBy = '{{ orderBy }}';

INSERT examples

create

Creates a new Kafka Connect cluster in a given project and location.

INSERT INTO google.managedkafka.connect_clusters (
data__gcpConfig,
data__name,
data__kafkaCluster,
data__labels,
data__capacityConfig,
data__config,
projectsId,
locationsId,
connectClusterId,
requestId
)
SELECT 
'{{ gcpConfig }}',
'{{ name }}',
'{{ kafkaCluster }}',
'{{ labels }}',
'{{ capacityConfig }}',
'{{ config }}',
'{{ projectsId }}',
'{{ locationsId }}',
'{{ connectClusterId }}',
'{{ requestId }}'
RETURNING
name,
done,
error,
metadata,
response
;

Manifest

# Description fields are for documentation purposes
- name: connect_clusters
  props:
    - name: projectsId
      value: string
      description: Required parameter for the connect_clusters resource.
    - name: locationsId
      value: string
      description: Required parameter for the connect_clusters resource.
    - name: gcpConfig
      value: object
      description: >
        Required. Configuration properties for a Kafka Connect cluster deployed to Google Cloud Platform.
        
    - name: name
      value: string
      description: >
        Identifier. The name of the Kafka Connect cluster. Structured like: projects/{project_number}/locations/{location}/connectClusters/{connect_cluster_id}
        
    - name: kafkaCluster
      value: string
      description: >
        Required. Immutable. The name of the Kafka cluster this Kafka Connect cluster is attached to. Structured like: projects/{project}/locations/{location}/clusters/{cluster}
        
    - name: labels
      value: object
      description: >
        Optional. Labels as key value pairs.
        
    - name: capacityConfig
      value: object
      description: >
        Required. Capacity configuration for the Kafka Connect cluster.
        
    - name: config
      value: object
      description: >
        Optional. Configurations for the worker that are overridden from the defaults. The key of the map is a Kafka Connect worker property name, for example: `exactly.once.source.support`.
        
    - name: connectClusterId
      value: string
    - name: requestId
      value: string

UPDATE examples

patch

Updates the properties of a single Kafka Connect cluster.

UPDATE google.managedkafka.connect_clusters
SET 
data__gcpConfig = '{{ gcpConfig }}',
data__name = '{{ name }}',
data__kafkaCluster = '{{ kafkaCluster }}',
data__labels = '{{ labels }}',
data__capacityConfig = '{{ capacityConfig }}',
data__config = '{{ config }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND connectClustersId = '{{ connectClustersId }}' --required
AND updateMask = '{{ updateMask}}'
AND requestId = '{{ requestId}}'
RETURNING
name,
done,
error,
metadata,
response;

DELETE examples

delete

Deletes a single Connect cluster.

DELETE FROM google.managedkafka.connect_clusters
WHERE projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND connectClustersId = '{{ connectClustersId }}' --required
AND requestId = '{{ requestId }}';