Important

You are viewing documentation for an older version of Confluent Platform. For the latest, click here.

Configuration Properties

To use this connector, specify the name of the connector class in the connector.class configuration property.

connector.class=io.confluent.connect.gcp.GoogleCloudFunctionsSinkConnector

Connector-specific configuration properties are described below.

Connector

behavior.on.error

How to handle cloud function responses that return an error, like HTTP 404. All codes above 400 are considered to be an error.

  • Type: string
  • Default: fail
  • Valid Values: [ignore, log, fail]
  • Importance: low
function.name

The name of the target cloud function.

  • Type: string
  • Importance: high
project.id

The project ID that the target cloud function belongs to.

  • Type: string
  • Importance: high
region

The region where the target cloud function is hosted.

  • Type: string
  • Importance: high

Connection

max.batch.size

The maximum number of records batched and sent per a single request.

  • Type: int
  • Default: 1
  • Valid Values: [1, …]
  • Importance: medium
max.pending.requests

The maximum number of pending requests that can be made to Google Cloud Functions concurrently.

  • Type: int
  • Default: 1
  • Valid Values: [1, …, 128]
  • Importance: medium
request.timeout.ms

The maximum time, in milliseconds, that the connector attempts to request Google Cloud Functions before timing out (socket timeout).

  • Type: int
  • Default: 5 minutes
  • Valid Values: [0, …]
  • Importance: low
retry.timeout.ms

The total amount of time, in milliseconds, that the connector will exponentially backoff and retry failed requests i.e on throttling. Response codes that are retried are HTTP 429 Too Busy and HTTP 502 Bad Gateway. A value of -1 indicates indefinite retrying.

  • Type: int
  • Default: 10 minutes
  • Valid Values: [-1, …]
  • Importance: low

Result Reporting

These configurations need to be provided with reporter. prefix.

These configurations are responsible for configuring how Sink Connectors write the responses from their Sinks to Kafka topics. Additionally, producer and admin properties can be provided by adding producer. and admin. as a prefix to the respective properties.

result.topic.name

The name of the topic to produce records to after successfully processing a sink record. Use ${connector} within the pattern to specify the current connector name. Leave blank to disable error reporting behavior.

  • Type: string
  • Default: ${connector}-success
  • Valid Values: either optionally includes substitutions(s): ${connector}, or After replacing ${connector}, this must be either Valid topic name (Matches regex [a-zA-Z0-9._-]{1,249}), or one of []
  • Importance: medium
result.topic.replication.factor

The replication factor of the result topic when it is automatically created by this connector. This determines how many broker failures can be tolerated before data loss cannot be prevented. This should be 1 in development environments, and ALWAYS at least 3 in production environments.

  • Type: short
  • Default: 3
  • Valid Values: [1,…]
  • Importance: medium
result.topic.partitions

The number of partitions in the result topic when it is automatically created by this connector. This is recommended to be the same as the number of input partitions in order to handle the potential throughput.

  • Type: int
  • Default: 1
  • Valid Values: [1,…]
  • Importance: medium
error.topic.name

The name of the topic to produce records to after each unsuccessfully sinking a record. Use ${connector} within the pattern to specify the current connector name. Leave blank to disable error reporting behavior.

  • Type: string
  • Default: ${connector}-error
  • Valid Values: either optionally includes substitutions(s): ${connector}, or After replacing ${connector}, this must be either Valid topic name (Matches regex [a-zA-Z0-9._-]{1,249}), or one of []
  • Importance: medium
error.topic.replication.factor

The replication factor of the error topic when it is automatically created by this connector. This determines how many broker failures can be tolerated before data loss cannot be prevented. This should be 1 in development environments, and ALWAYS at least 3 in production environments.

  • Type: short
  • Default: 3
  • Valid Values: [1,…]
  • Importance: medium
error.topic.partitions

The number of partitions in the error topic when it is automatically created by this connector. This is recommended to be the same as the number of input partitions in order to handle the potential throughput.

  • Type: int
  • Default: 1
  • Valid Values: [1,…]
  • Importance: medium
bootstrap.servers

A list of host/port pairs to use for establishing the initial connection to the Kafka cluster. The client will make use of all servers irrespective of which servers are specified here for bootstrapping; this list only impacts the initial hosts used to discover the full set of servers. This list should be in the form host1:port1,host2:port2,.... Since these servers are just used for the initial connection to discover the full cluster membership (which may change dynamically), this list need not contain the full set of servers (you may want more than one, though, in case a server is down).

  • Type: list
  • Valid Values: Non-empty list
  • Importance: high
result.topic.key.format

The format in which the result report key is serialized.

  • Type: string
  • Default: json
  • Valid Values: one of [json, string, avro, byte]
  • Importance: medium
result.topic.value.format

The format in which the result report value is serialized.

  • Type: string
  • Default: json
  • Valid Values: one of [json, string, avro, byte]
  • Importance: medium
error.topic.key.format

The format in which the error report key is serialized.

  • Type: string
  • Default: json
  • Valid Values: one of [json, string, avro, byte]
  • Importance: medium
error.topic.value.format

The format in which the error report value is serialized.

  • Type: string
  • Default: json
  • Valid Values: one of [json, string, avro, byte]
  • Importance: medium
result.topic.key.format.schemas.cache.size

The maximum number of schemas that can be cached in the JSON formatter.

  • Type: int
  • Default: 128
  • Valid Values: [0,…,2048]
  • Importance: medium
result.topic.key.format.schemas.enable

Include schemas within each of the serialized values and keys.

  • Type: boolean
  • Default: false
  • Importance: medium
result.topic.value.format.schemas.cache.size

The maximum number of schemas that can be cached in the JSON formatter.

  • Type: int
  • Default: 128
  • Valid Values: [0,…,2048]
  • Importance: medium
result.topic.value.format.schemas.enable

Include schemas within each of the serialized values and keys.

  • Type: boolean
  • Default: false
  • Importance: medium
error.topic.key.format.schemas.cache.size

The maximum number of schemas that can be cached in the JSON formatter.

  • Type: int
  • Default: 128
  • Valid Values: [0,…,2048]
  • Importance: medium
error.topic.key.format.schemas.enable

Include schemas within each of the serialized values and keys.

  • Type: boolean
  • Default: false
  • Importance: medium
error.topic.value.format.schemas.cache.size

The maximum number of schemas that can be cached in the JSON formatter.

  • Type: int
  • Default: 128
  • Valid Values: [0,…,2048]
  • Importance: medium
error.topic.value.format.schemas.enable

Include schemas within each of the serialized values and keys.

  • Type: boolean
  • Default: false
  • Importance: medium

Confluent Platform license

confluent.topic.bootstrap.servers A list of host/port pairs to use for establishing the initial connection to the Kafka cluster used for licensing. All servers in the cluster will be discovered from the initial connection. This list should be in the form <code>host1:port1,host2:port2,…</code>. Since these servers are just used for the initial connection to discover the full cluster membership (which may change dynamically), this list need not contain the full set of servers (you may want more than one, though, in case a server is down).

  • Type: list
  • Importance: high

confluent.topic Name of the Kafka topic used for Confluent Platform configuration, including licensing information.

  • Type: string
  • Default: _confluent-command
  • Importance: low

confluent.topic.replication.factor The replication factor for the Kafka topic used for Confluent Platform configuration, including licensing information. This is used only if the topic does not already exist, and the default of 3 is appropriate for production use. If you are using a development environment with less than 3 brokers, you must set this to the number of brokers (often 1).

  • Type: int
  • Default: 3
  • Importance: low

Confluent license properties

Note

This connector is proprietary and requires a license. The license information is stored in the _confluent-command topic. If the broker requires SSL for connections, you must include the security-related confluent.topic.* properties as described below.

confluent.license

Confluent issues enterprise license keys to each subscriber. The license key is text that you can copy and paste as the value for confluent.license. A trial license allows using the connector for a 30-day trial period. A developer license allows using the connector indefinitely for single-broker development environments.

If you are a subscriber, please contact Confluent Support for more information.

  • Type: string
  • Default: “”
  • Valid Values: Confluent Platform license
  • Importance: high
confluent.topic.ssl.truststore.location

The location of the trust store file.

  • Type: string
  • Default: null
  • Importance: high
confluent.topic.ssl.truststore.password

The password for the trust store file. If a password is not set access to the truststore is still available, but integrity checking is disabled.

  • Type: password
  • Default: null
  • Importance: high
confluent.topic.ssl.keystore.location

The location of the key store file. This is optional for client and can be used for two-way authentication for client.

  • Type: string
  • Default: null
  • Importance: high
confluent.topic.ssl.keystore.password

The store password for the key store file. This is optional for client and only needed if ssl.keystore.location is configured.

  • Type: password
  • Default: null
  • Importance: high
confluent.topic.ssl.key.password

The password of the private key in the key store file. This is optional for client.

  • Type: password
  • Default: null
  • Importance: high
confluent.topic.security.protocol

Protocol used to communicate with brokers. Valid values are: PLAINTEXT, SSL, SASL_PLAINTEXT, SASL_SSL.

  • Type: string
  • Default: “PLAINTEXT”
  • Importance: medium

License topic configuration

A Confluent enterprise license is stored in the _confluent-command topic. This topic is created by default and contains the license that corresponds to the license key supplied through the confluent.license property.

Note

No public keys are stored in Kafka topics.

The following describes how the default _confluent-command topic is generated under different scenarios:

  • A 30-day trial license is automatically generated for the _confluent command topic if you do not add the confluent.license property or leave this property empty (for example, confluent.license=).
  • Adding a valid license key (for example, confluent.license=<valid-license-key>) adds a valid license in the _confluent-command topic.

Here is an example of the minimal properties for development and testing.

You can change the name of the _confluent-command topic using the confluent.topic property (for instance, if your environment has strict naming conventions). The example below shows this change and the configured Kafka bootstrap server.

confluent.topic=foo_confluent-command
confluent.topic.bootstrap.servers=localhost:9092

The example above shows the minimally required bootstrap server property that you can use for development and testing. For a production environment, you add the normal producer, consumer, and topic configuration properties to the connector properties, prefixed with confluent.topic..

Overriding Default Configuration Properties

You can override the replication factor using confluent.topic.replication.factor. For example, when using an Kafka cluster as a destination with less than three brokers (for development and testing) you should set the confluent.topic.replication.factor property to 1.

You can override producer-specific properties by using the confluent.topic.producer. prefix and consumer-specific properties by using the confluent.topic.consumer. prefix.

You can use the defaults or customize the other properties as well. For example, the confluent.topic.client.id property defaults to the name of the connector with -licensing suffix. You can specify the configuration settings for brokers that require SSL or SASL for client connections using this prefix.

You cannot override the cleanup policy of a topic because the topic always has a single partition and is compacted. Also, do not specify serializers and deserializers using this prefix; they are ignored if added.