Package org.apache.camel.builder.component.dsl

Interface AwsBedrockAgentComponentBuilderFactory.AwsBedrockAgentComponentBuilder

All Superinterfaces:
ComponentBuilder<org.apache.camel.component.aws2.bedrock.agent.BedrockAgentComponent>
All Known Implementing Classes:
AwsBedrockAgentComponentBuilderFactory.AwsBedrockAgentComponentBuilderImpl
Enclosing interface:
AwsBedrockAgentComponentBuilderFactory
public static interface AwsBedrockAgentComponentBuilderFactory.AwsBedrockAgentComponentBuilder extends ComponentBuilder<org.apache.camel.component.aws2.bedrock.agent.BedrockAgentComponent>
Builder for the AWS Bedrock Agent component.

  • Method Details

    • configuration

      default AwsBedrockAgentComponentBuilderFactory.AwsBedrockAgentComponentBuilder configuration(org.apache.camel.component.aws2.bedrock.agent.BedrockAgentConfiguration configuration)
      Component configuration. The option is a: <code>org.apache.camel.component.aws2.bedrock.agent.BedrockAgentConfiguration</code> type. Group: common
      Parameters:
      configuration - the value to set
      Returns:
      the dsl builder

    • dataSourceId

      default AwsBedrockAgentComponentBuilderFactory.AwsBedrockAgentComponentBuilder dataSourceId(String dataSourceId)
      Define the Data source Id we are going to use. The option is a: <code>java.lang.String</code> type. Group: common
      Parameters:
      dataSourceId - the value to set
      Returns:
      the dsl builder

    • knowledgeBaseId

      default AwsBedrockAgentComponentBuilderFactory.AwsBedrockAgentComponentBuilder knowledgeBaseId(String knowledgeBaseId)
      Define the Knowledge Base Id we are going to use. The option is a: <code>java.lang.String</code> type. Group: common
      Parameters:
      knowledgeBaseId - the value to set
      Returns:
      the dsl builder

    • modelId

      default AwsBedrockAgentComponentBuilderFactory.AwsBedrockAgentComponentBuilder modelId(String modelId)
      Define the model Id we are going to use. The option is a: <code>java.lang.String</code> type. Group: common
      Parameters:
      modelId - the value to set
      Returns:
      the dsl builder

    • operation

      default AwsBedrockAgentComponentBuilderFactory.AwsBedrockAgentComponentBuilder operation(org.apache.camel.component.aws2.bedrock.agent.BedrockAgentOperations operation)
      The operation to perform. The option is a: <code>org.apache.camel.component.aws2.bedrock.agent.BedrockAgentOperations</code> type. Group: common
      Parameters:
      operation - the value to set
      Returns:
      the dsl builder

    • overrideEndpoint

      default AwsBedrockAgentComponentBuilderFactory.AwsBedrockAgentComponentBuilder overrideEndpoint(boolean overrideEndpoint)
      Set the need for overriding the endpoint. This option needs to be used in combination with the uriEndpointOverride option. The option is a: <code>boolean</code> type. Default: false Group: common
      Parameters:
      overrideEndpoint - the value to set
      Returns:
      the dsl builder

    • pojoRequest

      default AwsBedrockAgentComponentBuilderFactory.AwsBedrockAgentComponentBuilder pojoRequest(boolean pojoRequest)
      If we want to use a POJO request as body or not. The option is a: <code>boolean</code> type. Default: false Group: common
      Parameters:
      pojoRequest - the value to set
      Returns:
      the dsl builder

    • profileCredentialsName

      default AwsBedrockAgentComponentBuilderFactory.AwsBedrockAgentComponentBuilder profileCredentialsName(String profileCredentialsName)
      If using a profile credentials provider, this parameter will set the profile name. The option is a: <code>java.lang.String</code> type. Default: false Group: common
      Parameters:
      profileCredentialsName - the value to set
      Returns:
      the dsl builder

    • region

      default AwsBedrockAgentComponentBuilderFactory.AwsBedrockAgentComponentBuilder region(String region)
      The region in which Bedrock Agent client needs to work. When using this parameter, the configuration will expect the lowercase name of the region (for example, ap-east-1) You'll need to use the name Region.EU_WEST_1.id(). The option is a: <code>java.lang.String</code> type. Group: common
      Parameters:
      region - the value to set
      Returns:
      the dsl builder

    • uriEndpointOverride

      default AwsBedrockAgentComponentBuilderFactory.AwsBedrockAgentComponentBuilder uriEndpointOverride(String uriEndpointOverride)
      Set the overriding uri endpoint. This option needs to be used in combination with overrideEndpoint option. The option is a: <code>java.lang.String</code> type. Group: common
      Parameters:
      uriEndpointOverride - the value to set
      Returns:
      the dsl builder

    • useDefaultCredentialsProvider

      default AwsBedrockAgentComponentBuilderFactory.AwsBedrockAgentComponentBuilder useDefaultCredentialsProvider(boolean useDefaultCredentialsProvider)
      Set whether the Bedrock Agent client should expect to load credentials through a default credentials provider or to expect static credentials to be passed in. The option is a: <code>boolean</code> type. Default: false Group: common
      Parameters:
      useDefaultCredentialsProvider - the value to set
      Returns:
      the dsl builder

    • useProfileCredentialsProvider

      default AwsBedrockAgentComponentBuilderFactory.AwsBedrockAgentComponentBuilder useProfileCredentialsProvider(boolean useProfileCredentialsProvider)
      Set whether the Bedrock Agent client should expect to load credentials through a profile credentials provider. The option is a: <code>boolean</code> type. Default: false Group: common
      Parameters:
      useProfileCredentialsProvider - the value to set
      Returns:
      the dsl builder

    • bridgeErrorHandler

      default AwsBedrockAgentComponentBuilderFactory.AwsBedrockAgentComponentBuilder 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

    • ingestionJobId

      default AwsBedrockAgentComponentBuilderFactory.AwsBedrockAgentComponentBuilder ingestionJobId(String ingestionJobId)
      Define the Ingestion Job Id we want to track. The option is a: <code>java.lang.String</code> type. Group: consumer
      Parameters:
      ingestionJobId - the value to set
      Returns:
      the dsl builder

    • lazyStartProducer

      default AwsBedrockAgentComponentBuilderFactory.AwsBedrockAgentComponentBuilder 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

    • autowiredEnabled

      default AwsBedrockAgentComponentBuilderFactory.AwsBedrockAgentComponentBuilder 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

    • bedrockAgentClient

      default AwsBedrockAgentComponentBuilderFactory.AwsBedrockAgentComponentBuilder bedrockAgentClient(software.amazon.awssdk.services.bedrockagent.BedrockAgentClient bedrockAgentClient)
      To use an existing configured AWS Bedrock Agent client. The option is a: <code>software.amazon.awssdk.services.bedrockagent.BedrockAgentClient</code> type. Group: advanced
      Parameters:
      bedrockAgentClient - the value to set
      Returns:
      the dsl builder

    • healthCheckConsumerEnabled

      default AwsBedrockAgentComponentBuilderFactory.AwsBedrockAgentComponentBuilder 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 AwsBedrockAgentComponentBuilderFactory.AwsBedrockAgentComponentBuilder 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

    • proxyHost

      default AwsBedrockAgentComponentBuilderFactory.AwsBedrockAgentComponentBuilder proxyHost(String proxyHost)
      To define a proxy host when instantiating the Bedrock Agent client. The option is a: <code>java.lang.String</code> type. Group: proxy
      Parameters:
      proxyHost - the value to set
      Returns:
      the dsl builder

    • proxyPort

      default AwsBedrockAgentComponentBuilderFactory.AwsBedrockAgentComponentBuilder proxyPort(Integer proxyPort)
      To define a proxy port when instantiating the Bedrock Agent client. The option is a: <code>java.lang.Integer</code> type. Group: proxy
      Parameters:
      proxyPort - the value to set
      Returns:
      the dsl builder

    • proxyProtocol

      default AwsBedrockAgentComponentBuilderFactory.AwsBedrockAgentComponentBuilder proxyProtocol(software.amazon.awssdk.core.Protocol proxyProtocol)
      To define a proxy protocol when instantiating the Bedrock Agent client. The option is a: <code>software.amazon.awssdk.core.Protocol</code> type. Default: HTTPS Group: proxy
      Parameters:
      proxyProtocol - the value to set
      Returns:
      the dsl builder

    • accessKey

      default AwsBedrockAgentComponentBuilderFactory.AwsBedrockAgentComponentBuilder accessKey(String accessKey)
      Amazon AWS Access Key. The option is a: <code>java.lang.String</code> type. Group: security
      Parameters:
      accessKey - the value to set
      Returns:
      the dsl builder

    • secretKey

      default AwsBedrockAgentComponentBuilderFactory.AwsBedrockAgentComponentBuilder secretKey(String secretKey)
      Amazon AWS Secret Key. The option is a: <code>java.lang.String</code> type. Group: security
      Parameters:
      secretKey - the value to set
      Returns:
      the dsl builder

    • sessionToken

      default AwsBedrockAgentComponentBuilderFactory.AwsBedrockAgentComponentBuilder sessionToken(String sessionToken)
      Amazon AWS Session Token used when the user needs to assume an IAM role. The option is a: <code>java.lang.String</code> type. Group: security
      Parameters:
      sessionToken - the value to set
      Returns:
      the dsl builder

    • trustAllCertificates

      default AwsBedrockAgentComponentBuilderFactory.AwsBedrockAgentComponentBuilder trustAllCertificates(boolean trustAllCertificates)
      If we want to trust all certificates in case of overriding the endpoint. The option is a: <code>boolean</code> type. Default: false Group: security
      Parameters:
      trustAllCertificates - the value to set
      Returns:
      the dsl builder

    • useSessionCredentials

      default AwsBedrockAgentComponentBuilderFactory.AwsBedrockAgentComponentBuilder useSessionCredentials(boolean useSessionCredentials)
      Set whether the Bedrock Agent client should expect to use Session Credentials. This is useful in a situation in which the user needs to assume an IAM role for doing operations in Bedrock. The option is a: <code>boolean</code> type. Default: false Group: security
      Parameters:
      useSessionCredentials - the value to set
      Returns:
      the dsl builder