Managed Service for Apache Kafka® API, gRPC: ConnectorService.List

Field

Description

cluster_id

string

Required field. ID of the Apache Kafka® cluster to list connectors in.

To get this ID, make a ClusterService.List request.

page_size

int64

The maximum number of results per page to return.

If the number of available results is larger than page_size, the API returns a ListConnectorsResponse.next_page_token that can be used to get the next page of results in the subsequent ConnectorService.List requests.

page_token

string

Page token that can be used to iterate through multiple pages of results.

To get the next page of results, set page_token to the ListConnectorsResponse.next_page_token returned by the previous ConnectorService.List request.

Field

Description

connectors[]

Connector

List of Apache Kafka® Connectors.

next_page_token

string

The token that can be used to get the next page of results.

If the number of results is larger than ListConnectorsRequest.page_size, use the next_page_token as the value for the ListConnectorsRequest.page_token in the subsequent ConnectorService.List request to iterate through multiple pages of results.

Field

Description

name

string

Name of the connector.

tasks_max

google.protobuf.Int64Value

Maximum number of connector tasks. Default value is the number of brokers.

properties

object (map<string, string>)

A set of properties passed to Managed Service for Apache Kafka® with the connector configuration.
Example: sync.topics.config.enabled: true.

health

enum Health

Connector health.

• HEALTH_UNKNOWN: Health of the connector is unknown.
• ALIVE: Connector is running.
• DEAD: Connector has failed to start.

status

enum Status

Current status of the connector.

• STATUS_UNKNOWN: Connector state is unknown.
• RUNNING: Connector is running normally.
• ERROR: Connector has encountered a problem and cannot operate.
• PAUSED: Connector is paused.

cluster_id

string

ID of the Apache Kafka® cluster that the connector belongs to.

connector_config_mirrormaker

ConnectorConfigMirrorMaker

Configuration of the MirrorMaker connector.

Includes only one of the fields connector_config_mirrormaker, connector_config_s3_sink.

Additional settings for the connector.

connector_config_s3_sink

ConnectorConfigS3Sink

Configuration of S3-Sink connector.

Includes only one of the fields connector_config_mirrormaker, connector_config_s3_sink.

Additional settings for the connector.

Field

Description

source_cluster

ClusterConnection

Source cluster connection configuration.

target_cluster

ClusterConnection

Target cluster connection configuration.

topics

string

List of Kafka topics, separated by ,.

replication_factor

google.protobuf.Int64Value

Replication factor for automatically created topics.

Field

Description

alias

string

Alias of cluster connection configuration.
Examples: source, target.

this_cluster

ThisCluster

Connection configuration of the cluster the connector belongs to. As all credentials are already known, leave this parameter empty.

Includes only one of the fields this_cluster, external_cluster.

Type of connection to Apache Kafka® cluster.

external_cluster

ExternalClusterConnection

Configuration of connection to an external cluster with all the necessary credentials.

Includes only one of the fields this_cluster, external_cluster.

Type of connection to Apache Kafka® cluster.

Field

Description

Empty

Field

Description

bootstrap_servers

string

List of bootstrap servers of the cluster, separated by ,.

sasl_username

string

SASL username to use for connection to the cluster.

sasl_mechanism

string

SASL mechanism to use for connection to the cluster.

security_protocol

string

Security protocol to use for connection to the cluster.

Field

Description

topics

string

List of Kafka topics, separated by ','.

file_compression_type

string

The compression type used for files put on GCS.
The supported values are: gzip, snappy, zstd, none.
Optional, the default is none.

file_max_records

google.protobuf.Int64Value

Max records per file.

s3_connection

S3Connection

Credentials for connecting to S3 storage.

Field

Description

bucket_name

string

external_s3

ExternalS3Storage

Includes only one of the fields external_s3.

Field

Description

access_key_id

string

endpoint

string

region

string

Default is 'us-east-1'