Interface Ses2EndpointBuilderFactory.Ses2EndpointBuilder
-
- All Superinterfaces:
org.apache.camel.builder.EndpointProducerBuilder
,org.apache.camel.EndpointProducerResolver
- Enclosing interface:
- Ses2EndpointBuilderFactory
public static interface Ses2EndpointBuilderFactory.Ses2EndpointBuilder extends org.apache.camel.builder.EndpointProducerBuilder
Builder for endpoint for the AWS Simple Email Service (SES) component.
-
-
Method Summary
All Methods Instance Methods Default Methods Modifier and Type Method Description default Ses2EndpointBuilderFactory.Ses2EndpointBuilder
accessKey(String accessKey)
Amazon AWS Access Key.default Ses2EndpointBuilderFactory.Ses2EndpointBuilder
amazonSESClient(String amazonSESClient)
To use the AmazonSimpleEmailService as the client.default Ses2EndpointBuilderFactory.Ses2EndpointBuilder
amazonSESClient(software.amazon.awssdk.services.ses.SesClient amazonSESClient)
To use the AmazonSimpleEmailService as the client.default Ses2EndpointBuilderFactory.Ses2EndpointBuilder
configurationSet(String configurationSet)
Set the configuration set to send with every request.default Ses2EndpointBuilderFactory.Ses2EndpointBuilder
lazyStartProducer(boolean lazyStartProducer)
Whether the producer should be started lazy (on the first message).default Ses2EndpointBuilderFactory.Ses2EndpointBuilder
lazyStartProducer(String lazyStartProducer)
Whether the producer should be started lazy (on the first message).default Ses2EndpointBuilderFactory.Ses2EndpointBuilder
overrideEndpoint(boolean overrideEndpoint)
Set the need for overidding the endpoint.default Ses2EndpointBuilderFactory.Ses2EndpointBuilder
overrideEndpoint(String overrideEndpoint)
Set the need for overidding the endpoint.default Ses2EndpointBuilderFactory.Ses2EndpointBuilder
proxyHost(String proxyHost)
To define a proxy host when instantiating the SES client.default Ses2EndpointBuilderFactory.Ses2EndpointBuilder
proxyPort(Integer proxyPort)
To define a proxy port when instantiating the SES client.default Ses2EndpointBuilderFactory.Ses2EndpointBuilder
proxyPort(String proxyPort)
To define a proxy port when instantiating the SES client.default Ses2EndpointBuilderFactory.Ses2EndpointBuilder
proxyProtocol(String proxyProtocol)
To define a proxy protocol when instantiating the SES client.default Ses2EndpointBuilderFactory.Ses2EndpointBuilder
proxyProtocol(software.amazon.awssdk.core.Protocol proxyProtocol)
To define a proxy protocol when instantiating the SES client.default Ses2EndpointBuilderFactory.Ses2EndpointBuilder
region(String region)
The region in which SES client needs to work.default Ses2EndpointBuilderFactory.Ses2EndpointBuilder
replyToAddresses(String replyToAddresses)
List of comma separated reply-to email address(es) for the message, override it using 'CamelAwsSesReplyToAddresses' header.default Ses2EndpointBuilderFactory.Ses2EndpointBuilder
returnPath(String returnPath)
The email address to which bounce notifications are to be forwarded, override it using 'CamelAwsSesReturnPath' header.default Ses2EndpointBuilderFactory.Ses2EndpointBuilder
secretKey(String secretKey)
Amazon AWS Secret Key.default Ses2EndpointBuilderFactory.Ses2EndpointBuilder
subject(String subject)
The subject which is used if the message header 'CamelAwsSesSubject' is not present.default Ses2EndpointBuilderFactory.Ses2EndpointBuilder
to(String to)
List of comma separated destination email address.default Ses2EndpointBuilderFactory.Ses2EndpointBuilder
trustAllCertificates(boolean trustAllCertificates)
If we want to trust all certificates in case of overriding the endpoint.default Ses2EndpointBuilderFactory.Ses2EndpointBuilder
trustAllCertificates(String trustAllCertificates)
If we want to trust all certificates in case of overriding the endpoint.default Ses2EndpointBuilderFactory.Ses2EndpointBuilder
uriEndpointOverride(String uriEndpointOverride)
Set the overriding uri endpoint.default Ses2EndpointBuilderFactory.Ses2EndpointBuilder
useDefaultCredentialsProvider(boolean useDefaultCredentialsProvider)
Set whether the Ses client should expect to load credentials through a default credentials provider or to expect static credentials to be passed in.default Ses2EndpointBuilderFactory.Ses2EndpointBuilder
useDefaultCredentialsProvider(String useDefaultCredentialsProvider)
Set whether the Ses client should expect to load credentials through a default credentials provider or to expect static credentials to be passed in.
-
-
-
Method Detail
-
amazonSESClient
default Ses2EndpointBuilderFactory.Ses2EndpointBuilder amazonSESClient(software.amazon.awssdk.services.ses.SesClient amazonSESClient)
To use the AmazonSimpleEmailService as the client. The option is a: <code>software.amazon.awssdk.services.ses.SesClient</code> type. Group: producer- Parameters:
amazonSESClient
- the value to set- Returns:
- the dsl builder
-
amazonSESClient
default Ses2EndpointBuilderFactory.Ses2EndpointBuilder amazonSESClient(String amazonSESClient)
To use the AmazonSimpleEmailService as the client. The option will be converted to a <code>software.amazon.awssdk.services.ses.SesClient</code> type. Group: producer- Parameters:
amazonSESClient
- the value to set- Returns:
- the dsl builder
-
configurationSet
default Ses2EndpointBuilderFactory.Ses2EndpointBuilder configurationSet(String configurationSet)
Set the configuration set to send with every request. Override it with 'CamelAwsSesConfigurationSet' header. The option is a: <code>java.lang.String</code> type. Group: producer- Parameters:
configurationSet
- the value to set- Returns:
- the dsl builder
-
lazyStartProducer
default Ses2EndpointBuilderFactory.Ses2EndpointBuilder 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
-
lazyStartProducer
default Ses2EndpointBuilderFactory.Ses2EndpointBuilder lazyStartProducer(String 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 will be converted to a <code>boolean</code> type. Default: false Group: producer- Parameters:
lazyStartProducer
- the value to set- Returns:
- the dsl builder
-
overrideEndpoint
default Ses2EndpointBuilderFactory.Ses2EndpointBuilder overrideEndpoint(boolean overrideEndpoint)
Set the need for overidding the endpoint. This option needs to be used in combination with uriEndpointOverride option. The option is a: <code>boolean</code> type. Default: false Group: producer- Parameters:
overrideEndpoint
- the value to set- Returns:
- the dsl builder
-
overrideEndpoint
default Ses2EndpointBuilderFactory.Ses2EndpointBuilder overrideEndpoint(String overrideEndpoint)
Set the need for overidding the endpoint. This option needs to be used in combination with uriEndpointOverride option. The option will be converted to a <code>boolean</code> type. Default: false Group: producer- Parameters:
overrideEndpoint
- the value to set- Returns:
- the dsl builder
-
proxyHost
default Ses2EndpointBuilderFactory.Ses2EndpointBuilder proxyHost(String proxyHost)
To define a proxy host when instantiating the SES client. The option is a: <code>java.lang.String</code> type. Group: producer- Parameters:
proxyHost
- the value to set- Returns:
- the dsl builder
-
proxyPort
default Ses2EndpointBuilderFactory.Ses2EndpointBuilder proxyPort(Integer proxyPort)
To define a proxy port when instantiating the SES client. The option is a: <code>java.lang.Integer</code> type. Group: producer- Parameters:
proxyPort
- the value to set- Returns:
- the dsl builder
-
proxyPort
default Ses2EndpointBuilderFactory.Ses2EndpointBuilder proxyPort(String proxyPort)
To define a proxy port when instantiating the SES client. The option will be converted to a <code>java.lang.Integer</code> type. Group: producer- Parameters:
proxyPort
- the value to set- Returns:
- the dsl builder
-
proxyProtocol
default Ses2EndpointBuilderFactory.Ses2EndpointBuilder proxyProtocol(software.amazon.awssdk.core.Protocol proxyProtocol)
To define a proxy protocol when instantiating the SES client. The option is a: <code>software.amazon.awssdk.core.Protocol</code> type. Default: HTTPS Group: producer- Parameters:
proxyProtocol
- the value to set- Returns:
- the dsl builder
-
proxyProtocol
default Ses2EndpointBuilderFactory.Ses2EndpointBuilder proxyProtocol(String proxyProtocol)
To define a proxy protocol when instantiating the SES client. The option will be converted to a <code>software.amazon.awssdk.core.Protocol</code> type. Default: HTTPS Group: producer- Parameters:
proxyProtocol
- the value to set- Returns:
- the dsl builder
-
region
default Ses2EndpointBuilderFactory.Ses2EndpointBuilder region(String region)
The region in which SES 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: producer- Parameters:
region
- the value to set- Returns:
- the dsl builder
-
replyToAddresses
default Ses2EndpointBuilderFactory.Ses2EndpointBuilder replyToAddresses(String replyToAddresses)
List of comma separated reply-to email address(es) for the message, override it using 'CamelAwsSesReplyToAddresses' header. The option is a: <code>java.lang.String</code> type. Group: producer- Parameters:
replyToAddresses
- the value to set- Returns:
- the dsl builder
-
returnPath
default Ses2EndpointBuilderFactory.Ses2EndpointBuilder returnPath(String returnPath)
The email address to which bounce notifications are to be forwarded, override it using 'CamelAwsSesReturnPath' header. The option is a: <code>java.lang.String</code> type. Group: producer- Parameters:
returnPath
- the value to set- Returns:
- the dsl builder
-
subject
default Ses2EndpointBuilderFactory.Ses2EndpointBuilder subject(String subject)
The subject which is used if the message header 'CamelAwsSesSubject' is not present. The option is a: <code>java.lang.String</code> type. Group: producer- Parameters:
subject
- the value to set- Returns:
- the dsl builder
-
to
default Ses2EndpointBuilderFactory.Ses2EndpointBuilder to(String to)
List of comma separated destination email address. Can be overriden with 'CamelAwsSesTo' header. The option is a: <code>java.lang.String</code> type. Group: producer- Parameters:
to
- the value to set- Returns:
- the dsl builder
-
trustAllCertificates
default Ses2EndpointBuilderFactory.Ses2EndpointBuilder 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: producer- Parameters:
trustAllCertificates
- the value to set- Returns:
- the dsl builder
-
trustAllCertificates
default Ses2EndpointBuilderFactory.Ses2EndpointBuilder trustAllCertificates(String trustAllCertificates)
If we want to trust all certificates in case of overriding the endpoint. The option will be converted to a <code>boolean</code> type. Default: false Group: producer- Parameters:
trustAllCertificates
- the value to set- Returns:
- the dsl builder
-
uriEndpointOverride
default Ses2EndpointBuilderFactory.Ses2EndpointBuilder 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: producer- Parameters:
uriEndpointOverride
- the value to set- Returns:
- the dsl builder
-
useDefaultCredentialsProvider
default Ses2EndpointBuilderFactory.Ses2EndpointBuilder useDefaultCredentialsProvider(boolean useDefaultCredentialsProvider)
Set whether the Ses 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: producer- Parameters:
useDefaultCredentialsProvider
- the value to set- Returns:
- the dsl builder
-
useDefaultCredentialsProvider
default Ses2EndpointBuilderFactory.Ses2EndpointBuilder useDefaultCredentialsProvider(String useDefaultCredentialsProvider)
Set whether the Ses 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 <code>boolean</code> type. Default: false Group: producer- Parameters:
useDefaultCredentialsProvider
- the value to set- Returns:
- the dsl builder
-
accessKey
default Ses2EndpointBuilderFactory.Ses2EndpointBuilder 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 Ses2EndpointBuilderFactory.Ses2EndpointBuilder 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
-
-