.. _pubsub-source-connector-config:

Configuration Properties
------------------------

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

.. codewithvars:: properties

    connector.class=io.confluent.connect.gcp.pubsub.PubSubSourceConnector

Connector-specific configuration properties are described below.

PubSub
^^^^^^

``kafka.topic``
  The |ak-tm| topic to publish data to. Only a single topic must be specified. Records from Pub/Sub subscriptions will be published to this topic.

  * Type: string
  * Importance: high
  
``gcp.pubsub.project.id``
  The Pub/Sub project from which data is to be subscribed. 

  * Type: string
  * Importance: high

``gcp.pubsub.topic.id``
  The Pub/Sub topic containing messages that have to be polled. 

  * Type: string
  * Importance: high

``gcp.pubsub.subscription.id``
  The Pub/Sub subscription Id for the Pub/Sub topic. 

  * Type: string
  * Importance: high

``gcp.pubsub.credentials.path``
  Path to the ``private key credentials file`` from GCP console.

  * Type: string
  * Importance: high

``gcp.pubsub.message.max.count``
  The maximum number of messages to be polled in a single Pub/Sub pull request. 

  * Type: int
  * Default: 10000
  * Importance: medium
  
``gcp.pubsub.max.retry.time``
  The maximum time upto which Pub/Sub client will try polling records from Pub/Sub topic.
  
  * Type: int
  * Default: 5
  * Importance: Low

.. _gcp-pubsub-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-pubsub-license-topic-configuration:

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

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