Skip to content

Sink connector configuration properties

The Events sink connector is used to publish messages from a Kafka topic into Event Service. Sink connectors are configured with specific properties to define the connection details, data formats, transformations, and other parameters required for the data transfer. You specify these properties in a configuration file.

The following required parameters are specific to the sink connector:

NameDescription
topics
The comma-separated list of the source topics. Note the number of topic definitions must match the number of event definitions.
connector.class
com.trimble.tcp.events.kafka.connect.EventsServiceSinkConnector
task.max
The number of connector instances. For a sink connector, the number of tasks must be less or equal to the Kafka topic partitions..
app.secret
The consumer or publisher application identifier. You can fetch this value from the Trimble Cloud Console.
app.name
The consumer or publisher application name. You can fetch this value from the Trimble Cloud Console.
events
A comma-separated list of the published or subscribed events. The format of each entry is [namespace]-[name]-[version], e.g. com.trimble.tcp.profiles-profiles-v2.0. For details on Namespace, name and version, see Available Events.{:target=“_blank”}

The following required parameters are specific to the sink connectors deployed on Confluent Kafka Connect:

NameDescription
kafka.auth.mode
The mode that authorizes the connector to Kafka. See the Confluent documentation for more information.
kafka.api.key
The API key used for authorizing the connector to Kafka. See the Confluent documentation for more information.
kafka.api.secret
The API secret used for authorizing the connector to Kafka. See the Confluent documentation for more information.
confluent.custom.plugin.id
The lugin identifier provided by Confluent after uploading the connector package. See the Confluent documentation for more information.
confluent.connection.endpoints
The consumer or publisher application name. You can fetch this value from the Trimble Cloud Console.
events
A List of allowed endpoints used by Confluent to limit the traffic from the connector. Use the following value:: id.trimble.com:443:TCP;preprd-events-ws-publisher.events.trimblecloud.com:443:TCP;events-ws-publisher.events.trimblecloud.com:443:TCP.

The following optional parameters are specific to the sink connector:

NameDescription
env
The event environment. The supported values are dev, stage and prod. The default value is prod.
connection.timeout
The connection timeout to the Events Service in milliseconds. The default value is 60000ms.
connection.retries
The number of connection retries to the Events Service. The default value is 10.
copy.queue.size
The maximum queue size for copying data between systems. This setting limits the amount of data buffered internally in the connector. The default value is 16000.
publish.tps
The maximum number of publish request per second. The default value is 10.