Interface GooglePubsubComponentBuilderFactory.GooglePubsubComponentBuilder
- All Superinterfaces:
ComponentBuilder<org.apache.camel.component.google.pubsub.GooglePubsubComponent>
- All Known Implementing Classes:
GooglePubsubComponentBuilderFactory.GooglePubsubComponentBuilderImpl
- Enclosing interface:
- GooglePubsubComponentBuilderFactory
public static interface GooglePubsubComponentBuilderFactory.GooglePubsubComponentBuilder
extends ComponentBuilder<org.apache.camel.component.google.pubsub.GooglePubsubComponent>
Builder for the Google Pubsub component.
-
Method Summary
Modifier and TypeMethodDescriptionauthenticate
(boolean authenticate) Use Credentials when interacting with PubSub service (no authentication is required when using emulator).autowiredEnabled
(boolean autowiredEnabled) Whether autowiring is enabled.bridgeErrorHandler
(boolean 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.Endpoint to use with local Pub/Sub emulator.lazyStartProducer
(boolean lazyStartProducer) Whether the producer should be started lazy (on the first message).publisherCacheSize
(int publisherCacheSize) Maximum number of producers to cache.publisherCacheTimeout
(int publisherCacheTimeout) How many milliseconds should each producer stay alive in the cache.publisherTerminationTimeout
(int publisherTerminationTimeout) How many milliseconds should a producer be allowed to terminate.serviceAccountKey
(String serviceAccountKey) The Service account key that can be used as credentials for the PubSub publisher/subscriber.synchronousPullRetryableCodes
(String synchronousPullRetryableCodes) Comma-separated list of additional retryable error codes for synchronous pull.Methods inherited from interface org.apache.camel.builder.component.ComponentBuilder
build, build, doSetProperty, register
-
Method Details
-
authenticate
default GooglePubsubComponentBuilderFactory.GooglePubsubComponentBuilder authenticate(boolean authenticate) Use Credentials when interacting with PubSub service (no authentication is required when using emulator). The option is a: <code>boolean</code> type. Default: true Group: common- Parameters:
authenticate
- the value to set- Returns:
- the dsl builder
-
endpoint
Endpoint to use with local Pub/Sub emulator. The option is a: <code>java.lang.String</code> type. Group: common- Parameters:
endpoint
- the value to set- Returns:
- the dsl builder
-
serviceAccountKey
default GooglePubsubComponentBuilderFactory.GooglePubsubComponentBuilder serviceAccountKey(String serviceAccountKey) The Service account key that can be used as credentials for the PubSub publisher/subscriber. It can be loaded by default from classpath, but you can prefix with classpath:, file:, or http: to load the resource from different systems. The option is a: <code>java.lang.String</code> type. Group: common- Parameters:
serviceAccountKey
- the value to set- Returns:
- the dsl builder
-
bridgeErrorHandler
default GooglePubsubComponentBuilderFactory.GooglePubsubComponentBuilder bridgeErrorHandler(boolean 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. The option is a: <code>boolean</code> type. Default: false Group: consumer- Parameters:
bridgeErrorHandler
- the value to set- Returns:
- the dsl builder
-
synchronousPullRetryableCodes
default GooglePubsubComponentBuilderFactory.GooglePubsubComponentBuilder synchronousPullRetryableCodes(String synchronousPullRetryableCodes) Comma-separated list of additional retryable error codes for synchronous pull. By default the PubSub client library retries ABORTED, UNAVAILABLE, UNKNOWN. The option is a: <code>java.lang.String</code> type. Group: consumer- Parameters:
synchronousPullRetryableCodes
- the value to set- Returns:
- the dsl builder
-
lazyStartProducer
default GooglePubsubComponentBuilderFactory.GooglePubsubComponentBuilder lazyStartProducer(boolean lazyStartProducer) Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel's routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing. The option is a: <code>boolean</code> type. Default: false Group: producer- Parameters:
lazyStartProducer
- the value to set- Returns:
- the dsl builder
-
publisherCacheSize
default GooglePubsubComponentBuilderFactory.GooglePubsubComponentBuilder publisherCacheSize(int publisherCacheSize) Maximum number of producers to cache. This could be increased if you have producers for lots of different topics. The option is a: <code>int</code> type. Group: producer- Parameters:
publisherCacheSize
- the value to set- Returns:
- the dsl builder
-
publisherCacheTimeout
default GooglePubsubComponentBuilderFactory.GooglePubsubComponentBuilder publisherCacheTimeout(int publisherCacheTimeout) How many milliseconds should each producer stay alive in the cache. The option is a: <code>int</code> type. Group: producer- Parameters:
publisherCacheTimeout
- the value to set- Returns:
- the dsl builder
-
autowiredEnabled
default GooglePubsubComponentBuilderFactory.GooglePubsubComponentBuilder autowiredEnabled(boolean autowiredEnabled) Whether autowiring is enabled. This is used for automatic autowiring options (the option must be marked as autowired) by looking up in the registry to find if there is a single instance of matching type, which then gets configured on the component. This can be used for automatic configuring JDBC data sources, JMS connection factories, AWS Clients, etc. The option is a: <code>boolean</code> type. Default: true Group: advanced- Parameters:
autowiredEnabled
- the value to set- Returns:
- the dsl builder
-
publisherTerminationTimeout
default GooglePubsubComponentBuilderFactory.GooglePubsubComponentBuilder publisherTerminationTimeout(int publisherTerminationTimeout) How many milliseconds should a producer be allowed to terminate. The option is a: <code>int</code> type. Group: advanced- Parameters:
publisherTerminationTimeout
- the value to set- Returns:
- the dsl builder
-