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

Field

Description

cluster_id

string

Required field. ID of the Apache Kafka® cluster to update the connector in.
To get this ID, make a ClusterService.List request.

The maximum string length in characters is 50.

connector_name

string

Required field. Name of the connector to update.
To get this name, make a ConnectorService.List request.

The maximum string length in characters is 256. Value must match the regular expression [-_.a-zA-Z0-9]*.

update_mask

google.protobuf.FieldMask

Field mask that specifies which settings of the connector should be updated.

connector_spec

UpdateConnectorSpec

Required field. Configuration of the connector to update.

Field

Description

tasks_max

google.protobuf.Int64Value

Maximum number of connector tasks to update.

properties

object (map<string, string>)

A set of new or changed properties to update for the connector. They are passed with the connector configuration to Managed Service for Apache Kafka®.
Example: sync.topics.config.enabled: false.

connector_config_mirrormaker

ConnectorConfigMirrorMakerSpec

Configuration of the MirrorMaker connector.

Includes only one of the fields connector_config_mirrormaker, connector_config_s3_sink, connector_config_iceberg_sink.

Updated configuration for the connector.

connector_config_s3_sink

UpdateConnectorConfigS3SinkSpec

Update specification for S3-Sink Connector.

Includes only one of the fields connector_config_mirrormaker, connector_config_s3_sink, connector_config_iceberg_sink.

Updated configuration for the connector.

connector_config_iceberg_sink

UpdateConnectorConfigIcebergSinkSpec

Update specification for Iceberg Sink Connector.

Includes only one of the fields connector_config_mirrormaker, connector_config_s3_sink, connector_config_iceberg_sink.

Updated configuration for the connector.

Field

Description

source_cluster

ClusterConnectionSpec

Source cluster configuration for the MirrorMaker connector.

target_cluster

ClusterConnectionSpec

Target cluster configuration for the MirrorMaker connector.

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

ThisClusterSpec

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

ExternalClusterConnectionSpec

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_password

string

SASL password 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.

ssl_truststore_certificates

string

CA in PEM format to connect to external cluster.
Lines of certificate separated by '\n' symbol.

Field

Description

topics

string

List of Kafka topics, separated by ','.

file_max_records

google.protobuf.Int64Value

Max records per file.

s3_connection

S3ConnectionSpec

Credentials for connecting to S3 storage.

Field

Description

bucket_name

string

Name of the bucket.

external_s3

ExternalS3StorageSpec

Configuration for connection to S3 storage.

Includes only one of the fields external_s3.

Field

Description

access_key_id

string

ID of the AWS access key.

secret_access_key

string

Secret access key for the AWS access key.

endpoint

string

S3 endpoint.

region

string

AWS region. Default is 'us-east-1'.

Field

Description

topics

string

List of Kafka topics, separated by ','.

Includes only one of the fields topics, topics_regex.

topics_regex

string

Regex of Kafka topics.

Includes only one of the fields topics, topics_regex.

control_topic

string

Control topic name for Iceberg connector.

metastore_connection

MetastoreConnectionSpec

Credentials for connecting to Managed Hive Metastore.

s3_connection

IcebergS3ConnectionSpec

Credentials for connecting to S3 storage.

tables_config

IcebergTablesConfigSpec

Optional table settings

control_config

IcebergControlSpec

Optional control settings

Field

Description

catalog_uri

string

Thrift URI of Hive Metastore
Format: "thrift://host:9083"

warehouse

string

Warehouse root directory in S3
Format: "s3a://bucket-name/path/to/warehouse"
Can be any path within the bucket, not necessarily "/warehouse"

Field

Description

external_s3

ExternalIcebergS3StorageSpec

Configuration for connection to S3 storage.

Includes only one of the fields external_s3.

Field

Description

access_key_id

string

ID of the AWS access key.

secret_access_key

string

Secret access key for the AWS access key.

endpoint

string

S3 endpoint.

region

string

AWS region. Default is 'us-east-1'.

Field

Description

default_commit_branch

string

Default Git-like branch name for Iceberg commits.
Default: "main"

default_id_columns

string

List of columns used as identifiers for upsert operations, separated by ','.

default_partition_by

string

Comma-separated list of columns or transform expressions for table partitioning.
Defines physical data layout for query optimization.
Examples:

• "date"
• "year,month"
• "year(timestamp),month(timestamp)"
• "days(timestamp)"
• "bucket(16,user_id)"

evolve_schema_enabled

bool

Enable automatic schema evolution.
Default: false

schema_force_optional

bool

Force all columns to be nullable (optional).
Default: false

schema_case_insensitive

bool

Enable case-insensitive field name matching.
Default: false

Field

Description

group_id_prefix

string

Consumer group ID prefix for control topic.
Default: "cg-control"

commit_interval_ms

google.protobuf.Int64Value

Interval between commits in milliseconds.
Default: 300000 (5 minutes)

commit_timeout_ms

google.protobuf.Int64Value

Commit operation timeout in milliseconds.
Default: 30000 (30 seconds)

commit_threads

google.protobuf.Int64Value

Number of threads for commit operations.
Default: cores * 2

transactional_prefix

string

Prefix for transactional operations.
Default: ""

Field

Description

id

string

ID of the operation.

description

string

Description of the operation. 0-256 characters long.

created_at

google.protobuf.Timestamp

Creation timestamp.

created_by

string

ID of the user or service account who initiated the operation.

modified_at

google.protobuf.Timestamp

The time when the Operation resource was last modified.

done

bool

If the value is false, it means the operation is still in progress.
If true, the operation is completed, and either error or response is available.

metadata

google.protobuf.Any

Service-specific metadata associated with the operation.
It typically contains the ID of the target resource that the operation is performed on.
Any method that returns a long-running operation should document the metadata type, if any.

error

google.rpc.Status

The error result of the operation in case of failure or cancellation.

Includes only one of the fields error, response.

The operation result.
If done == false and there was no failure detected, neither error nor response is set.
If done == false and there was a failure detected, error is set.
If done == true, exactly one of error or response is set.

response

google.protobuf.Any

The normal response of the operation in case of success.
If the original method returns no data on success, such as Delete,
the response is google.protobuf.Empty.
If the original method is the standard Create/Update,
the response should be the target resource of the operation.
Any method that returns a long-running operation should document the response type, if any.

Includes only one of the fields error, response.

The operation result.
If done == false and there was no failure detected, neither error nor response is set.
If done == false and there was a failure detected, error is set.
If done == true, exactly one of error or response is set.