org.apache.camel.builder.endpoint.dsl

Interface MQEndpointBuilderFactory.MQEndpointBuilder

All Superinterfaces:

org.apache.camel.builder.EndpointProducerBuilder, org.apache.camel.EndpointProducerResolver

Enclosing interface:

MQEndpointBuilderFactory

public static interface MQEndpointBuilderFactory.MQEndpointBuilder
extends org.apache.camel.builder.EndpointProducerBuilder

Builder for endpoint for the AWS MQ component.

Method Summary

Modifier and Type	Method and Description
default MQEndpointBuilderFactory.MQEndpointBuilder	accessKey(String accessKey) Amazon AWS Access Key.
default MQEndpointBuilderFactory.AdvancedMQEndpointBuilder	advanced()
default MQEndpointBuilderFactory.MQEndpointBuilder	amazonMqClient(Object amazonMqClient) To use a existing configured AmazonMQClient as client.
default MQEndpointBuilderFactory.MQEndpointBuilder	amazonMqClient(String amazonMqClient) To use a existing configured AmazonMQClient as client.
default MQEndpointBuilderFactory.MQEndpointBuilder	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 MQEndpointBuilderFactory.MQEndpointBuilder	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 MQEndpointBuilderFactory.MQEndpointBuilder	lazyStartProducer(boolean lazyStartProducer) Whether the producer should be started lazy (on the first message).
default MQEndpointBuilderFactory.MQEndpointBuilder	lazyStartProducer(String lazyStartProducer) Whether the producer should be started lazy (on the first message).
default MQEndpointBuilderFactory.MQEndpointBuilder	operation(MQEndpointBuilderFactory.MQOperations operation) The operation to perform.
default MQEndpointBuilderFactory.MQEndpointBuilder	operation(String operation) The operation to perform.
default MQEndpointBuilderFactory.MQEndpointBuilder	proxyHost(String proxyHost) To define a proxy host when instantiating the MQ client.
default MQEndpointBuilderFactory.MQEndpointBuilder	proxyPort(Integer proxyPort) To define a proxy port when instantiating the MQ client.
default MQEndpointBuilderFactory.MQEndpointBuilder	proxyPort(String proxyPort) To define a proxy port when instantiating the MQ client.
default MQEndpointBuilderFactory.MQEndpointBuilder	proxyProtocol(MQEndpointBuilderFactory.Protocol proxyProtocol) To define a proxy protocol when instantiating the MQ client.
default MQEndpointBuilderFactory.MQEndpointBuilder	proxyProtocol(String proxyProtocol) To define a proxy protocol when instantiating the MQ client.
default MQEndpointBuilderFactory.MQEndpointBuilder	region(String region) The region in which MQ client needs to work.
default MQEndpointBuilderFactory.MQEndpointBuilder	secretKey(String secretKey) Amazon AWS Secret Key.

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 MQEndpointBuilderFactory.AdvancedMQEndpointBuilder advanced()

autoDiscoverClient

default MQEndpointBuilderFactory.MQEndpointBuilder 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 MQEndpointBuilderFactory.MQEndpointBuilder 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

accessKey

default MQEndpointBuilderFactory.MQEndpointBuilder accessKey(String accessKey)

Amazon AWS Access Key. The option is a: <code>java.lang.String</code> type. Group: producer

Parameters:

accessKey - the value to set

Returns:

the dsl builder

amazonMqClient

default MQEndpointBuilderFactory.MQEndpointBuilder amazonMqClient(Object amazonMqClient)

To use a existing configured AmazonMQClient as client. The option is a: <code>com.amazonaws.services.mq.AmazonMQ</code> type. Group: producer

Parameters:

amazonMqClient - the value to set

Returns:

the dsl builder

amazonMqClient

default MQEndpointBuilderFactory.MQEndpointBuilder amazonMqClient(String amazonMqClient)

To use a existing configured AmazonMQClient as client. The option will be converted to a <code>com.amazonaws.services.mq.AmazonMQ</code> type. Group: producer

Parameters:

amazonMqClient - the value to set

Returns:

the dsl builder

lazyStartProducer

default MQEndpointBuilderFactory.MQEndpointBuilder 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 MQEndpointBuilderFactory.MQEndpointBuilder 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

operation

default MQEndpointBuilderFactory.MQEndpointBuilder operation(MQEndpointBuilderFactory.MQOperations operation)

The operation to perform. It can be listBrokers,createBroker,deleteBroker. The option is a: <code>org.apache.camel.component.aws.mq.MQOperations</code> type. Required: true Group: producer

Parameters:

operation - the value to set

Returns:

the dsl builder

operation

default MQEndpointBuilderFactory.MQEndpointBuilder operation(String operation)

The operation to perform. It can be listBrokers,createBroker,deleteBroker. The option will be converted to a <code>org.apache.camel.component.aws.mq.MQOperations</code> type. Required: true Group: producer

Parameters:

operation - the value to set

Returns:

the dsl builder

proxyHost

default MQEndpointBuilderFactory.MQEndpointBuilder proxyHost(String proxyHost)

To define a proxy host when instantiating the MQ 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 MQEndpointBuilderFactory.MQEndpointBuilder proxyPort(Integer proxyPort)

To define a proxy port when instantiating the MQ 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 MQEndpointBuilderFactory.MQEndpointBuilder proxyPort(String proxyPort)

To define a proxy port when instantiating the MQ 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 MQEndpointBuilderFactory.MQEndpointBuilder proxyProtocol(MQEndpointBuilderFactory.Protocol proxyProtocol)

To define a proxy protocol when instantiating the MQ 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 MQEndpointBuilderFactory.MQEndpointBuilder proxyProtocol(String proxyProtocol)

To define a proxy protocol when instantiating the MQ 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

region

default MQEndpointBuilderFactory.MQEndpointBuilder region(String region)

The region in which MQ 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

secretKey

default MQEndpointBuilderFactory.MQEndpointBuilder secretKey(String secretKey)

Amazon AWS Secret Key. The option is a: <code>java.lang.String</code> type. Group: producer

Parameters:

secretKey - the value to set

Returns:

the dsl builder