.. _zendesk_source_connector_config: ================================================= Zendesk Source Connector 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.zendesk.ZendeskSourceConnector Connector-specific configuration properties are described below. Zendesk ^^^^^^^ ``zendesk.url`` Service URL. * Type: string * Valid Values: URI with one of these schemes: 'http', 'https' * Importance: high ``zendesk.tables`` The Zendesk tables that are to be exported and written to Kafka. To create a reasonable load balance between workers, the tables can be ordered by their expected size or throughput. * Type: list * Valid Values: one of [custom_roles, groups, group_memberships, organizations, organization_subscriptions, organization_memberships, satisfaction_ratings, tickets, ticket_audits, ticket_fields, ticket_metrics, users] * Importance: high ``zendesk.since`` Rows updated after this time will be processed by the connector. If left blank, the default time will be set to the time this connector is launched minus 1 minute. The value should be formatted as ISO 8601. Example format ``yyyy-MM-dd'T'HH:mm:SS``. * Type: string * Default: "" * Valid Values: either blank, or timestamp in one of these formats: ``yyyy-MM-dd``, ``yyyy-MM-dd'T'HH:mm:SS``, ``yyyy-'W'w-6EX``, ``yyyy-MM-dd'T'HH:mm:SSV``. Example have a value of ``2020-02-01``, if connector should only export data updated after 1st February, 2020 and ignore all those before. * Importance: medium Topics ^^^^^^ ``topic.name.pattern`` The pattern to use for the topic name, where the ``${entityName}`` literal will be replaced with each entity name (Zendesk table name). Example a value such as ``zendesk_topic_${entityName}`` with tables ``tickets`` and ``users`` would create 2 topics ``zendesk_topic_tickets`` and ``zendesk_topic_users`` and ensure that table ``tickets`` is exported to topic ``zendesk_topic_tickets``, etc. * Type: string * Default: ${entityName} * Importance: high Limits ^^^^^^ ``max.batch.size`` The maximum number of records that should be returned and written to Kafka at once. * Type: int * Default: 100 * Valid Values: [1,...,2147483647] * Importance: high ``max.in.flight.requests`` The maximum number of requests that may be in-flight at once. * Type: int * Default: 10 * Valid Values: [1,...,200] * Importance: high ``max.poll.interval.ms`` The time in milliseconds to wait while polling for a full batch of records. * Type: long * Default: 100 * Valid Values: [1,...,300000] * Importance: medium ``request.interval.ms`` The time in milliseconds to wait before checking for updated records. * Type: long * Default: 15000 * Valid Values: [1,...,2147483647] * Importance: medium Retries ^^^^^^^ ``max.retries`` The maximum number of times to retry on errors before failing the task. * Type: int * Default: 10 * Valid Values: [0,...,2147483647] * Importance: medium ``retry.backoff.ms`` The time in milliseconds to wait following an error before a retry attempt is made. * Type: int * Default: 3000 * Valid Values: [0,...,2147483647] * Importance: medium Authorization ^^^^^^^^^^^^^ ``zendesk.auth.type`` Authentication type of the endpoint. Valid values are ``none``, ``basic``, ``oauth2``, ``bearer`` (Client Credentials grant type only). * Type: string * Default: none * Valid Values: one of [bearer, none, basic, oauth2] * Importance: high * Dependents: ``bearer.token``, ``oauth2.token.url``, ``oauth2.client.id``, ``oauth2.client.secret``, ``oauth2.token.property``, ``oauth2.client.mode``, ``oauth2.client.scope``, ``zendesk.password``, ``zendesk.user`` ``zendesk.user`` The username to be used with an endpoint requiring authentication. * Type: string * Default: "" * Importance: high ``zendesk.password`` The password to be used with an endpoint requiring authentication. * Type: password * Default: [hidden] * Importance: high ``bearer.token`` The bearer authentication token to be used when ``auth.type=bearer``. The supplied token will be used as the value of ``Authorization`` header in HTTP requests. * Type: password * Default: [hidden] * Importance: high ``oauth2.token.url`` The URL to be used for fetching OAUTH2 token. Client Credentials is the only supported grant type. * Type: string * Default: "" * Valid Values: either blank or null, or URI with one of these schemes: 'http', 'https' * Importance: high ``oauth2.client.id`` The client id used when fetching OAuth2 token * Type: string * Default: "" * Importance: high ``oauth2.client.secret`` The secret used when fetching OAuth2 token * Type: password * Default: [hidden] * Importance: high ``oauth2.token.property`` The name of the property containing the OAuth2 token returned by the http proxy. Default value is ``access_token``. * Type: string * Default: access_token * Importance: high ``oauth2.client.mode`` Specifies how to encode ``client_id`` and ``client_secret`` in the OAuth2 authorization request. If set to ``header``, the credentials are encoded as an ``'Authorization: Basic '`` HTTP header. If set to 'url', then ``client_id`` and ``client_secret`` are sent as URL encoded parameters. * Type: string * Default: header * Valid Values: one of [header, url] * Importance: low ``oauth2.client.scope`` The scope parameter sent to the service when fetching OAuth2 token. * Type: string * Default: any * Importance: low Proxy ^^^^^ ``http.proxy.host`` The host or ip of the http proxy. * Type: string * Default: "" * Importance: high ``http.proxy.port`` The port number of the http proxy. * Type: int * Default: 0 * Valid Values: [0,...,65535] * Importance: high ``http.proxy.user`` The username to be used when authenticating with the http proxy. * Type: string * Default: "" * Importance: high ``http.proxy.password`` The password to be used when authenticating with the http proxy. * Type: password * Default: [hidden] * Importance: high .. _zendesk-source-connector-license-config: |cp| license ^^^^^^^^^^^^ ``confluent.license`` Confluent will issue a license key to each subscriber. The license key will be a short snippet of text that you can copy and paste. Without the license key, you can use the connector for a 30-day trial period. If you are a subscriber, please contact Confluent Support for more information. * Type: string * Default: "" * Valid Values: Confluent Platform license * Importance: high ``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 ``host1:port1,host2:port2,...``. These servers are used only for the initial connection to discover the full cluster membership, which may change dynamically, so this list need not contain the full set of servers. You may want more than one, 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 .. _zendesk_source_license-topic-configuration: .. include:: ../includes/platform-license-detail.rst .. include:: ../includes/platform-license-acl.rst .. include:: ../includes/overriding-default-config-properties.rst