Google Firestore

Store and retrieve data from Google Cloud Firestore NoSQL database.

What’s inside

Google Firestore component, URI syntax: google-firestore:collectionName

Please refer to the above links for usage and configuration details.

Maven coordinates

<dependency>
    <groupId>org.apache.camel.springboot</groupId>
    <artifactId>camel-google-firestore-starter</artifactId>
</dependency>

Spring Boot Auto-Configuration

The starter supports 14 options, which are listed below.

Name	Description	Default	Type
camel.component.google-firestore.autowired-enabled	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.	true	Boolean
camel.component.google-firestore.bridge-error-handler	Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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	Boolean
camel.component.google-firestore.configuration	The component configuration. The option is a org.apache.camel.component.google.firestore.GoogleFirestoreConfiguration type.		GoogleFirestoreConfiguration
camel.component.google-firestore.database-id	The Firestore database ID. If not specified, the default database '(default)' will be used.		String
camel.component.google-firestore.document-id	The document ID to use for document-specific operations		String
camel.component.google-firestore.enabled	Whether to enable auto configuration of the google-firestore component. This is enabled by default.		Boolean
camel.component.google-firestore.firestore-client	The Firestore client to use for operations. The option is a com.google.cloud.firestore.Firestore type.		Firestore
camel.component.google-firestore.health-check-consumer-enabled	Used for enabling or disabling all consumer based health checks from this component	true	Boolean
camel.component.google-firestore.health-check-producer-enabled	Used for enabling or disabling all producer based health checks from this component. Notice: Camel has by default disabled all producer based health-checks. You can turn on producer checks globally by setting camel.health.producersEnabled=true.	true	Boolean
camel.component.google-firestore.lazy-start-producer	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.	false	Boolean
camel.component.google-firestore.operation	Set the operation for the producer.		GoogleFirestoreOperations
camel.component.google-firestore.project-id	The Google Cloud project ID. If not specified, it will be determined from the service account key or environment.		String
camel.component.google-firestore.realtime-updates	When true, the consumer will listen for real-time updates on the collection	false	Boolean
camel.component.google-firestore.service-account-key	The Service account key that can be used as credentials for the Firestore client. It can be loaded by default from classpath, but you can prefix with classpath:, file:, or http: to load the resource from different systems.		String

Name

Description

Default

Type

camel.component.google-firestore.autowired-enabled

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.

true

Boolean

camel.component.google-firestore.bridge-error-handler

Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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

Boolean

camel.component.google-firestore.configuration

The component configuration. The option is a org.apache.camel.component.google.firestore.GoogleFirestoreConfiguration type.

GoogleFirestoreConfiguration

camel.component.google-firestore.database-id

The Firestore database ID. If not specified, the default database '(default)' will be used.

String

camel.component.google-firestore.document-id

The document ID to use for document-specific operations

String

camel.component.google-firestore.enabled

Whether to enable auto configuration of the google-firestore component. This is enabled by default.

Boolean

camel.component.google-firestore.firestore-client

The Firestore client to use for operations. The option is a com.google.cloud.firestore.Firestore type.

Firestore

camel.component.google-firestore.health-check-consumer-enabled

Used for enabling or disabling all consumer based health checks from this component

true

Boolean

camel.component.google-firestore.health-check-producer-enabled

Used for enabling or disabling all producer based health checks from this component. Notice: Camel has by default disabled all producer based health-checks. You can turn on producer checks globally by setting camel.health.producersEnabled=true.

true

Boolean

camel.component.google-firestore.lazy-start-producer

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.

false

Boolean

camel.component.google-firestore.operation

Set the operation for the producer.

GoogleFirestoreOperations

camel.component.google-firestore.project-id

The Google Cloud project ID. If not specified, it will be determined from the service account key or environment.

String

camel.component.google-firestore.realtime-updates

When true, the consumer will listen for real-time updates on the collection

false

Boolean

camel.component.google-firestore.service-account-key

The Service account key that can be used as credentials for the Firestore client. It can be loaded by default from classpath, but you can prefix with classpath:, file:, or http: to load the resource from different systems.

String