SnsEndpointBuilderFactory.SnsEndpointBuilder (Camel

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 and 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(org.apache.camel.spi.HeaderFilterStrategy headerFilterStrategy)` To use a custom HeaderFilterStrategy to map headers to/from Camel.
`default SnsEndpointBuilderFactory.SnsEndpointBuilder`	`headerFilterStrategy(String 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(SnsEndpointBuilderFactory.Protocol proxyProtocol)` To define a proxy protocol when instantiating the SNS client.
`default SnsEndpointBuilderFactory.SnsEndpointBuilder`	`proxyProtocol(String 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.

Methods inherited from interface org.apache.camel.builder.EndpointProducerBuilder
doSetMultiValueProperties, doSetMultiValueProperty, doSetProperty, expr, expr, getUri

Methods inherited from interface org.apache.camel.EndpointProducerResolver
resolve, resolve

- 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: <code>com.amazonaws.services.sns.AmazonSNS</code> type. Group: producer
    
    Parameters:
    
    amazonSNSClient - the value to set
    
    Returns:
    
    the dsl builder
  - amazonSNSClient
```
default SnsEndpointBuilderFactory.SnsEndpointBuilder amazonSNSClient(String amazonSNSClient)
```
    To use the AmazonSNS as the client. The option will be converted to a <code>com.amazonaws.services.sns.AmazonSNS</code> type. Group: producer
    
    Parameters:
    
    amazonSNSClient - the value to set
    
    Returns:
    
    the dsl builder
  - amazonSQSClient
```
default SnsEndpointBuilderFactory.SnsEndpointBuilder amazonSQSClient(Object amazonSQSClient)
```
    An SQS Client to use as bridge between SNS and SQS. The option is a: <code>com.amazonaws.services.sqs.AmazonSQS</code> type. Group: producer
    
    Parameters:
    
    amazonSQSClient - the value to set
    
    Returns:
    
    the dsl builder
  - amazonSQSClient
```
default SnsEndpointBuilderFactory.SnsEndpointBuilder amazonSQSClient(String amazonSQSClient)
```
    An SQS Client to use as bridge between SNS and SQS. The option will be converted to a <code>com.amazonaws.services.sqs.AmazonSQS</code> type. Group: producer
    
    Parameters:
    
    amazonSQSClient - the value to set
    
    Returns:
    
    the dsl builder
  - autoCreateTopic
```
default SnsEndpointBuilderFactory.SnsEndpointBuilder autoCreateTopic(boolean autoCreateTopic)
```
    Setting the autocreation of the topic. The option is a: <code>boolean</code> type. Default: true Group: producer
    
    Parameters:
    
    autoCreateTopic - the value to set
    
    Returns:
    
    the dsl builder
  - autoCreateTopic
```
default SnsEndpointBuilderFactory.SnsEndpointBuilder autoCreateTopic(String autoCreateTopic)
```
    Setting the autocreation of the topic. The option will be converted to a <code>boolean</code> type. Default: true Group: producer
    
    Parameters:
    
    autoCreateTopic - the value to set
    
    Returns:
    
    the dsl builder
  - 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: <code>boolean</code> type. Default: true Group: common
    
    Parameters:
    
    autoDiscoverClient - the value to set
    
    Returns:
    
    the dsl builder
  - 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 a <code>boolean</code> type. Default: true Group: common
    
    Parameters:
    
    autoDiscoverClient - the value to set
    
    Returns:
    
    the dsl builder
  - 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: <code>org.apache.camel.spi.HeaderFilterStrategy</code> type. Group: producer
    
    Parameters:
    
    headerFilterStrategy - the value to set
    
    Returns:
    
    the dsl builder
  - headerFilterStrategy
```
default SnsEndpointBuilderFactory.SnsEndpointBuilder headerFilterStrategy(String headerFilterStrategy)
```
    To use a custom HeaderFilterStrategy to map headers to/from Camel. The option will be converted to a <code>org.apache.camel.spi.HeaderFilterStrategy</code> type. Group: producer
    
    Parameters:
    
    headerFilterStrategy - the value to set
    
    Returns:
    
    the dsl builder
  - 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: <code>java.lang.String</code> type. Group: producer
    
    Parameters:
    
    kmsMasterKeyId - the value to set
    
    Returns:
    
    the dsl builder
  - 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: <code>boolean</code> type. Default: false Group: producer
    
    Parameters:
    
    lazyStartProducer - the value to set
    
    Returns:
    
    the dsl builder
  - 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 a <code>boolean</code> type. Default: false Group: producer
    
    Parameters:
    
    lazyStartProducer - the value to set
    
    Returns:
    
    the dsl builder
  - messageStructure
```
default SnsEndpointBuilderFactory.SnsEndpointBuilder messageStructure(String messageStructure)
```
    The message structure to use such as json. The option is a: <code>java.lang.String</code> type. Group: producer
    
    Parameters:
    
    messageStructure - the value to set
    
    Returns:
    
    the dsl builder
  - policy
```
default SnsEndpointBuilderFactory.SnsEndpointBuilder policy(String policy)
```
    The policy for this queue. The option is a: <code>java.lang.String</code> type. Group: producer
    
    Parameters:
    
    policy - the value to set
    
    Returns:
    
    the dsl builder
  - proxyHost
```
default SnsEndpointBuilderFactory.SnsEndpointBuilder proxyHost(String proxyHost)
```
    To define a proxy host when instantiating the SNS 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 SnsEndpointBuilderFactory.SnsEndpointBuilder proxyPort(Integer proxyPort)
```
    To define a proxy port when instantiating the SNS 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 SnsEndpointBuilderFactory.SnsEndpointBuilder proxyPort(String proxyPort)
```
    To define a proxy port when instantiating the SNS 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 SnsEndpointBuilderFactory.SnsEndpointBuilder proxyProtocol(SnsEndpointBuilderFactory.Protocol proxyProtocol)
```
    To define a proxy protocol when instantiating the SNS client. The option is a: <code>com.amazonaws.Protocol</code> type. Default: HTTPS Group: producer
    
    Parameters:
    
    proxyProtocol - the value to set
    
    Returns:
    
    the dsl builder
  - proxyProtocol
```
default SnsEndpointBuilderFactory.SnsEndpointBuilder proxyProtocol(String proxyProtocol)
```
    To define a proxy protocol when instantiating the SNS client. The option will be converted to a <code>com.amazonaws.Protocol</code> type. Default: HTTPS Group: producer
    
    Parameters:
    
    proxyProtocol - the value to set
    
    Returns:
    
    the dsl builder
  - queueUrl
```
default SnsEndpointBuilderFactory.SnsEndpointBuilder queueUrl(String queueUrl)
```
    The queueUrl to subscribe to. The option is a: <code>java.lang.String</code> type. Group: producer
    
    Parameters:
    
    queueUrl - the value to set
    
    Returns:
    
    the dsl builder
  - 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: <code>java.lang.String</code> type. Group: producer
    
    Parameters:
    
    region - the value to set
    
    Returns:
    
    the dsl builder
  - serverSideEncryptionEnabled
```
default SnsEndpointBuilderFactory.SnsEndpointBuilder serverSideEncryptionEnabled(boolean serverSideEncryptionEnabled)
```
    Define if Server Side Encryption is enabled or not on the topic. The option is a: <code>boolean</code> type. Default: false Group: producer
    
    Parameters:
    
    serverSideEncryptionEnabled - the value to set
    
    Returns:
    
    the dsl builder
  - 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 a <code>boolean</code> type. Default: false Group: producer
    
    Parameters:
    
    serverSideEncryptionEnabled - the value to set
    
    Returns:
    
    the dsl builder
  - subject
```
default SnsEndpointBuilderFactory.SnsEndpointBuilder subject(String subject)
```
    The subject which is used if the message header 'CamelAwsSnsSubject' 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
  - 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: <code>boolean</code> type. Default: false Group: producer
    
    Parameters:
    
    subscribeSNStoSQS - the value to set
    
    Returns:
    
    the dsl builder
  - 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 a <code>boolean</code> type. Default: false Group: producer
    
    Parameters:
    
    subscribeSNStoSQS - the value to set
    
    Returns:
    
    the dsl builder
  - accessKey
```
default SnsEndpointBuilderFactory.SnsEndpointBuilder 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 SnsEndpointBuilderFactory.SnsEndpointBuilder 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

Interface SnsEndpointBuilderFactory.SnsEndpointBuilder

Method Summary

Methods inherited from interface org.apache.camel.builder.EndpointProducerBuilder

Methods inherited from interface org.apache.camel.EndpointProducerResolver

Method Detail

advanced

amazonSNSClient

amazonSNSClient

amazonSQSClient

amazonSQSClient

autoCreateTopic

autoCreateTopic

autoDiscoverClient

autoDiscoverClient

headerFilterStrategy

headerFilterStrategy

kmsMasterKeyId

lazyStartProducer

lazyStartProducer

messageStructure

policy

proxyHost

proxyPort

proxyPort

proxyProtocol

proxyProtocol

queueUrl

region

serverSideEncryptionEnabled

serverSideEncryptionEnabled

subject

subscribeSNStoSQS

subscribeSNStoSQS

accessKey

secretKey