Interface BedrockAgentEndpointBuilderFactory.BedrockAgentEndpointBuilder
- All Superinterfaces:
BedrockAgentEndpointBuilderFactory.BedrockAgentEndpointConsumerBuilder
,BedrockAgentEndpointBuilderFactory.BedrockAgentEndpointProducerBuilder
,org.apache.camel.builder.EndpointConsumerBuilder
,org.apache.camel.EndpointConsumerResolver
,org.apache.camel.builder.EndpointProducerBuilder
,org.apache.camel.EndpointProducerResolver
- Enclosing interface:
BedrockAgentEndpointBuilderFactory
public static interface BedrockAgentEndpointBuilderFactory.BedrockAgentEndpointBuilder
extends BedrockAgentEndpointBuilderFactory.BedrockAgentEndpointConsumerBuilder, BedrockAgentEndpointBuilderFactory.BedrockAgentEndpointProducerBuilder
Builder for endpoint for the AWS Bedrock Agent component.
-
Method Summary
Modifier and TypeMethodDescriptionAmazon AWS Access Key.advanced()
dataSourceId
(String dataSourceId) Define the Data source Id we are going to use.knowledgeBaseId
(String knowledgeBaseId) Define the Knowledge Base Id we are going to use.Define the model Id we are going to use.The operation to perform.operation
(org.apache.camel.component.aws2.bedrock.agent.BedrockAgentOperations operation) The operation to perform.overrideEndpoint
(boolean overrideEndpoint) Set the need for overriding the endpoint.overrideEndpoint
(String overrideEndpoint) Set the need for overriding the endpoint.pojoRequest
(boolean pojoRequest) If we want to use a POJO request as body or not.pojoRequest
(String pojoRequest) If we want to use a POJO request as body or not.profileCredentialsName
(String profileCredentialsName) If using a profile credentials provider, this parameter will set the profile name.To define a proxy host when instantiating the Bedrock Agent client.To define a proxy port when instantiating the Bedrock Agent client.To define a proxy port when instantiating the Bedrock Agent client.proxyProtocol
(String proxyProtocol) To define a proxy protocol when instantiating the Bedrock Agent client.proxyProtocol
(software.amazon.awssdk.core.Protocol proxyProtocol) To define a proxy protocol when instantiating the Bedrock Agent client.The region in which Bedrock Agent client needs to work.Amazon AWS Secret Key.sessionToken
(String sessionToken) Amazon AWS Session Token used when the user needs to assume an IAM role.trustAllCertificates
(boolean trustAllCertificates) If we want to trust all certificates in case of overriding the endpoint.trustAllCertificates
(String trustAllCertificates) If we want to trust all certificates in case of overriding the endpoint.uriEndpointOverride
(String uriEndpointOverride) Set the overriding uri endpoint.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.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.useProfileCredentialsProvider
(boolean useProfileCredentialsProvider) Set whether the Bedrock Agent client should expect to load credentials through a profile credentials provider.useProfileCredentialsProvider
(String useProfileCredentialsProvider) Set whether the Bedrock Agent client should expect to load credentials through a profile credentials provider.useSessionCredentials
(boolean useSessionCredentials) Set whether the Bedrock Agent client should expect to use Session Credentials.useSessionCredentials
(String useSessionCredentials) Set whether the Bedrock Agent client should expect to use Session Credentials.Methods inherited from interface org.apache.camel.builder.endpoint.dsl.BedrockAgentEndpointBuilderFactory.BedrockAgentEndpointConsumerBuilder
backoffErrorThreshold, backoffErrorThreshold, backoffIdleThreshold, backoffIdleThreshold, backoffMultiplier, backoffMultiplier, delay, delay, greedy, greedy, ingestionJobId, initialDelay, initialDelay, repeatCount, repeatCount, runLoggingLevel, runLoggingLevel, scheduledExecutorService, scheduledExecutorService, scheduler, scheduler, schedulerProperties, schedulerProperties, sendEmptyMessageWhenIdle, sendEmptyMessageWhenIdle, startScheduler, startScheduler, timeUnit, timeUnit, useFixedDelay, useFixedDelay
Methods inherited from interface org.apache.camel.builder.EndpointConsumerBuilder
doSetMultiValueProperties, doSetMultiValueProperty, doSetProperty, expr, getRawUri, getUri
Methods inherited from interface org.apache.camel.EndpointConsumerResolver
resolve, resolve
Methods inherited from interface org.apache.camel.builder.EndpointProducerBuilder
doSetMultiValueProperties, doSetMultiValueProperty, doSetProperty, expr, getRawUri, getUri
Methods inherited from interface org.apache.camel.EndpointProducerResolver
resolve, resolve
-
Method Details
-
advanced
- Specified by:
advanced
in interfaceBedrockAgentEndpointBuilderFactory.BedrockAgentEndpointConsumerBuilder
- Specified by:
advanced
in interfaceBedrockAgentEndpointBuilderFactory.BedrockAgentEndpointProducerBuilder
-
dataSourceId
default BedrockAgentEndpointBuilderFactory.BedrockAgentEndpointBuilder dataSourceId(String dataSourceId) Define the Data source Id we are going to use. The option is a:java.lang.String
type. Group: common- Specified by:
dataSourceId
in interfaceBedrockAgentEndpointBuilderFactory.BedrockAgentEndpointConsumerBuilder
- Specified by:
dataSourceId
in interfaceBedrockAgentEndpointBuilderFactory.BedrockAgentEndpointProducerBuilder
- Parameters:
dataSourceId
- the value to set- Returns:
- the dsl builder
-
knowledgeBaseId
default BedrockAgentEndpointBuilderFactory.BedrockAgentEndpointBuilder knowledgeBaseId(String knowledgeBaseId) Define the Knowledge Base Id we are going to use. The option is a:java.lang.String
type. Group: common- Specified by:
knowledgeBaseId
in interfaceBedrockAgentEndpointBuilderFactory.BedrockAgentEndpointConsumerBuilder
- Specified by:
knowledgeBaseId
in interfaceBedrockAgentEndpointBuilderFactory.BedrockAgentEndpointProducerBuilder
- Parameters:
knowledgeBaseId
- the value to set- Returns:
- the dsl builder
-
modelId
Define the model Id we are going to use. The option is a:java.lang.String
type. Required: true Group: common- Specified by:
modelId
in interfaceBedrockAgentEndpointBuilderFactory.BedrockAgentEndpointConsumerBuilder
- Specified by:
modelId
in interfaceBedrockAgentEndpointBuilderFactory.BedrockAgentEndpointProducerBuilder
- Parameters:
modelId
- the value to set- Returns:
- the dsl builder
-
operation
default BedrockAgentEndpointBuilderFactory.BedrockAgentEndpointBuilder 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- Specified by:
operation
in interfaceBedrockAgentEndpointBuilderFactory.BedrockAgentEndpointConsumerBuilder
- Specified by:
operation
in interfaceBedrockAgentEndpointBuilderFactory.BedrockAgentEndpointProducerBuilder
- Parameters:
operation
- the value to set- Returns:
- the dsl builder
-
operation
The operation to perform. The option will be converted to aorg.apache.camel.component.aws2.bedrock.agent.BedrockAgentOperations
type. Required: true Group: common- Specified by:
operation
in interfaceBedrockAgentEndpointBuilderFactory.BedrockAgentEndpointConsumerBuilder
- Specified by:
operation
in interfaceBedrockAgentEndpointBuilderFactory.BedrockAgentEndpointProducerBuilder
- Parameters:
operation
- the value to set- Returns:
- the dsl builder
-
overrideEndpoint
default BedrockAgentEndpointBuilderFactory.BedrockAgentEndpointBuilder 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- Specified by:
overrideEndpoint
in interfaceBedrockAgentEndpointBuilderFactory.BedrockAgentEndpointConsumerBuilder
- Specified by:
overrideEndpoint
in interfaceBedrockAgentEndpointBuilderFactory.BedrockAgentEndpointProducerBuilder
- Parameters:
overrideEndpoint
- the value to set- Returns:
- the dsl builder
-
overrideEndpoint
default BedrockAgentEndpointBuilderFactory.BedrockAgentEndpointBuilder 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 aboolean
type. Default: false Group: common- Specified by:
overrideEndpoint
in interfaceBedrockAgentEndpointBuilderFactory.BedrockAgentEndpointConsumerBuilder
- Specified by:
overrideEndpoint
in interfaceBedrockAgentEndpointBuilderFactory.BedrockAgentEndpointProducerBuilder
- Parameters:
overrideEndpoint
- the value to set- Returns:
- the dsl builder
-
pojoRequest
default BedrockAgentEndpointBuilderFactory.BedrockAgentEndpointBuilder 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- Specified by:
pojoRequest
in interfaceBedrockAgentEndpointBuilderFactory.BedrockAgentEndpointConsumerBuilder
- Specified by:
pojoRequest
in interfaceBedrockAgentEndpointBuilderFactory.BedrockAgentEndpointProducerBuilder
- Parameters:
pojoRequest
- the value to set- Returns:
- the dsl builder
-
pojoRequest
default BedrockAgentEndpointBuilderFactory.BedrockAgentEndpointBuilder pojoRequest(String pojoRequest) If we want to use a POJO request as body or not. The option will be converted to aboolean
type. Default: false Group: common- Specified by:
pojoRequest
in interfaceBedrockAgentEndpointBuilderFactory.BedrockAgentEndpointConsumerBuilder
- Specified by:
pojoRequest
in interfaceBedrockAgentEndpointBuilderFactory.BedrockAgentEndpointProducerBuilder
- Parameters:
pojoRequest
- the value to set- Returns:
- the dsl builder
-
profileCredentialsName
default BedrockAgentEndpointBuilderFactory.BedrockAgentEndpointBuilder 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- Specified by:
profileCredentialsName
in interfaceBedrockAgentEndpointBuilderFactory.BedrockAgentEndpointConsumerBuilder
- Specified by:
profileCredentialsName
in interfaceBedrockAgentEndpointBuilderFactory.BedrockAgentEndpointProducerBuilder
- Parameters:
profileCredentialsName
- the value to set- Returns:
- the dsl builder
-
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- Specified by:
region
in interfaceBedrockAgentEndpointBuilderFactory.BedrockAgentEndpointConsumerBuilder
- Specified by:
region
in interfaceBedrockAgentEndpointBuilderFactory.BedrockAgentEndpointProducerBuilder
- Parameters:
region
- the value to set- Returns:
- the dsl builder
-
uriEndpointOverride
default BedrockAgentEndpointBuilderFactory.BedrockAgentEndpointBuilder 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- Specified by:
uriEndpointOverride
in interfaceBedrockAgentEndpointBuilderFactory.BedrockAgentEndpointConsumerBuilder
- Specified by:
uriEndpointOverride
in interfaceBedrockAgentEndpointBuilderFactory.BedrockAgentEndpointProducerBuilder
- Parameters:
uriEndpointOverride
- the value to set- Returns:
- the dsl builder
-
useDefaultCredentialsProvider
default BedrockAgentEndpointBuilderFactory.BedrockAgentEndpointBuilder 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- Specified by:
useDefaultCredentialsProvider
in interfaceBedrockAgentEndpointBuilderFactory.BedrockAgentEndpointConsumerBuilder
- Specified by:
useDefaultCredentialsProvider
in interfaceBedrockAgentEndpointBuilderFactory.BedrockAgentEndpointProducerBuilder
- Parameters:
useDefaultCredentialsProvider
- the value to set- Returns:
- the dsl builder
-
useDefaultCredentialsProvider
default BedrockAgentEndpointBuilderFactory.BedrockAgentEndpointBuilder 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 aboolean
type. Default: false Group: common- Specified by:
useDefaultCredentialsProvider
in interfaceBedrockAgentEndpointBuilderFactory.BedrockAgentEndpointConsumerBuilder
- Specified by:
useDefaultCredentialsProvider
in interfaceBedrockAgentEndpointBuilderFactory.BedrockAgentEndpointProducerBuilder
- Parameters:
useDefaultCredentialsProvider
- the value to set- Returns:
- the dsl builder
-
useProfileCredentialsProvider
default BedrockAgentEndpointBuilderFactory.BedrockAgentEndpointBuilder 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- Specified by:
useProfileCredentialsProvider
in interfaceBedrockAgentEndpointBuilderFactory.BedrockAgentEndpointConsumerBuilder
- Specified by:
useProfileCredentialsProvider
in interfaceBedrockAgentEndpointBuilderFactory.BedrockAgentEndpointProducerBuilder
- Parameters:
useProfileCredentialsProvider
- the value to set- Returns:
- the dsl builder
-
useProfileCredentialsProvider
default BedrockAgentEndpointBuilderFactory.BedrockAgentEndpointBuilder 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 aboolean
type. Default: false Group: common- Specified by:
useProfileCredentialsProvider
in interfaceBedrockAgentEndpointBuilderFactory.BedrockAgentEndpointConsumerBuilder
- Specified by:
useProfileCredentialsProvider
in interfaceBedrockAgentEndpointBuilderFactory.BedrockAgentEndpointProducerBuilder
- Parameters:
useProfileCredentialsProvider
- the value to set- Returns:
- the dsl builder
-
proxyHost
To define a proxy host when instantiating the Bedrock Agent client. The option is a:java.lang.String
type. Group: proxy- Specified by:
proxyHost
in interfaceBedrockAgentEndpointBuilderFactory.BedrockAgentEndpointConsumerBuilder
- Specified by:
proxyHost
in interfaceBedrockAgentEndpointBuilderFactory.BedrockAgentEndpointProducerBuilder
- Parameters:
proxyHost
- the value to set- Returns:
- the dsl builder
-
proxyPort
To define a proxy port when instantiating the Bedrock Agent client. The option is a:java.lang.Integer
type. Group: proxy- Specified by:
proxyPort
in interfaceBedrockAgentEndpointBuilderFactory.BedrockAgentEndpointConsumerBuilder
- Specified by:
proxyPort
in interfaceBedrockAgentEndpointBuilderFactory.BedrockAgentEndpointProducerBuilder
- Parameters:
proxyPort
- the value to set- Returns:
- the dsl builder
-
proxyPort
To define a proxy port when instantiating the Bedrock Agent client. The option will be converted to ajava.lang.Integer
type. Group: proxy- Specified by:
proxyPort
in interfaceBedrockAgentEndpointBuilderFactory.BedrockAgentEndpointConsumerBuilder
- Specified by:
proxyPort
in interfaceBedrockAgentEndpointBuilderFactory.BedrockAgentEndpointProducerBuilder
- Parameters:
proxyPort
- the value to set- Returns:
- the dsl builder
-
proxyProtocol
default BedrockAgentEndpointBuilderFactory.BedrockAgentEndpointBuilder 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- Specified by:
proxyProtocol
in interfaceBedrockAgentEndpointBuilderFactory.BedrockAgentEndpointConsumerBuilder
- Specified by:
proxyProtocol
in interfaceBedrockAgentEndpointBuilderFactory.BedrockAgentEndpointProducerBuilder
- Parameters:
proxyProtocol
- the value to set- Returns:
- the dsl builder
-
proxyProtocol
default BedrockAgentEndpointBuilderFactory.BedrockAgentEndpointBuilder proxyProtocol(String proxyProtocol) To define a proxy protocol when instantiating the Bedrock Agent client. The option will be converted to asoftware.amazon.awssdk.core.Protocol
type. Default: HTTPS Group: proxy- Specified by:
proxyProtocol
in interfaceBedrockAgentEndpointBuilderFactory.BedrockAgentEndpointConsumerBuilder
- Specified by:
proxyProtocol
in interfaceBedrockAgentEndpointBuilderFactory.BedrockAgentEndpointProducerBuilder
- Parameters:
proxyProtocol
- the value to set- Returns:
- the dsl builder
-
accessKey
Amazon AWS Access Key. The option is a:java.lang.String
type. Group: security- Specified by:
accessKey
in interfaceBedrockAgentEndpointBuilderFactory.BedrockAgentEndpointConsumerBuilder
- Specified by:
accessKey
in interfaceBedrockAgentEndpointBuilderFactory.BedrockAgentEndpointProducerBuilder
- Parameters:
accessKey
- the value to set- Returns:
- the dsl builder
-
secretKey
Amazon AWS Secret Key. The option is a:java.lang.String
type. Group: security- Specified by:
secretKey
in interfaceBedrockAgentEndpointBuilderFactory.BedrockAgentEndpointConsumerBuilder
- Specified by:
secretKey
in interfaceBedrockAgentEndpointBuilderFactory.BedrockAgentEndpointProducerBuilder
- Parameters:
secretKey
- the value to set- Returns:
- the dsl builder
-
sessionToken
default BedrockAgentEndpointBuilderFactory.BedrockAgentEndpointBuilder 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- Specified by:
sessionToken
in interfaceBedrockAgentEndpointBuilderFactory.BedrockAgentEndpointConsumerBuilder
- Specified by:
sessionToken
in interfaceBedrockAgentEndpointBuilderFactory.BedrockAgentEndpointProducerBuilder
- Parameters:
sessionToken
- the value to set- Returns:
- the dsl builder
-
trustAllCertificates
default BedrockAgentEndpointBuilderFactory.BedrockAgentEndpointBuilder 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- Specified by:
trustAllCertificates
in interfaceBedrockAgentEndpointBuilderFactory.BedrockAgentEndpointConsumerBuilder
- Specified by:
trustAllCertificates
in interfaceBedrockAgentEndpointBuilderFactory.BedrockAgentEndpointProducerBuilder
- Parameters:
trustAllCertificates
- the value to set- Returns:
- the dsl builder
-
trustAllCertificates
default BedrockAgentEndpointBuilderFactory.BedrockAgentEndpointBuilder trustAllCertificates(String trustAllCertificates) If we want to trust all certificates in case of overriding the endpoint. The option will be converted to aboolean
type. Default: false Group: security- Specified by:
trustAllCertificates
in interfaceBedrockAgentEndpointBuilderFactory.BedrockAgentEndpointConsumerBuilder
- Specified by:
trustAllCertificates
in interfaceBedrockAgentEndpointBuilderFactory.BedrockAgentEndpointProducerBuilder
- Parameters:
trustAllCertificates
- the value to set- Returns:
- the dsl builder
-
useSessionCredentials
default BedrockAgentEndpointBuilderFactory.BedrockAgentEndpointBuilder 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- Specified by:
useSessionCredentials
in interfaceBedrockAgentEndpointBuilderFactory.BedrockAgentEndpointConsumerBuilder
- Specified by:
useSessionCredentials
in interfaceBedrockAgentEndpointBuilderFactory.BedrockAgentEndpointProducerBuilder
- Parameters:
useSessionCredentials
- the value to set- Returns:
- the dsl builder
-
useSessionCredentials
default BedrockAgentEndpointBuilderFactory.BedrockAgentEndpointBuilder 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 aboolean
type. Default: false Group: security- Specified by:
useSessionCredentials
in interfaceBedrockAgentEndpointBuilderFactory.BedrockAgentEndpointConsumerBuilder
- Specified by:
useSessionCredentials
in interfaceBedrockAgentEndpointBuilderFactory.BedrockAgentEndpointProducerBuilder
- Parameters:
useSessionCredentials
- the value to set- Returns:
- the dsl builder
-