blob: 36ab37f4867f374052617e70de2f8b41f2fb33f9 [file] [log] [blame]
// kafka-connector options: START
[[camel-grpc-kafka-connector-source]]
= camel-grpc-kafka-connector source configuration
When using camel-grpc-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-grpc-kafka-connector</artifactId>
<version>x.x.x</version>
<!-- use the same version as your Camel Kafka connector version -->
</dependency>
----
The camel-grpc source connector supports 27 options, which are listed below.
[width="100%",cols="2,5,^1,2",options="header"]
|===
| Name | Description | Default | Priority
| *camel.source.path.host* | The gRPC server host name. This is localhost or 0.0.0.0 when being a consumer or remote server host name when using producer. | null | ConfigDef.Importance.HIGH
| *camel.source.path.port* | The gRPC local or remote server port | null | ConfigDef.Importance.HIGH
| *camel.source.path.service* | Fully qualified service name from the protocol buffer descriptor file (package dot service definition name) | null | ConfigDef.Importance.HIGH
| *camel.source.endpoint.flow ControlWindow* | The HTTP/2 flow control window size (MiB) | 1048576 | ConfigDef.Importance.MEDIUM
| *camel.source.endpoint.max MessageSize* | The maximum message size allowed to be received/sent (MiB) | 4194304 | ConfigDef.Importance.MEDIUM
| *camel.source.endpoint.bridge ErrorHandler* | 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.consumer Strategy* | This option specifies the top-level strategy for processing service requests and responses in streaming mode. If an aggregation strategy is selected, all requests will be accumulated in the list, then transferred to the flow, and the accumulated responses will be sent to the sender. If a propagation strategy is selected, request is sent to the stream, and the response will be immediately sent back to the sender. One of: [AGGREGATION] [PROPAGATION] | "PROPAGATION" | ConfigDef.Importance.MEDIUM
| *camel.source.endpoint.forward OnCompleted* | Determines if onCompleted events should be pushed to the Camel route. | false | ConfigDef.Importance.MEDIUM
| *camel.source.endpoint.forward OnError* | Determines if onError events should be pushed to the Camel route. Exceptions will be set as message body. | false | ConfigDef.Importance.MEDIUM
| *camel.source.endpoint.max ConcurrentCallsPerConnection* | The maximum number of concurrent calls permitted for each incoming server connection | 2147483647 | ConfigDef.Importance.MEDIUM
| * camel.source.endpoint.exception Handler* | 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.exchange Pattern* | Sets the exchange pattern when the consumer creates an exchange. One of: [InOnly] [InOut] [InOptionalOut] | null | ConfigDef.Importance.MEDIUM
| *camel.source.endpoint.basic PropertyBinding* | 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.source.endpoint.authentication Type* | Authentication method type in advance to the SSL/TLS negotiation One of: [NONE] [GOOGLE] [JWT] | "NONE" | ConfigDef.Importance.MEDIUM
| *camel.source.endpoint.jwt Algorithm* | JSON Web Token sign algorithm One of: [HMAC256] [HMAC384] [HMAC512] | "HMAC256" | ConfigDef.Importance.MEDIUM
| *camel.source.endpoint.jwt Issuer* | JSON Web Token issuer | null | ConfigDef.Importance.MEDIUM
| *camel.source.endpoint.jwt Secret* | JSON Web Token secret | null | ConfigDef.Importance.MEDIUM
| *camel.source.endpoint.jwt Subject* | JSON Web Token subject | null | ConfigDef.Importance.MEDIUM
| *camel.source.endpoint.keyCert ChainResource* | The X.509 certificate chain file resource in PEM format link | null | ConfigDef.Importance.MEDIUM
| *camel.source.endpoint.key Password* | The PKCS#8 private key file password | null | ConfigDef.Importance.MEDIUM
| *camel.source.endpoint.key Resource* | The PKCS#8 private key file resource in PEM format link | null | ConfigDef.Importance.MEDIUM
| * camel.source.endpoint.negotiation Type* | Identifies the security negotiation type used for HTTP/2 communication One of: [TLS] [PLAINTEXT_UPGRADE] [PLAINTEXT] | "PLAINTEXT" | ConfigDef.Importance.MEDIUM
| *camel.source.endpoint.service AccountResource* | Service Account key file in JSON format resource link supported by the Google Cloud SDK | null | ConfigDef.Importance.MEDIUM
| *camel.source.endpoint.trust CertCollectionResource* | The trusted certificates collection file resource in PEM format for verifying the remote endpoint's certificate | null | ConfigDef.Importance.MEDIUM
| *camel.component.grpc.bridge ErrorHandler* | 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.grpc.basic PropertyBinding* | 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