clusters

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

Overview

Name	clusters
Type	Resource
Id	google.managedkafka.clusters

Fields

The following fields are returned by SELECT queries:

get

Successful response

Name	Datatype	Description
name	string	Identifier. The name of the cluster. Structured like: projects/{project_number}/locations/{location}/clusters/{cluster_id}
capacityConfig	object	Required. Capacity configuration for the Kafka cluster. (id: CapacityConfig)
createTime	string (google-datetime)	Output only. The time when the cluster was created.
gcpConfig	object	Required. Configuration properties for a Kafka cluster deployed to Google Cloud Platform. (id: GcpConfig)
labels	object	Optional. Labels as key value pairs.
rebalanceConfig	object	Optional. Rebalance configuration for the Kafka cluster. (id: RebalanceConfig)
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.
tlsConfig	object	Optional. TLS configuration for the Kafka cluster. (id: TlsConfig)
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 cluster. Structured like: projects/{project_number}/locations/{location}/clusters/{cluster_id}
capacityConfig	object	Required. Capacity configuration for the Kafka cluster. (id: CapacityConfig)
createTime	string (google-datetime)	Output only. The time when the cluster was created.
gcpConfig	object	Required. Configuration properties for a Kafka cluster deployed to Google Cloud Platform. (id: GcpConfig)
labels	object	Optional. Labels as key value pairs.
rebalanceConfig	object	Optional. Rebalance configuration for the Kafka cluster. (id: RebalanceConfig)
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.
tlsConfig	object	Optional. TLS configuration for the Kafka cluster. (id: TlsConfig)
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, clustersId		Returns the properties of a single cluster.
list	select	projectsId, locationsId	pageSize, pageToken, filter, orderBy	Lists the clusters in a given project and location.
create	insert	projectsId, locationsId	clusterId, requestId	Creates a new cluster in a given project and location.
patch	update	projectsId, locationsId, clustersId	updateMask, requestId	Updates the properties of a single cluster.
delete	delete	projectsId, locationsId, clustersId	requestId	Deletes a single 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
clustersId	string
locationsId	string
projectsId	string
clusterId	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 cluster.

SELECT
name,
capacityConfig,
createTime,
gcpConfig,
labels,
rebalanceConfig,
satisfiesPzi,
satisfiesPzs,
state,
tlsConfig,
updateTime
FROM google.managedkafka.clusters
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND clustersId = '{{ clustersId }}' -- required;

list

Lists the clusters in a given project and location.

SELECT
name,
capacityConfig,
createTime,
gcpConfig,
labels,
rebalanceConfig,
satisfiesPzi,
satisfiesPzs,
state,
tlsConfig,
updateTime
FROM google.managedkafka.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 cluster in a given project and location.

INSERT INTO google.managedkafka.clusters (
data__gcpConfig,
data__name,
data__labels,
data__capacityConfig,
data__rebalanceConfig,
data__tlsConfig,
projectsId,
locationsId,
clusterId,
requestId
)
SELECT 
'{{ gcpConfig }}',
'{{ name }}',
'{{ labels }}',
'{{ capacityConfig }}',
'{{ rebalanceConfig }}',
'{{ tlsConfig }}',
'{{ projectsId }}',
'{{ locationsId }}',
'{{ clusterId }}',
'{{ requestId }}'
RETURNING
name,
done,
error,
metadata,
response
;

Manifest

# Description fields are for documentation purposes
- name: clusters
  props:
    - name: projectsId
      value: string
      description: Required parameter for the clusters resource.
    - name: locationsId
      value: string
      description: Required parameter for the clusters resource.
    - name: gcpConfig
      value: object
      description: >
        Required. Configuration properties for a Kafka cluster deployed to Google Cloud Platform.
        
    - name: name
      value: string
      description: >
        Identifier. The name of the cluster. Structured like: projects/{project_number}/locations/{location}/clusters/{cluster_id}
        
    - name: labels
      value: object
      description: >
        Optional. Labels as key value pairs.
        
    - name: capacityConfig
      value: object
      description: >
        Required. Capacity configuration for the Kafka cluster.
        
    - name: rebalanceConfig
      value: object
      description: >
        Optional. Rebalance configuration for the Kafka cluster.
        
    - name: tlsConfig
      value: object
      description: >
        Optional. TLS configuration for the Kafka cluster.
        
    - name: clusterId
      value: string
    - name: requestId
      value: string

UPDATE examples

patch

Updates the properties of a single cluster.

UPDATE google.managedkafka.clusters
SET 
data__gcpConfig = '{{ gcpConfig }}',
data__name = '{{ name }}',
data__labels = '{{ labels }}',
data__capacityConfig = '{{ capacityConfig }}',
data__rebalanceConfig = '{{ rebalanceConfig }}',
data__tlsConfig = '{{ tlsConfig }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND clustersId = '{{ clustersId }}' --required
AND updateMask = '{{ updateMask}}'
AND requestId = '{{ requestId}}'
RETURNING
name,
done,
error,
metadata,
response;

DELETE examples

delete

Deletes a single cluster.

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