Interface SnsEndpointBuilderFactory.SnsEndpointBuilder
-
- All Superinterfaces:
org.apache.camel.builder.EndpointProducerBuilder
,org.apache.camel.EndpointProducerResolver
- Enclosing interface:
- SnsEndpointBuilderFactory
public static interface SnsEndpointBuilderFactory.SnsEndpointBuilder extends org.apache.camel.builder.EndpointProducerBuilder
Builder for endpoint for the AWS Simple Notification System (SNS) component.
-
-
Method Summary
All Methods Instance Methods Default Methods Modifier and Type Method Description default SnsEndpointBuilderFactory.SnsEndpointBuilder
accessKey(String accessKey)
Amazon AWS Access Key.default SnsEndpointBuilderFactory.AdvancedSnsEndpointBuilder
advanced()
default SnsEndpointBuilderFactory.SnsEndpointBuilder
amazonSNSClient(Object amazonSNSClient)
To use the AmazonSNS as the client.default SnsEndpointBuilderFactory.SnsEndpointBuilder
amazonSNSClient(String amazonSNSClient)
To use the AmazonSNS as the client.default SnsEndpointBuilderFactory.SnsEndpointBuilder
amazonSQSClient(Object amazonSQSClient)
An SQS Client to use as bridge between SNS and SQS.default SnsEndpointBuilderFactory.SnsEndpointBuilder
amazonSQSClient(String amazonSQSClient)
An SQS Client to use as bridge between SNS and SQS.default SnsEndpointBuilderFactory.SnsEndpointBuilder
autoCreateTopic(boolean autoCreateTopic)
Setting the autocreation of the topic.default SnsEndpointBuilderFactory.SnsEndpointBuilder
autoCreateTopic(String autoCreateTopic)
Setting the autocreation of the topic.default SnsEndpointBuilderFactory.SnsEndpointBuilder
autoDiscoverClient(boolean autoDiscoverClient)
Setting the autoDiscoverClient mechanism, if true, the component will look for a client instance in the registry automatically otherwise it will skip that checking.default SnsEndpointBuilderFactory.SnsEndpointBuilder
autoDiscoverClient(String autoDiscoverClient)
Setting the autoDiscoverClient mechanism, if true, the component will look for a client instance in the registry automatically otherwise it will skip that checking.default SnsEndpointBuilderFactory.SnsEndpointBuilder
headerFilterStrategy(String headerFilterStrategy)
To use a custom HeaderFilterStrategy to map headers to/from Camel.default SnsEndpointBuilderFactory.SnsEndpointBuilder
headerFilterStrategy(org.apache.camel.spi.HeaderFilterStrategy headerFilterStrategy)
To use a custom HeaderFilterStrategy to map headers to/from Camel.default SnsEndpointBuilderFactory.SnsEndpointBuilder
kmsMasterKeyId(String kmsMasterKeyId)
The ID of an AWS-managed customer master key (CMK) for Amazon SNS or a custom CMK.default SnsEndpointBuilderFactory.SnsEndpointBuilder
lazyStartProducer(boolean lazyStartProducer)
Whether the producer should be started lazy (on the first message).default SnsEndpointBuilderFactory.SnsEndpointBuilder
lazyStartProducer(String lazyStartProducer)
Whether the producer should be started lazy (on the first message).default SnsEndpointBuilderFactory.SnsEndpointBuilder
messageStructure(String messageStructure)
The message structure to use such as json.default SnsEndpointBuilderFactory.SnsEndpointBuilder
policy(String policy)
The policy for this queue.default SnsEndpointBuilderFactory.SnsEndpointBuilder
proxyHost(String proxyHost)
To define a proxy host when instantiating the SNS client.default SnsEndpointBuilderFactory.SnsEndpointBuilder
proxyPort(Integer proxyPort)
To define a proxy port when instantiating the SNS client.default SnsEndpointBuilderFactory.SnsEndpointBuilder
proxyPort(String proxyPort)
To define a proxy port when instantiating the SNS client.default SnsEndpointBuilderFactory.SnsEndpointBuilder
proxyProtocol(String proxyProtocol)
To define a proxy protocol when instantiating the SNS client.default SnsEndpointBuilderFactory.SnsEndpointBuilder
proxyProtocol(SnsEndpointBuilderFactory.Protocol proxyProtocol)
To define a proxy protocol when instantiating the SNS client.default SnsEndpointBuilderFactory.SnsEndpointBuilder
queueUrl(String queueUrl)
The queueUrl to subscribe to.default SnsEndpointBuilderFactory.SnsEndpointBuilder
region(String region)
The region in which SNS client needs to work.default SnsEndpointBuilderFactory.SnsEndpointBuilder
secretKey(String secretKey)
Amazon AWS Secret Key.default SnsEndpointBuilderFactory.SnsEndpointBuilder
serverSideEncryptionEnabled(boolean serverSideEncryptionEnabled)
Define if Server Side Encryption is enabled or not on the topic.default SnsEndpointBuilderFactory.SnsEndpointBuilder
serverSideEncryptionEnabled(String serverSideEncryptionEnabled)
Define if Server Side Encryption is enabled or not on the topic.default SnsEndpointBuilderFactory.SnsEndpointBuilder
subject(String subject)
The subject which is used if the message header 'CamelAwsSnsSubject' is not present.default SnsEndpointBuilderFactory.SnsEndpointBuilder
subscribeSNStoSQS(boolean subscribeSNStoSQS)
Define if the subscription between SNS Topic and SQS must be done or not.default SnsEndpointBuilderFactory.SnsEndpointBuilder
subscribeSNStoSQS(String subscribeSNStoSQS)
Define if the subscription between SNS Topic and SQS must be done or not.
-
-
-
Method Detail
-
advanced
default SnsEndpointBuilderFactory.AdvancedSnsEndpointBuilder advanced()
-
amazonSNSClient
default SnsEndpointBuilderFactory.SnsEndpointBuilder amazonSNSClient(Object amazonSNSClient)
To use the AmazonSNS as the client. The option is a:com.amazonaws.services.sns.AmazonSNS
type. Group: producer
-
amazonSNSClient
default SnsEndpointBuilderFactory.SnsEndpointBuilder amazonSNSClient(String amazonSNSClient)
To use the AmazonSNS as the client. The option will be converted to acom.amazonaws.services.sns.AmazonSNS
type. Group: producer
-
amazonSQSClient
default SnsEndpointBuilderFactory.SnsEndpointBuilder amazonSQSClient(Object amazonSQSClient)
An SQS Client to use as bridge between SNS and SQS. The option is a:com.amazonaws.services.sqs.AmazonSQS
type. Group: producer
-
amazonSQSClient
default SnsEndpointBuilderFactory.SnsEndpointBuilder amazonSQSClient(String amazonSQSClient)
An SQS Client to use as bridge between SNS and SQS. The option will be converted to acom.amazonaws.services.sqs.AmazonSQS
type. Group: producer
-
autoCreateTopic
default SnsEndpointBuilderFactory.SnsEndpointBuilder autoCreateTopic(boolean autoCreateTopic)
Setting the autocreation of the topic. The option is a:boolean
type. Default: true Group: producer
-
autoCreateTopic
default SnsEndpointBuilderFactory.SnsEndpointBuilder autoCreateTopic(String autoCreateTopic)
Setting the autocreation of the topic. The option will be converted to aboolean
type. Default: true Group: producer
-
autoDiscoverClient
default SnsEndpointBuilderFactory.SnsEndpointBuilder autoDiscoverClient(boolean autoDiscoverClient)
Setting the autoDiscoverClient mechanism, if true, the component will look for a client instance in the registry automatically otherwise it will skip that checking. The option is a:boolean
type. Default: true Group: common
-
autoDiscoverClient
default SnsEndpointBuilderFactory.SnsEndpointBuilder autoDiscoverClient(String autoDiscoverClient)
Setting the autoDiscoverClient mechanism, if true, the component will look for a client instance in the registry automatically otherwise it will skip that checking. The option will be converted to aboolean
type. Default: true Group: common
-
headerFilterStrategy
default SnsEndpointBuilderFactory.SnsEndpointBuilder headerFilterStrategy(org.apache.camel.spi.HeaderFilterStrategy headerFilterStrategy)
To use a custom HeaderFilterStrategy to map headers to/from Camel. The option is a:org.apache.camel.spi.HeaderFilterStrategy
type. Group: producer
-
headerFilterStrategy
default SnsEndpointBuilderFactory.SnsEndpointBuilder headerFilterStrategy(String headerFilterStrategy)
To use a custom HeaderFilterStrategy to map headers to/from Camel. The option will be converted to aorg.apache.camel.spi.HeaderFilterStrategy
type. Group: producer
-
kmsMasterKeyId
default SnsEndpointBuilderFactory.SnsEndpointBuilder kmsMasterKeyId(String kmsMasterKeyId)
The ID of an AWS-managed customer master key (CMK) for Amazon SNS or a custom CMK. The option is a:java.lang.String
type. Group: producer
-
lazyStartProducer
default SnsEndpointBuilderFactory.SnsEndpointBuilder 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:boolean
type. Default: false Group: producer
-
lazyStartProducer
default SnsEndpointBuilderFactory.SnsEndpointBuilder 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 aboolean
type. Default: false Group: producer
-
messageStructure
default SnsEndpointBuilderFactory.SnsEndpointBuilder messageStructure(String messageStructure)
The message structure to use such as json. The option is a:java.lang.String
type. Group: producer
-
policy
default SnsEndpointBuilderFactory.SnsEndpointBuilder policy(String policy)
The policy for this queue. The option is a:java.lang.String
type. Group: producer
-
proxyHost
default SnsEndpointBuilderFactory.SnsEndpointBuilder proxyHost(String proxyHost)
To define a proxy host when instantiating the SNS client. The option is a:java.lang.String
type. Group: producer
-
proxyPort
default SnsEndpointBuilderFactory.SnsEndpointBuilder proxyPort(Integer proxyPort)
To define a proxy port when instantiating the SNS client. The option is a:java.lang.Integer
type. Group: producer
-
proxyPort
default SnsEndpointBuilderFactory.SnsEndpointBuilder proxyPort(String proxyPort)
To define a proxy port when instantiating the SNS client. The option will be converted to ajava.lang.Integer
type. Group: producer
-
proxyProtocol
default SnsEndpointBuilderFactory.SnsEndpointBuilder proxyProtocol(SnsEndpointBuilderFactory.Protocol proxyProtocol)
To define a proxy protocol when instantiating the SNS client. The option is a:com.amazonaws.Protocol
type. Default: HTTPS Group: producer
-
proxyProtocol
default SnsEndpointBuilderFactory.SnsEndpointBuilder proxyProtocol(String proxyProtocol)
To define a proxy protocol when instantiating the SNS client. The option will be converted to acom.amazonaws.Protocol
type. Default: HTTPS Group: producer
-
queueUrl
default SnsEndpointBuilderFactory.SnsEndpointBuilder queueUrl(String queueUrl)
The queueUrl to subscribe to. The option is a:java.lang.String
type. Group: producer
-
region
default SnsEndpointBuilderFactory.SnsEndpointBuilder region(String region)
The region in which SNS client needs to work. When using this parameter, the configuration will expect the capitalized name of the region (for example AP_EAST_1) You'll need to use the name Regions.EU_WEST_1.name(). The option is a:java.lang.String
type. Group: producer
-
serverSideEncryptionEnabled
default SnsEndpointBuilderFactory.SnsEndpointBuilder serverSideEncryptionEnabled(boolean serverSideEncryptionEnabled)
Define if Server Side Encryption is enabled or not on the topic. The option is a:boolean
type. Default: false Group: producer
-
serverSideEncryptionEnabled
default SnsEndpointBuilderFactory.SnsEndpointBuilder serverSideEncryptionEnabled(String serverSideEncryptionEnabled)
Define if Server Side Encryption is enabled or not on the topic. The option will be converted to aboolean
type. Default: false Group: producer
-
subject
default SnsEndpointBuilderFactory.SnsEndpointBuilder subject(String subject)
The subject which is used if the message header 'CamelAwsSnsSubject' is not present. The option is a:java.lang.String
type. Group: producer
-
subscribeSNStoSQS
default SnsEndpointBuilderFactory.SnsEndpointBuilder subscribeSNStoSQS(boolean subscribeSNStoSQS)
Define if the subscription between SNS Topic and SQS must be done or not. The option is a:boolean
type. Default: false Group: producer
-
subscribeSNStoSQS
default SnsEndpointBuilderFactory.SnsEndpointBuilder subscribeSNStoSQS(String subscribeSNStoSQS)
Define if the subscription between SNS Topic and SQS must be done or not. The option will be converted to aboolean
type. Default: false Group: producer
-
accessKey
default SnsEndpointBuilderFactory.SnsEndpointBuilder accessKey(String accessKey)
Amazon AWS Access Key. The option is a:java.lang.String
type. Group: security
-
secretKey
default SnsEndpointBuilderFactory.SnsEndpointBuilder secretKey(String secretKey)
Amazon AWS Secret Key. The option is a:java.lang.String
type. Group: security
-
-