Interface IbmWatsonxDataComponentBuilderFactory.IbmWatsonxDataComponentBuilder

All Superinterfaces:
ComponentBuilder<org.apache.camel.component.ibm.watsonx.data.WatsonxDataComponent>
All Known Implementing Classes:
IbmWatsonxDataComponentBuilderFactory.IbmWatsonxDataComponentBuilderImpl
Enclosing interface:
IbmWatsonxDataComponentBuilderFactory

public static interface IbmWatsonxDataComponentBuilderFactory.IbmWatsonxDataComponentBuilder extends ComponentBuilder<org.apache.camel.component.ibm.watsonx.data.WatsonxDataComponent>
Builder for the IBM watsonx.data component.
  • Method Details

    • authInstanceId

      The watsonx.data instance CRN for API authorization. The option is a: <code>java.lang.String</code> type. Group: common
      Parameters:
      authInstanceId - the value to set
      Returns:
      the dsl builder
    • serviceUrl

      The watsonx.data service URL (e.g., https://region.lakehouse.cloud.ibm.com/lakehouse/api/v2). The option is a: <code>java.lang.String</code> type. Group: common
      Parameters:
      serviceUrl - the value to set
      Returns:
      the dsl builder
    • catalogName

      The catalog name for catalog, schema, and table operations. The option is a: <code>java.lang.String</code> type. Group: producer
      Parameters:
      catalogName - the value to set
      Returns:
      the dsl builder
    • configuration

      default IbmWatsonxDataComponentBuilderFactory.IbmWatsonxDataComponentBuilder configuration(org.apache.camel.component.ibm.watsonx.data.WatsonxDataConfiguration configuration)
      The component configuration. The option is a: <code>org.apache.camel.component.ibm.watsonx.data.WatsonxDataConfiguration</code> type. Group: producer
      Parameters:
      configuration - the value to set
      Returns:
      the dsl builder
    • engineId

      The engine ID for engine operations and schema/table queries. The option is a: <code>java.lang.String</code> type. Group: producer
      Parameters:
      engineId - the value to set
      Returns:
      the dsl builder
    • lazyStartProducer

      default IbmWatsonxDataComponentBuilderFactory.IbmWatsonxDataComponentBuilder 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 IbmWatsonxDataComponentBuilderFactory.IbmWatsonxDataComponentBuilder operation(org.apache.camel.component.ibm.watsonx.data.WatsonxDataOperations operation)
      The operation to perform. The option is a: <code>org.apache.camel.component.ibm.watsonx.data.WatsonxDataOperations</code> type. Group: producer
      Parameters:
      operation - the value to set
      Returns:
      the dsl builder
    • schemaName

      The schema name for schema and table operations. The option is a: <code>java.lang.String</code> type. Group: producer
      Parameters:
      schemaName - the value to set
      Returns:
      the dsl builder
    • autowiredEnabled

      default IbmWatsonxDataComponentBuilderFactory.IbmWatsonxDataComponentBuilder 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
    • apiKey

      IBM Cloud API key for authentication. The option is a: <code>java.lang.String</code> type. Group: security
      Parameters:
      apiKey - the value to set
      Returns:
      the dsl builder
    • oauthProfile

      OAuth profile name for obtaining an access token via the OAuth 2.0 Client Credentials grant. When set, the token is acquired from the configured identity provider and used as apiKey. Requires camel-oauth on the classpath. The option is a: <code>java.lang.String</code> type. Group: security
      Parameters:
      oauthProfile - the value to set
      Returns:
      the dsl builder