Package org.apache.camel.builder.endpoint.dsl

Interface BedrockAgentEndpointBuilderFactory.BedrockAgentEndpointConsumerBuilder

All Superinterfaces:
org.apache.camel.builder.EndpointConsumerBuilder, org.apache.camel.EndpointConsumerResolver
All Known Subinterfaces:
BedrockAgentEndpointBuilderFactory.BedrockAgentEndpointBuilder
Enclosing interface:
BedrockAgentEndpointBuilderFactory
public static interface BedrockAgentEndpointBuilderFactory.BedrockAgentEndpointConsumerBuilder extends org.apache.camel.builder.EndpointConsumerBuilder
Builder for endpoint consumers for the AWS Bedrock Agent component.

  • Method Details

    • advanced

      default BedrockAgentEndpointBuilderFactory.AdvancedBedrockAgentEndpointConsumerBuilder advanced()

    • dataSourceId

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

    • knowledgeBaseId

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

    • modelId

      default BedrockAgentEndpointBuilderFactory.BedrockAgentEndpointConsumerBuilder modelId(String modelId)
      Define the model Id we are going to use. The option is a: java.lang.String type. Required: true Group: common
      Parameters:
      modelId - the value to set
      Returns:
      the dsl builder

    • operation

      default BedrockAgentEndpointBuilderFactory.BedrockAgentEndpointConsumerBuilder operation(org.apache.camel.component.aws2.bedrock.agent.BedrockAgentOperations operation)
      The operation to perform. The option is a: org.apache.camel.component.aws2.bedrock.agent.BedrockAgentOperations type. Required: true Group: common
      Parameters:
      operation - the value to set
      Returns:
      the dsl builder

    • operation

      default BedrockAgentEndpointBuilderFactory.BedrockAgentEndpointConsumerBuilder operation(String operation)
      The operation to perform. The option will be converted to a org.apache.camel.component.aws2.bedrock.agent.BedrockAgentOperations type. Required: true Group: common
      Parameters:
      operation - the value to set
      Returns:
      the dsl builder

    • overrideEndpoint

      default BedrockAgentEndpointBuilderFactory.BedrockAgentEndpointConsumerBuilder 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: boolean type. Default: false Group: common
      Parameters:
      overrideEndpoint - the value to set
      Returns:
      the dsl builder

    • overrideEndpoint

      default BedrockAgentEndpointBuilderFactory.BedrockAgentEndpointConsumerBuilder overrideEndpoint(String overrideEndpoint)
      Set the need for overriding the endpoint. This option needs to be used in combination with the uriEndpointOverride option. The option will be converted to a boolean type. Default: false Group: common
      Parameters:
      overrideEndpoint - the value to set
      Returns:
      the dsl builder

    • pojoRequest

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

    • pojoRequest

      default BedrockAgentEndpointBuilderFactory.BedrockAgentEndpointConsumerBuilder pojoRequest(String pojoRequest)
      If we want to use a POJO request as body or not. The option will be converted to a boolean type. Default: false Group: common
      Parameters:
      pojoRequest - the value to set
      Returns:
      the dsl builder

    • profileCredentialsName

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

    • region

      default BedrockAgentEndpointBuilderFactory.BedrockAgentEndpointConsumerBuilder 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: java.lang.String type. Group: common
      Parameters:
      region - the value to set
      Returns:
      the dsl builder

    • uriEndpointOverride

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

    • useDefaultCredentialsProvider

      default BedrockAgentEndpointBuilderFactory.BedrockAgentEndpointConsumerBuilder 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: boolean type. Default: false Group: common
      Parameters:
      useDefaultCredentialsProvider - the value to set
      Returns:
      the dsl builder

    • useDefaultCredentialsProvider

      default BedrockAgentEndpointBuilderFactory.BedrockAgentEndpointConsumerBuilder useDefaultCredentialsProvider(String 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 will be converted to a boolean type. Default: false Group: common
      Parameters:
      useDefaultCredentialsProvider - the value to set
      Returns:
      the dsl builder

    • useProfileCredentialsProvider

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

    • useProfileCredentialsProvider

      default BedrockAgentEndpointBuilderFactory.BedrockAgentEndpointConsumerBuilder useProfileCredentialsProvider(String useProfileCredentialsProvider)
      Set whether the Bedrock Agent client should expect to load credentials through a profile credentials provider. The option will be converted to a boolean type. Default: false Group: common
      Parameters:
      useProfileCredentialsProvider - the value to set
      Returns:
      the dsl builder

    • ingestionJobId

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

    • sendEmptyMessageWhenIdle

      default BedrockAgentEndpointBuilderFactory.BedrockAgentEndpointConsumerBuilder sendEmptyMessageWhenIdle(boolean sendEmptyMessageWhenIdle)
      If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead. The option is a: boolean type. Default: false Group: consumer
      Parameters:
      sendEmptyMessageWhenIdle - the value to set
      Returns:
      the dsl builder

    • sendEmptyMessageWhenIdle

      default BedrockAgentEndpointBuilderFactory.BedrockAgentEndpointConsumerBuilder sendEmptyMessageWhenIdle(String sendEmptyMessageWhenIdle)
      If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead. The option will be converted to a boolean type. Default: false Group: consumer
      Parameters:
      sendEmptyMessageWhenIdle - the value to set
      Returns:
      the dsl builder

    • proxyHost

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

    • proxyPort

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

    • proxyPort

      default BedrockAgentEndpointBuilderFactory.BedrockAgentEndpointConsumerBuilder proxyPort(String proxyPort)
      To define a proxy port when instantiating the Bedrock Agent client. The option will be converted to a java.lang.Integer type. Group: proxy
      Parameters:
      proxyPort - the value to set
      Returns:
      the dsl builder

    • proxyProtocol

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

    • proxyProtocol

      default BedrockAgentEndpointBuilderFactory.BedrockAgentEndpointConsumerBuilder proxyProtocol(String proxyProtocol)
      To define a proxy protocol when instantiating the Bedrock Agent client. The option will be converted to a software.amazon.awssdk.core.Protocol type. Default: HTTPS Group: proxy
      Parameters:
      proxyProtocol - the value to set
      Returns:
      the dsl builder

    • backoffErrorThreshold

      default BedrockAgentEndpointBuilderFactory.BedrockAgentEndpointConsumerBuilder backoffErrorThreshold(int backoffErrorThreshold)
      The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in. The option is a: int type. Group: scheduler
      Parameters:
      backoffErrorThreshold - the value to set
      Returns:
      the dsl builder

    • backoffErrorThreshold

      default BedrockAgentEndpointBuilderFactory.BedrockAgentEndpointConsumerBuilder backoffErrorThreshold(String backoffErrorThreshold)
      The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in. The option will be converted to a int type. Group: scheduler
      Parameters:
      backoffErrorThreshold - the value to set
      Returns:
      the dsl builder

    • backoffIdleThreshold

      default BedrockAgentEndpointBuilderFactory.BedrockAgentEndpointConsumerBuilder backoffIdleThreshold(int backoffIdleThreshold)
      The number of subsequent idle polls that should happen before the backoffMultipler should kick-in. The option is a: int type. Group: scheduler
      Parameters:
      backoffIdleThreshold - the value to set
      Returns:
      the dsl builder

    • backoffIdleThreshold

      default BedrockAgentEndpointBuilderFactory.BedrockAgentEndpointConsumerBuilder backoffIdleThreshold(String backoffIdleThreshold)
      The number of subsequent idle polls that should happen before the backoffMultipler should kick-in. The option will be converted to a int type. Group: scheduler
      Parameters:
      backoffIdleThreshold - the value to set
      Returns:
      the dsl builder

    • backoffMultiplier

      default BedrockAgentEndpointBuilderFactory.BedrockAgentEndpointConsumerBuilder backoffMultiplier(int backoffMultiplier)
      To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured. The option is a: int type. Group: scheduler
      Parameters:
      backoffMultiplier - the value to set
      Returns:
      the dsl builder

    • backoffMultiplier

      default BedrockAgentEndpointBuilderFactory.BedrockAgentEndpointConsumerBuilder backoffMultiplier(String backoffMultiplier)
      To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured. The option will be converted to a int type. Group: scheduler
      Parameters:
      backoffMultiplier - the value to set
      Returns:
      the dsl builder

    • delay

      default BedrockAgentEndpointBuilderFactory.BedrockAgentEndpointConsumerBuilder delay(long delay)
      Milliseconds before the next poll. The option is a: long type. Default: 500 Group: scheduler
      Parameters:
      delay - the value to set
      Returns:
      the dsl builder

    • delay

      default BedrockAgentEndpointBuilderFactory.BedrockAgentEndpointConsumerBuilder delay(String delay)
      Milliseconds before the next poll. The option will be converted to a long type. Default: 500 Group: scheduler
      Parameters:
      delay - the value to set
      Returns:
      the dsl builder

    • greedy

      default BedrockAgentEndpointBuilderFactory.BedrockAgentEndpointConsumerBuilder greedy(boolean greedy)
      If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages. The option is a: boolean type. Default: false Group: scheduler
      Parameters:
      greedy - the value to set
      Returns:
      the dsl builder

    • greedy

      default BedrockAgentEndpointBuilderFactory.BedrockAgentEndpointConsumerBuilder greedy(String greedy)
      If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages. The option will be converted to a boolean type. Default: false Group: scheduler
      Parameters:
      greedy - the value to set
      Returns:
      the dsl builder

    • initialDelay

      default BedrockAgentEndpointBuilderFactory.BedrockAgentEndpointConsumerBuilder initialDelay(long initialDelay)
      Milliseconds before the first poll starts. The option is a: long type. Default: 1000 Group: scheduler
      Parameters:
      initialDelay - the value to set
      Returns:
      the dsl builder

    • initialDelay

      default BedrockAgentEndpointBuilderFactory.BedrockAgentEndpointConsumerBuilder initialDelay(String initialDelay)
      Milliseconds before the first poll starts. The option will be converted to a long type. Default: 1000 Group: scheduler
      Parameters:
      initialDelay - the value to set
      Returns:
      the dsl builder

    • repeatCount

      default BedrockAgentEndpointBuilderFactory.BedrockAgentEndpointConsumerBuilder repeatCount(long repeatCount)
      Specifies a maximum limit of number of fires. So if you set it to 1, the scheduler will only fire once. If you set it to 5, it will only fire five times. A value of zero or negative means fire forever. The option is a: long type. Default: 0 Group: scheduler
      Parameters:
      repeatCount - the value to set
      Returns:
      the dsl builder

    • repeatCount

      default BedrockAgentEndpointBuilderFactory.BedrockAgentEndpointConsumerBuilder repeatCount(String repeatCount)
      Specifies a maximum limit of number of fires. So if you set it to 1, the scheduler will only fire once. If you set it to 5, it will only fire five times. A value of zero or negative means fire forever. The option will be converted to a long type. Default: 0 Group: scheduler
      Parameters:
      repeatCount - the value to set
      Returns:
      the dsl builder

    • runLoggingLevel

      default BedrockAgentEndpointBuilderFactory.BedrockAgentEndpointConsumerBuilder runLoggingLevel(org.apache.camel.LoggingLevel runLoggingLevel)
      The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that. The option is a: org.apache.camel.LoggingLevel type. Default: TRACE Group: scheduler
      Parameters:
      runLoggingLevel - the value to set
      Returns:
      the dsl builder

    • runLoggingLevel

      default BedrockAgentEndpointBuilderFactory.BedrockAgentEndpointConsumerBuilder runLoggingLevel(String runLoggingLevel)
      The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that. The option will be converted to a org.apache.camel.LoggingLevel type. Default: TRACE Group: scheduler
      Parameters:
      runLoggingLevel - the value to set
      Returns:
      the dsl builder

    • scheduledExecutorService

      default BedrockAgentEndpointBuilderFactory.BedrockAgentEndpointConsumerBuilder scheduledExecutorService(ScheduledExecutorService scheduledExecutorService)
      Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool. The option is a: java.util.concurrent.ScheduledExecutorService type. Group: scheduler
      Parameters:
      scheduledExecutorService - the value to set
      Returns:
      the dsl builder

    • scheduledExecutorService

      default BedrockAgentEndpointBuilderFactory.BedrockAgentEndpointConsumerBuilder scheduledExecutorService(String scheduledExecutorService)
      Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool. The option will be converted to a java.util.concurrent.ScheduledExecutorService type. Group: scheduler
      Parameters:
      scheduledExecutorService - the value to set
      Returns:
      the dsl builder

    • scheduler

      default BedrockAgentEndpointBuilderFactory.BedrockAgentEndpointConsumerBuilder scheduler(Object scheduler)
      To use a cron scheduler from either camel-spring or camel-quartz component. Use value spring or quartz for built in scheduler. The option is a: java.lang.Object type. Default: none Group: scheduler
      Parameters:
      scheduler - the value to set
      Returns:
      the dsl builder

    • scheduler

      default BedrockAgentEndpointBuilderFactory.BedrockAgentEndpointConsumerBuilder scheduler(String scheduler)
      To use a cron scheduler from either camel-spring or camel-quartz component. Use value spring or quartz for built in scheduler. The option will be converted to a java.lang.Object type. Default: none Group: scheduler
      Parameters:
      scheduler - the value to set
      Returns:
      the dsl builder

    • schedulerProperties

      default BedrockAgentEndpointBuilderFactory.BedrockAgentEndpointConsumerBuilder schedulerProperties(String key, Object value)
      To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler. The option is a: java.util.Map<java.lang.String, java.lang.Object> type. The option is multivalued, and you can use the schedulerProperties(String, Object) method to add a value (call the method multiple times to set more values). Group: scheduler
      Parameters:
      key - the option key
      value - the option value
      Returns:
      the dsl builder

    • schedulerProperties

      default BedrockAgentEndpointBuilderFactory.BedrockAgentEndpointConsumerBuilder schedulerProperties(Map values)
      To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler. The option is a: java.util.Map<java.lang.String, java.lang.Object> type. The option is multivalued, and you can use the schedulerProperties(String, Object) method to add a value (call the method multiple times to set more values). Group: scheduler
      Parameters:
      values - the values
      Returns:
      the dsl builder

    • startScheduler

      default BedrockAgentEndpointBuilderFactory.BedrockAgentEndpointConsumerBuilder startScheduler(boolean startScheduler)
      Whether the scheduler should be auto started. The option is a: boolean type. Default: true Group: scheduler
      Parameters:
      startScheduler - the value to set
      Returns:
      the dsl builder

    • startScheduler

      default BedrockAgentEndpointBuilderFactory.BedrockAgentEndpointConsumerBuilder startScheduler(String startScheduler)
      Whether the scheduler should be auto started. The option will be converted to a boolean type. Default: true Group: scheduler
      Parameters:
      startScheduler - the value to set
      Returns:
      the dsl builder

    • timeUnit

      default BedrockAgentEndpointBuilderFactory.BedrockAgentEndpointConsumerBuilder timeUnit(TimeUnit timeUnit)
      Time unit for initialDelay and delay options. The option is a: java.util.concurrent.TimeUnit type. Default: MILLISECONDS Group: scheduler
      Parameters:
      timeUnit - the value to set
      Returns:
      the dsl builder

    • timeUnit

      default BedrockAgentEndpointBuilderFactory.BedrockAgentEndpointConsumerBuilder timeUnit(String timeUnit)
      Time unit for initialDelay and delay options. The option will be converted to a java.util.concurrent.TimeUnit type. Default: MILLISECONDS Group: scheduler
      Parameters:
      timeUnit - the value to set
      Returns:
      the dsl builder

    • useFixedDelay

      default BedrockAgentEndpointBuilderFactory.BedrockAgentEndpointConsumerBuilder useFixedDelay(boolean useFixedDelay)
      Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details. The option is a: boolean type. Default: true Group: scheduler
      Parameters:
      useFixedDelay - the value to set
      Returns:
      the dsl builder

    • useFixedDelay

      default BedrockAgentEndpointBuilderFactory.BedrockAgentEndpointConsumerBuilder useFixedDelay(String useFixedDelay)
      Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details. The option will be converted to a boolean type. Default: true Group: scheduler
      Parameters:
      useFixedDelay - the value to set
      Returns:
      the dsl builder

    • accessKey

      default BedrockAgentEndpointBuilderFactory.BedrockAgentEndpointConsumerBuilder accessKey(String accessKey)
      Amazon AWS Access Key. The option is a: java.lang.String type. Group: security
      Parameters:
      accessKey - the value to set
      Returns:
      the dsl builder

    • secretKey

      default BedrockAgentEndpointBuilderFactory.BedrockAgentEndpointConsumerBuilder secretKey(String secretKey)
      Amazon AWS Secret Key. The option is a: java.lang.String type. Group: security
      Parameters:
      secretKey - the value to set
      Returns:
      the dsl builder

    • sessionToken

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

    • trustAllCertificates

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

    • trustAllCertificates

      default BedrockAgentEndpointBuilderFactory.BedrockAgentEndpointConsumerBuilder trustAllCertificates(String trustAllCertificates)
      If we want to trust all certificates in case of overriding the endpoint. The option will be converted to a boolean type. Default: false Group: security
      Parameters:
      trustAllCertificates - the value to set
      Returns:
      the dsl builder

    • useSessionCredentials

      default BedrockAgentEndpointBuilderFactory.BedrockAgentEndpointConsumerBuilder 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: boolean type. Default: false Group: security
      Parameters:
      useSessionCredentials - the value to set
      Returns:
      the dsl builder

    • useSessionCredentials

      default BedrockAgentEndpointBuilderFactory.BedrockAgentEndpointConsumerBuilder useSessionCredentials(String 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 will be converted to a boolean type. Default: false Group: security
      Parameters:
      useSessionCredentials - the value to set
      Returns:
      the dsl builder