.. _gcp-functions-sink-connector_config:

========================
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.

.. include:: ../includes/reporter-configs.rst

.. _gcp-functions-sink-connector-license-config:

|cp| 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
----------------------------

.. include:: ../includes/security-info.rst

.. include:: ../includes/platform-license.rst

.. include:: ../includes/security-configs.rst

.. _gcp_functions_sink_license-topic-configuration:

.. include:: ../includes/platform-license-detail.rst

.. include:: ../includes/overriding-default-config-properties.rst