Interface GoogleFirestoreComponentBuilderFactory.GoogleFirestoreComponentBuilder

All Superinterfaces:
ComponentBuilder<org.apache.camel.component.google.firestore.GoogleFirestoreComponent>
All Known Implementing Classes:
GoogleFirestoreComponentBuilderFactory.GoogleFirestoreComponentBuilderImpl
Enclosing interface:
GoogleFirestoreComponentBuilderFactory
public static interface GoogleFirestoreComponentBuilderFactory.GoogleFirestoreComponentBuilder extends ComponentBuilder<org.apache.camel.component.google.firestore.GoogleFirestoreComponent>
Builder for the Google Firestore component.

  • Method Details

    • configuration

      default GoogleFirestoreComponentBuilderFactory.GoogleFirestoreComponentBuilder configuration(org.apache.camel.component.google.firestore.GoogleFirestoreConfiguration configuration)
      The component configuration. The option is a: <code>org.apache.camel.component.google.firestore.GoogleFirestoreConfiguration</code> type. Group: common
      Parameters:
      configuration - the value to set
      Returns:
      the dsl builder

    • databaseId

      default GoogleFirestoreComponentBuilderFactory.GoogleFirestoreComponentBuilder databaseId(String databaseId)
      The Firestore database ID. If not specified, the default database '(default)' will be used. The option is a: <code>java.lang.String</code> type. Group: common
      Parameters:
      databaseId - the value to set
      Returns:
      the dsl builder

    • firestoreClient

      default GoogleFirestoreComponentBuilderFactory.GoogleFirestoreComponentBuilder firestoreClient(com.google.cloud.firestore.Firestore firestoreClient)
      The Firestore client to use for operations. The option is a: <code>com.google.cloud.firestore.Firestore</code> type. Group: common
      Parameters:
      firestoreClient - the value to set
      Returns:
      the dsl builder

    • projectId

      default GoogleFirestoreComponentBuilderFactory.GoogleFirestoreComponentBuilder projectId(String projectId)
      The Google Cloud project ID. If not specified, it will be determined from the service account key or environment. The option is a: <code>java.lang.String</code> type. Group: common
      Parameters:
      projectId - the value to set
      Returns:
      the dsl builder

    • serviceAccountKey

      default GoogleFirestoreComponentBuilderFactory.GoogleFirestoreComponentBuilder serviceAccountKey(String serviceAccountKey)
      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. The option is a: <code>java.lang.String</code> type. Group: common
      Parameters:
      serviceAccountKey - the value to set
      Returns:
      the dsl builder

    • bridgeErrorHandler

      default GoogleFirestoreComponentBuilderFactory.GoogleFirestoreComponentBuilder bridgeErrorHandler(boolean bridgeErrorHandler)
      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. The option is a: <code>boolean</code> type. Default: false Group: consumer
      Parameters:
      bridgeErrorHandler - the value to set
      Returns:
      the dsl builder

    • realtimeUpdates

      default GoogleFirestoreComponentBuilderFactory.GoogleFirestoreComponentBuilder realtimeUpdates(boolean realtimeUpdates)
      When true, the consumer will listen for real-time updates on the collection. The option is a: <code>boolean</code> type. Default: false Group: consumer
      Parameters:
      realtimeUpdates - the value to set
      Returns:
      the dsl builder

    • documentId

      default GoogleFirestoreComponentBuilderFactory.GoogleFirestoreComponentBuilder documentId(String documentId)
      The document ID to use for document-specific operations. The option is a: <code>java.lang.String</code> type. Group: producer
      Parameters:
      documentId - the value to set
      Returns:
      the dsl builder

    • lazyStartProducer

      default GoogleFirestoreComponentBuilderFactory.GoogleFirestoreComponentBuilder 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

    • operation

      default GoogleFirestoreComponentBuilderFactory.GoogleFirestoreComponentBuilder operation(org.apache.camel.component.google.firestore.GoogleFirestoreOperations operation)
      Set the operation for the producer. The option is a: <code>org.apache.camel.component.google.firestore.GoogleFirestoreOperations</code> type. Group: producer
      Parameters:
      operation - the value to set
      Returns:
      the dsl builder

    • autowiredEnabled

      default GoogleFirestoreComponentBuilderFactory.GoogleFirestoreComponentBuilder 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

    • healthCheckConsumerEnabled

      default GoogleFirestoreComponentBuilderFactory.GoogleFirestoreComponentBuilder healthCheckConsumerEnabled(boolean healthCheckConsumerEnabled)
      Used for enabling or disabling all consumer based health checks from this component. The option is a: <code>boolean</code> type. Default: true Group: health
      Parameters:
      healthCheckConsumerEnabled - the value to set
      Returns:
      the dsl builder

    • healthCheckProducerEnabled

      default GoogleFirestoreComponentBuilderFactory.GoogleFirestoreComponentBuilder healthCheckProducerEnabled(boolean healthCheckProducerEnabled)
      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. The option is a: <code>boolean</code> type. Default: true Group: health
      Parameters:
      healthCheckProducerEnabled - the value to set
      Returns:
      the dsl builder