Package google.cloud.managedkafka.v1

Index

ManagedKafka

The service that a client application uses to manage Apache Kafka clusters, topics and consumer groups.

CreateCluster

rpc CreateCluster(CreateClusterRequest) returns (Operation)

Creates a new cluster in a given project and location.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the parent resource:

  • managedkafka.clusters.create

For more information, see the IAM documentation.
CreateTopic

rpc CreateTopic(CreateTopicRequest) returns (Topic)

Creates a new topic in a given project and location.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the parent resource:

  • managedkafka.topics.create

For more information, see the IAM documentation.
DeleteCluster

rpc DeleteCluster(DeleteClusterRequest) returns (Operation)

Deletes a single cluster.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • managedkafka.clusters.delete

For more information, see the IAM documentation.
DeleteConsumerGroup

rpc DeleteConsumerGroup(DeleteConsumerGroupRequest) returns (Empty)

Deletes a single consumer group.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • managedkafka.consumerGroups.delete

For more information, see the IAM documentation.
DeleteTopic

rpc DeleteTopic(DeleteTopicRequest) returns (Empty)

Deletes a single topic.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • managedkafka.topics.delete

For more information, see the IAM documentation.
GetCluster

rpc GetCluster(GetClusterRequest) returns (Cluster)

Returns the properties of a single cluster.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • managedkafka.clusters.get

For more information, see the IAM documentation.
GetConsumerGroup

rpc GetConsumerGroup(GetConsumerGroupRequest) returns (ConsumerGroup)

Returns the properties of a single consumer group.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • managedkafka.consumerGroups.get

For more information, see the IAM documentation.
GetTopic

rpc GetTopic(GetTopicRequest) returns (Topic)

Returns the properties of a single topic.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • managedkafka.topics.get

For more information, see the IAM documentation.
ListClusters

rpc ListClusters(ListClustersRequest) returns (ListClustersResponse)

Lists the clusters in a given project and location.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the parent resource:

  • managedkafka.clusters.list

For more information, see the IAM documentation.
ListConsumerGroups

rpc ListConsumerGroups(ListConsumerGroupsRequest) returns (ListConsumerGroupsResponse)

Lists the consumer groups in a given cluster.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the parent resource:

  • managedkafka.consumerGroups.list

For more information, see the IAM documentation.
ListTopics

rpc ListTopics(ListTopicsRequest) returns (ListTopicsResponse)

Lists the topics in a given cluster.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the parent resource:

  • managedkafka.topics.list

For more information, see the IAM documentation.
UpdateCluster

rpc UpdateCluster(UpdateClusterRequest) returns (Operation)

Updates the properties of a single cluster.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • managedkafka.clusters.update

For more information, see the IAM documentation.
UpdateConsumerGroup

rpc UpdateConsumerGroup(UpdateConsumerGroupRequest) returns (ConsumerGroup)

Updates the properties of a single consumer group.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • managedkafka.consumerGroups.update

For more information, see the IAM documentation.
UpdateTopic

rpc UpdateTopic(UpdateTopicRequest) returns (Topic)

Updates the properties of a single topic.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • managedkafka.topics.update

For more information, see the IAM documentation.

ManagedKafkaConnect

The service that a client application uses to manage Apache Kafka Connect clusters and connectors.

CreateConnectCluster

rpc CreateConnectCluster(CreateConnectClusterRequest) returns (Operation)

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

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the kafkaCluster resource:

  • managedkafka.clusters.attachConnectCluster

Requires the following IAM permission on the parent resource:

  • managedkafka.connectClusters.create

For more information, see the IAM documentation.
CreateConnector

rpc CreateConnector(CreateConnectorRequest) returns (Connector)

Creates a new connector in a given Connect cluster.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the parent resource:

  • managedkafka.connectors.create

For more information, see the IAM documentation.
DeleteConnectCluster

rpc DeleteConnectCluster(DeleteConnectClusterRequest) returns (Operation)

Deletes a single Connect cluster.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • managedkafka.connectClusters.delete

For more information, see the IAM documentation.
DeleteConnector

rpc DeleteConnector(DeleteConnectorRequest) returns (Empty)

Deletes a connector.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • managedkafka.connectors.delete

For more information, see the IAM documentation.
GetConnectCluster

rpc GetConnectCluster(GetConnectClusterRequest) returns (ConnectCluster)

Returns the properties of a single Kafka Connect cluster.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • managedkafka.connectClusters.get

For more information, see the IAM documentation.
GetConnector

rpc GetConnector(GetConnectorRequest) returns (Connector)

Returns the properties of a single connector.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • managedkafka.connectors.get

For more information, see the IAM documentation.
ListConnectClusters

rpc ListConnectClusters(ListConnectClustersRequest) returns (ListConnectClustersResponse)

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

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the parent resource:

  • managedkafka.connectClusters.list

For more information, see the IAM documentation.
ListConnectors

rpc ListConnectors(ListConnectorsRequest) returns (ListConnectorsResponse)

Lists the connectors in a given Connect cluster.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the parent resource:

  • managedkafka.connectors.list

For more information, see the IAM documentation.
PauseConnector

rpc PauseConnector(PauseConnectorRequest) returns (PauseConnectorResponse)

Pauses the connector and its tasks.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • managedkafka.connectors.pause

For more information, see the IAM documentation.
RestartConnector

rpc RestartConnector(RestartConnectorRequest) returns (RestartConnectorResponse)

Restarts the connector.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • managedkafka.connectors.restart

For more information, see the IAM documentation.
ResumeConnector

rpc ResumeConnector(ResumeConnectorRequest) returns (ResumeConnectorResponse)

Resumes the connector and its tasks.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • managedkafka.connectors.resume

For more information, see the IAM documentation.
StopConnector

rpc StopConnector(StopConnectorRequest) returns (StopConnectorResponse)

Stops the connector.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • managedkafka.connectors.stop

For more information, see the IAM documentation.
UpdateConnectCluster

rpc UpdateConnectCluster(UpdateConnectClusterRequest) returns (Operation)

Updates the properties of a single Kafka Connect cluster.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • managedkafka.connectClusters.update

For more information, see the IAM documentation.
UpdateConnector

rpc UpdateConnector(UpdateConnectorRequest) returns (Connector)

Updates the properties of a connector.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • managedkafka.connectors.update

For more information, see the IAM documentation.

AccessConfig

The configuration of access to the Kafka cluster.

Fields
network_configs[]

NetworkConfig

Required. Virtual Private Cloud (VPC) networks that must be granted direct access to the Kafka cluster. Minimum of 1 network is required. Maximum 10 networks can be specified.

CapacityConfig

A capacity configuration of a Kafka cluster.

Fields
vcpu_count

int64

Required. The number of vCPUs to provision for the cluster. Minimum: 3.
memory_bytes

int64

Required. The memory to provision for the cluster in bytes. The CPU:memory ratio (vCPU:GiB) must be between 1:1 and 1:8. Minimum: 3221225472 (3 GiB).

Cluster

An Apache Kafka cluster deployed in a location.

Fields
name

string

Identifier. The name of the cluster. Structured like: projects/{project_number}/locations/{location}/clusters/{cluster_id}
create_time

Timestamp

Output only. The time when the cluster was created.
update_time

Timestamp

Output only. The time when the cluster was last updated.
labels

map<string, string>

Optional. Labels as key value pairs.
capacity_config

CapacityConfig

Required. Capacity configuration for the Kafka cluster.
rebalance_config

RebalanceConfig

Optional. Rebalance configuration for the Kafka cluster.
state

State

Output only. The current state of the cluster.
Union field platform_config. Platform specific configuration properties for a Kafka cluster. platform_config can be only one of the following:
gcp_config

GcpConfig

Required. Configuration properties for a Kafka cluster deployed to Google Cloud Platform.
satisfies_pzi

bool

Output only. Reserved for future use.
satisfies_pzs

bool

Output only. Reserved for future use.

State

The state of the cluster.

Enums
STATE_UNSPECIFIED A state was not specified.
CREATING The cluster is being created.
ACTIVE The cluster is active.
DELETING The cluster is being deleted.

ConnectAccessConfig

The configuration of access to the Kafka Connect cluster.

Fields
network_configs[]

ConnectNetworkConfig

Required. Virtual Private Cloud (VPC) networks that must be granted direct access to the Kafka Connect cluster. Minimum of 1 network is required. Maximum 10 networks can be specified.

ConnectCluster

An Apache Kafka Connect cluster deployed in a location.

Fields
name

string

Identifier. The name of the Kafka Connect cluster. Structured like: projects/{project_number}/locations/{location}/connectClusters/{connect_cluster_id}
kafka_cluster

string

Required. Immutable. The name of the Kafka cluster this Kafka Connect cluster is attached to. Structured like: projects/{project}/locations/{location}/clusters/{cluster}
create_time

Timestamp

Output only. The time when the cluster was created.
update_time

Timestamp

Output only. The time when the cluster was last updated.
labels

map<string, string>

Optional. Labels as key value pairs.
capacity_config

CapacityConfig

Required. Capacity configuration for the Kafka Connect cluster.
state

State

Output only. The current state of the cluster.
config

map<string, string>

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.
Union field platform_config. Platform specific configuration properties for a Kafka Connect cluster. platform_config can be only one of the following:
gcp_config

ConnectGcpConfig

Required. Configuration properties for a Kafka Connect cluster deployed to Google Cloud Platform.

State

The state of the cluster.

Enums
STATE_UNSPECIFIED A state was not specified.
CREATING The cluster is being created.
ACTIVE The cluster is active.
DELETING The cluster is being deleted.

ConnectGcpConfig

Configuration properties for a Kafka Connect cluster deployed to Google Cloud Platform.

Fields
access_config

ConnectAccessConfig

Required. Access configuration for the Kafka Connect cluster.
secret_paths[]

string

Optional. Secrets to load into workers. Exact SecretVersions from Secret Manager must be provided -- aliases are not supported. Up to 32 secrets may be loaded into one cluster. Format: projects//secrets//versions/

ConnectNetworkConfig

The configuration of a Virtual Private Cloud (VPC) network that can access the Kafka Connect cluster.

Fields
primary_subnet

string

Required. VPC subnet to make available to the Kafka Connect cluster. Structured like: projects/{project}/regions/{region}/subnetworks/{subnet_id}

It is used to create a Private Service Connect (PSC) interface for the Kafka Connect workers. It must be located in the same region as the Kafka Connect cluster.

The CIDR range of the subnet must be within the IPv4 address ranges for private networks, as specified in RFC 1918. The primary subnet CIDR range must have a minimum size of /22 (1024 addresses).
additional_subnets[]

string

Optional. Additional subnets may be specified. They may be in another region, but must be in the same VPC network. The Connect workers can communicate with network endpoints in either the primary or additional subnets.
dns_domain_names[]

string

Optional. Additional DNS domain names from the subnet's network to be made visible to the Connect Cluster. When using MirrorMaker2, it's necessary to add the bootstrap address's dns domain name of the target cluster to make it visible to the connector. For example: my-kafka-cluster.us-central1.managedkafka.my-project.cloud.goog

Connector

A Kafka Connect connector in a given ConnectCluster.

Fields
name

string

Identifier. The name of the connector. Structured like: projects/{project}/locations/{location}/connectClusters/{connect_cluster}/connectors/{connector}
configs

map<string, string>

Optional. Connector config as keys/values. The keys of the map are connector property names, for example: connector.class, tasks.max, key.converter.
state

State

Output only. The current state of the connector.
Union field restart_policy. A policy that specifies how to restart the failed connectors/tasks in a Cluster resource. If not set, the failed connectors/tasks won't be restarted. restart_policy can be only one of the following:
task_restart_policy

TaskRetryPolicy

Optional. Restarts the individual tasks of a Connector.

State

The state of the connector.

Enums
STATE_UNSPECIFIED A state was not specified.
UNASSIGNED The connector is not assigned to any tasks, usually transient.
RUNNING The connector is running.
PAUSED The connector has been paused.
FAILED The connector has failed. See logs for why.
RESTARTING The connector is restarting.
STOPPED The connector has been stopped.

ConsumerGroup

A Kafka consumer group in a given cluster.

Fields
name

string

Identifier. The name of the consumer group. The consumer_group segment is used when connecting directly to the cluster. Structured like: projects/{project}/locations/{location}/clusters/{cluster}/consumerGroups/{consumer_group}
topics

map<string, ConsumerTopicMetadata>

Optional. Metadata for this consumer group for all topics it has metadata for. The key of the map is a topic name, structured like: projects/{project}/locations/{location}/clusters/{cluster}/topics/{topic}

ConsumerPartitionMetadata

Metadata for a consumer group corresponding to a specific partition.

Fields
offset

int64

Required. The current offset for this partition, or 0 if no offset has been committed.
metadata

string

Optional. The associated metadata for this partition, or empty if it does not exist.

ConsumerTopicMetadata

Metadata for a consumer group corresponding to a specific topic.

Fields
partitions

map<int32, ConsumerPartitionMetadata>

Optional. Metadata for this consumer group and topic for all partition indexes it has metadata for.

CreateClusterRequest

Request for CreateCluster.

Fields
parent

string

Required. The parent region in which to create the cluster. Structured like projects/{project}/locations/{location}.
cluster_id

string

Required. The ID to use for the cluster, which will become the final component of the cluster's name. The ID must be 1-63 characters long, and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? to comply with RFC 1035.

This value is structured like: my-cluster-id.
cluster

Cluster

Required. Configuration of the cluster to create. Its name field is ignored.
request_id

string

Optional. An optional request ID to identify requests. Specify a unique request ID to avoid duplication of requests. If a request times out or fails, retrying with the same ID allows the server to recognize the previous attempt. For at least 60 minutes, the server ignores duplicate requests bearing the same ID.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID within 60 minutes of the last request, the server checks if an original operation with the same request ID was received. If so, the server ignores the second request.

The request ID must be a valid UUID. A zero UUID is not supported (00000000-0000-0000-0000-000000000000).

CreateConnectClusterRequest

Request for CreateConnectCluster.

Fields
parent

string

Required. The parent project/location in which to create the Kafka Connect cluster. Structured like projects/{project}/locations/{location}/.
connect_cluster_id

string

Required. The ID to use for the Connect cluster, which will become the final component of the cluster's name. The ID must be 1-63 characters long, and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? to comply with RFC 1035.

This value is structured like: my-cluster-id.
connect_cluster

ConnectCluster

Required. Configuration of the Kafka Connect cluster to create. Its name field is ignored.
request_id

string

Optional. An optional request ID to identify requests. Specify a unique request ID to avoid duplication of requests. If a request times out or fails, retrying with the same ID allows the server to recognize the previous attempt. For at least 60 minutes, the server ignores duplicate requests bearing the same ID.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID within 60 minutes of the last request, the server checks if an original operation with the same request ID was received. If so, the server ignores the second request.

The request ID must be a valid UUID. A zero UUID is not supported (00000000-0000-0000-0000-000000000000).

CreateConnectorRequest

Request for CreateConnector.

Fields
parent

string

Required. The parent Connect cluster in which to create the connector. Structured like projects/{project}/locations/{location}/connectClusters/{connect_cluster_id}.
connector_id

string

Required. The ID to use for the connector, which will become the final component of the connector's name. The ID must be 1-63 characters long, and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? to comply with RFC 1035.

This value is structured like: my-connector-id.
connector

Connector

Required. The connector to create.

CreateTopicRequest

Request for CreateTopic.

Fields
parent

string

Required. The parent cluster in which to create the topic. Structured like projects/{project}/locations/{location}/clusters/{cluster}.
topic_id

string

Required. The ID to use for the topic, which will become the final component of the topic's name.

This value is structured like: my-topic-name.
topic

Topic

Required. Configuration of the topic to create. Its name field is ignored.

DeleteClusterRequest

Request for DeleteCluster.

Fields
name

string

Required. The name of the cluster to delete.
request_id

string

Optional. An optional request ID to identify requests. Specify a unique request ID to avoid duplication of requests. If a request times out or fails, retrying with the same ID allows the server to recognize the previous attempt. For at least 60 minutes, the server ignores duplicate requests bearing the same ID.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID within 60 minutes of the last request, the server checks if an original operation with the same request ID was received. If so, the server ignores the second request.

The request ID must be a valid UUID. A zero UUID is not supported (00000000-0000-0000-0000-000000000000).

DeleteConnectClusterRequest

Request for DeleteConnectCluster.

Fields
name

string

Required. The name of the Kafka Connect cluster to delete. Structured like projects/{project}/locations/{location}/connectClusters/{connect_cluster_id}.
request_id

string

Optional. An optional request ID to identify requests. Specify a unique request ID to avoid duplication of requests. If a request times out or fails, retrying with the same ID allows the server to recognize the previous attempt. For at least 60 minutes, the server ignores duplicate requests bearing the same ID.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID within 60 minutes of the last request, the server checks if an original operation with the same request ID was received. If so, the server ignores the second request.

The request ID must be a valid UUID. A zero UUID is not supported (00000000-0000-0000-0000-000000000000).

DeleteConnectorRequest

Request for DeleteConnector.

Fields
name

string

Required. The name of the connector to delete. Structured like: projects/{project}/locations/{location}/connectClusters/{connectCluster}/connectors/{connector}

DeleteConsumerGroupRequest

Request for DeleteConsumerGroup.

Fields
name

string

Required. The name of the consumer group to delete. projects/{project}/locations/{location}/clusters/{cluster}/consumerGroups/{consumerGroup}.

DeleteTopicRequest

Request for DeleteTopic.

Fields
name

string

Required. The name of the topic to delete. projects/{project}/locations/{location}/clusters/{cluster}/topics/{topic}.

GcpConfig

Configuration properties for a Kafka cluster deployed to Google Cloud Platform.

Fields
access_config

AccessConfig

Required. Access configuration for the Kafka cluster.
kms_key

string

Optional. Immutable. The Cloud KMS Key name to use for encryption. The key must be located in the same region as the cluster and cannot be changed. Structured like: projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}.

GetClusterRequest

Request for GetCluster.

Fields
name

string

Required. The name of the cluster whose configuration to return.

GetConnectClusterRequest

Request for GetConnectCluster.

Fields
name

string

Required. The name of the Kafka Connect cluster whose configuration to return. Structured like projects/{project}/locations/{location}/connectClusters/{connect_cluster_id}.

GetConnectorRequest

Request for GetConnector.

Fields
name

string

Required. The name of the connector whose configuration to return. Structured like: projects/{project}/locations/{location}/connectClusters/{connectCluster}/connectors/{connector}

GetConsumerGroupRequest

Request for GetConsumerGroup.

Fields
name

string

Required. The name of the consumer group whose configuration to return. projects/{project}/locations/{location}/clusters/{cluster}/consumerGroups/{consumerGroup}.

GetTopicRequest

Request for GetTopic.

Fields
name

string

Required. The name of the topic whose configuration to return. Structured like: projects/{project}/locations/{location}/clusters/{cluster}/topics/{topic}.

ListClustersRequest

Request for ListClusters.

Fields
parent

string

Required. The parent location whose clusters are to be listed. Structured like projects/{project}/locations/{location}.
page_size

int32

Optional. The maximum number of clusters to return. The service may return fewer than this value. If unspecified, server will pick an appropriate default.
page_token

string

Optional. A page token, received from a previous ListClusters call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ListClusters must match the call that provided the page token.
filter

string

Optional. Filter expression for the result.
order_by

string

Optional. Order by fields for the result.

ListClustersResponse

Response for ListClusters.

Fields
clusters[]

Cluster

The list of Clusters in the requested parent.
next_page_token

string

A token that can be sent as page_token to retrieve the next page of results. If this field is omitted, there are no more results.
unreachable[]

string

Locations that could not be reached.

ListConnectClustersRequest

Request for ListConnectClusters.

Fields
parent

string

Required. The parent project/location whose Connect clusters are to be listed. Structured like projects/{project}/locations/{location}.
page_size

int32

Optional. The maximum number of Connect clusters to return. The service may return fewer than this value. If unspecified, server will pick an appropriate default.
page_token

string

Optional. A page token, received from a previous ListConnectClusters call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ListConnectClusters must match the call that provided the page token.
filter

string

Optional. Filter expression for the result.
order_by

string

Optional. Order by fields for the result.

ListConnectClustersResponse

Response for ListConnectClusters.

Fields
connect_clusters[]

ConnectCluster

The list of Connect clusters in the requested parent.
next_page_token

string

A token that can be sent as page_token to retrieve the next page of results. If this field is omitted, there are no more results.
unreachable[]

string

Locations that could not be reached.

ListConnectorsRequest

Request for ListConnectors.

Fields
parent

string

Required. The parent Connect cluster whose connectors are to be listed. Structured like projects/{project}/locations/{location}/connectClusters/{connect_cluster_id}.
page_size

int32

Optional. The maximum number of connectors to return. The service may return fewer than this value. If unspecified, server will pick an appropriate default.
page_token

string

Optional. A page token, received from a previous ListConnectors call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ListConnectors must match the call that provided the page token.

ListConnectorsResponse

Response for ListConnectors.

Fields
connectors[]

Connector

The list of connectors in the requested parent.
next_page_token

string

A token that can be sent as page_token to retrieve the next page of results. If this field is omitted, there are no more results.

ListConsumerGroupsRequest

Request for ListConsumerGroups.

Fields
parent

string

Required. The parent cluster whose consumer groups are to be listed. Structured like projects/{project}/locations/{location}/clusters/{cluster}.
page_size

int32

Optional. The maximum number of consumer groups to return. The service may return fewer than this value. If unset or zero, all consumer groups for the parent is returned.
page_token

string

Optional. A page token, received from a previous ListConsumerGroups call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ListConsumerGroups must match the call that provided the page token.

ListConsumerGroupsResponse

Response for ListConsumerGroups.

Fields
consumer_groups[]

ConsumerGroup

The list of consumer group in the requested parent. The order of the consumer groups is unspecified.
next_page_token

string

A token that can be sent as page_token to retrieve the next page of results. If this field is omitted, there are no more results.

ListTopicsRequest

Request for ListTopics.

Fields
parent

string

Required. The parent cluster whose topics are to be listed. Structured like projects/{project}/locations/{location}/clusters/{cluster}.
page_size

int32

Optional. The maximum number of topics to return. The service may return fewer than this value. If unset or zero, all topics for the parent is returned.
page_token

string

Optional. A page token, received from a previous ListTopics call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ListTopics must match the call that provided the page token.

ListTopicsResponse

Response for ListTopics.

Fields
topics[]

Topic

The list of topics in the requested parent. The order of the topics is unspecified.
next_page_token

string

A token that can be sent as page_token to retrieve the next page of results. If this field is omitted, there are no more results.

NetworkConfig

The configuration of a Virtual Private Cloud (VPC) network that can access the Kafka cluster.

Fields
subnet

string

Required. Name of the VPC subnet in which to create Private Service Connect (PSC) endpoints for the Kafka brokers and bootstrap address. Structured like: projects/{project}/regions/{region}/subnetworks/{subnet_id}

The subnet must be located in the same region as the Kafka cluster. The project may differ. Multiple subnets from the same parent network must not be specified.

OperationMetadata

Represents the metadata of the long-running operation.

Fields
create_time

Timestamp

Output only. The time the operation was created.
end_time

Timestamp

Output only. The time the operation finished running.
target

string

Output only. Server-defined resource path for the target of the operation.
verb

string

Output only. Name of the verb executed by the operation.
status_message

string

Output only. Human-readable status of the operation, if any.
requested_cancellation

bool

Output only. Identifies whether the user has requested cancellation of the operation. Operations that have been cancelled successfully have [Operation.error][] value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.
api_version

string

Output only. API version used to start the operation.

PauseConnectorRequest

Request for PauseConnector.

Fields
name

string

Required. The name of the connector to pause. Structured like: projects/{project}/locations/{location}/connectClusters/{connectCluster}/connectors/{connector}

PauseConnectorResponse

This type has no fields.

Response for PauseConnector.

RebalanceConfig

Defines rebalancing behavior of a Kafka cluster.

Fields
mode

Mode

Optional. The rebalance behavior for the cluster. When not specified, defaults to NO_REBALANCE.

Mode

The partition rebalance mode for the cluster.

Enums
MODE_UNSPECIFIED A mode was not specified. Do not use.
NO_REBALANCE Do not rebalance automatically.
AUTO_REBALANCE_ON_SCALE_UP Automatically rebalance topic partitions among brokers when the cluster is scaled up.

RestartConnectorRequest

Request for RestartConnector.

Fields
name

string

Required. The name of the connector to restart. Structured like: projects/{project}/locations/{location}/connectClusters/{connectCluster}/connectors/{connector}

RestartConnectorResponse

This type has no fields.

Response for RestartConnector.

ResumeConnectorRequest

Request for ResumeConnector.

Fields
name

string

Required. The name of the connector to pause. Structured like: projects/{project}/locations/{location}/connectClusters/{connectCluster}/connectors/{connector}

ResumeConnectorResponse

This type has no fields.

Response for ResumeConnector.

StopConnectorRequest

Request for StopConnector.

Fields
name

string

Required. The name of the connector to stop. Structured like: projects/{project}/locations/{location}/connectClusters/{connectCluster}/connectors/{connector}

StopConnectorResponse

This type has no fields.

Response for StopConnector.

TaskRetryPolicy

Task Retry Policy is implemented on a best-effort basis. Retry delay will be exponential based on provided minimum and maximum backoffs. https://en.wikipedia.org/wiki/Exponential_backoff. Note that the delay between consecutive task restarts may not always precisely match the configured settings. This can happen when the ConnectCluster is in rebalancing state or if the ConnectCluster is unresponsive etc. The default values for minimum and maximum backoffs are 60 seconds and 30 minutes respectively.

Fields
minimum_backoff

Duration

Optional. The minimum amount of time to wait before retrying a failed task. This sets a lower bound for the backoff delay.
maximum_backoff

Duration

Optional. The maximum amount of time to wait before retrying a failed task. This sets an upper bound for the backoff delay.

Topic

A Kafka topic in a given cluster.

Fields
name

string

Identifier. The name of the topic. The topic segment is used when connecting directly to the cluster. Structured like: projects/{project}/locations/{location}/clusters/{cluster}/topics/{topic}
partition_count

int32

Required. The number of partitions this topic has. The partition count can only be increased, not decreased. Please note that if partitions are increased for a topic that has a key, the partitioning logic or the ordering of the messages will be affected.
replication_factor

int32

Required. Immutable. The number of replicas of each partition. A replication factor of 3 is recommended for high availability.
configs

map<string, string>

Optional. Configurations for the topic that are overridden from the cluster defaults. The key of the map is a Kafka topic property name, for example: cleanup.policy, compression.type.

UpdateClusterRequest

Request for UpdateCluster.

Fields
update_mask

FieldMask

Required. Field mask is used to specify the fields to be overwritten in the cluster resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. The mask is required and a value of * will update all fields.
cluster

Cluster

Required. The cluster to update. Its name field must be populated.
request_id

string

Optional. An optional request ID to identify requests. Specify a unique request ID to avoid duplication of requests. If a request times out or fails, retrying with the same ID allows the server to recognize the previous attempt. For at least 60 minutes, the server ignores duplicate requests bearing the same ID.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID within 60 minutes of the last request, the server checks if an original operation with the same request ID was received. If so, the server ignores the second request.

The request ID must be a valid UUID. A zero UUID is not supported (00000000-0000-0000-0000-000000000000).

UpdateConnectClusterRequest

Request for UpdateConnectCluster.

Fields
update_mask

FieldMask

Required. Field mask is used to specify the fields to be overwritten in the cluster resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. The mask is required and a value of * will update all fields.
connect_cluster

ConnectCluster

Required. The Kafka Connect cluster to update. Its name field must be populated.
request_id

string

Optional. An optional request ID to identify requests. Specify a unique request ID to avoid duplication of requests. If a request times out or fails, retrying with the same ID allows the server to recognize the previous attempt. For at least 60 minutes, the server ignores duplicate requests bearing the same ID.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID within 60 minutes of the last request, the server checks if an original operation with the same request ID was received. If so, the server ignores the second request.

The request ID must be a valid UUID. A zero UUID is not supported (00000000-0000-0000-0000-000000000000).

UpdateConnectorRequest

Request for UpdateConnector.

Fields
update_mask

FieldMask

Required. Field mask is used to specify the fields to be overwritten in the cluster resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. The mask is required and a value of * will update all fields.
connector

Connector

Required. The connector to update. Its name field must be populated.

UpdateConsumerGroupRequest

Request for UpdateConsumerGroup.

Fields
update_mask

FieldMask

Required. Field mask is used to specify the fields to be overwritten in the ConsumerGroup resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. The mask is required and a value of * will update all fields.
consumer_group

ConsumerGroup

Required. The consumer group to update. Its name field must be populated.

UpdateTopicRequest

Request for UpdateTopic.

Fields
update_mask

FieldMask

Required. Field mask is used to specify the fields to be overwritten in the Topic resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. The mask is required and a value of * will update all fields.
topic

Topic

Required. The topic to update. Its name field must be populated.