blob: d3227b9f0c9f5f3866330275ed6a164e5fdfe665 [file] [log] [blame]
// kafka-connector options: START
[[camel-google-pubsub-kafka-connector-source]]
= camel-google-pubsub-kafka-connector source configuration
When using camel-google-pubsub-kafka-connector as source make sure to use the following Maven dependency to have support for the connector:
[source,xml]
----
<dependency>
<groupId>org.apache.camel.kafkaconnector</groupId>
<artifactId>camel-google-pubsub-kafka-connector</artifactId>
<version>x.x.x</version>
<!-- use the same version as your Camel Kafka connector version -->
</dependency>
----
The camel-google-pubsub source connector supports 15 options, which are listed below.
[width="100%",cols="2,5,^1,2",options="header"]
|===
| Name | Description | Default | Priority
| *camel.source.path.projectId* | Project Id | null | ConfigDef.Importance.HIGH
| *camel.source.path.destinationName* | Destination Name | null | ConfigDef.Importance.HIGH
| *camel.source.endpoint.ackMode* | AUTO = exchange gets ack'ed/nack'ed on completion. NONE = downstream process has to ack/nack explicitly One of: [AUTO] [NONE] | "AUTO" | ConfigDef.Importance.MEDIUM
| *camel.source.endpoint.concurrentConsumers* | The number of parallel streams consuming from the subscription | "1" | ConfigDef.Importance.MEDIUM
| *camel.source.endpoint.connectionFactory* | ConnectionFactory to obtain connection to PubSub Service. If non provided the default one will be used | null | ConfigDef.Importance.MEDIUM
| *camel.source.endpoint.loggerId* | Logger ID to use when a match to the parent route required | null | ConfigDef.Importance.MEDIUM
| *camel.source.endpoint.maxMessagesPerPoll* | The max number of messages to receive from the server in a single API call | "1" | ConfigDef.Importance.MEDIUM
| *camel.source.endpoint.bridgeErrorHandler* | Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions occurred while the consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions, that will be logged at WARN or ERROR level and ignored. | false | ConfigDef.Importance.MEDIUM
| *camel.source.endpoint.exceptionHandler* | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this option is not in use. By default the consumer will deal with exceptions, that will be logged at WARN or ERROR level and ignored. | null | ConfigDef.Importance.MEDIUM
| *camel.source.endpoint.exchangePattern* | Sets the exchange pattern when the consumer creates an exchange. One of: [InOnly] [InOut] [InOptionalOut] | null | ConfigDef.Importance.MEDIUM
| *camel.source.endpoint.basicPropertyBinding* | Whether the endpoint should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities | false | ConfigDef.Importance.MEDIUM
| *camel.source.endpoint.synchronous* | Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported). | false | ConfigDef.Importance.MEDIUM
| *camel.component.google-pubsub.connectionFactory* | Sets the connection factory to use: provides the ability to explicitly manage connection credentials: - the path to the key file - the Service Account Key / Email pair | null | ConfigDef.Importance.MEDIUM
| *camel.component.google-pubsub.bridgeErrorHandler* | Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions occurred while the consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions, that will be logged at WARN or ERROR level and ignored. | false | ConfigDef.Importance.MEDIUM
| *camel.component.google-pubsub.basicPropertyBinding* | Whether the component should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities | false | ConfigDef.Importance.MEDIUM
|===
// kafka-connector options: END