MSKEndpointBuilderFactory.MSKEndpointBuilder (Camel

All Superinterfaces:

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

Enclosing interface:

MSKEndpointBuilderFactory
```
public static interface MSKEndpointBuilderFactory.MSKEndpointBuilder
extends org.apache.camel.builder.EndpointProducerBuilder
```
Builder for endpoint for the AWS Managed Streaming for Apache Kafka (MSK) component.

Method Summary

All Methods Instance Methods Default Methods
Modifier and Type	Method and Description
`default MSKEndpointBuilderFactory.MSKEndpointBuilder`	`accessKey(String accessKey)` Amazon AWS Access Key.
`default MSKEndpointBuilderFactory.AdvancedMSKEndpointBuilder`	`advanced()`
`default MSKEndpointBuilderFactory.MSKEndpointBuilder`	`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 MSKEndpointBuilderFactory.MSKEndpointBuilder`	`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 MSKEndpointBuilderFactory.MSKEndpointBuilder`	`lazyStartProducer(boolean lazyStartProducer)` Whether the producer should be started lazy (on the first message).
`default MSKEndpointBuilderFactory.MSKEndpointBuilder`	`lazyStartProducer(String lazyStartProducer)` Whether the producer should be started lazy (on the first message).
`default MSKEndpointBuilderFactory.MSKEndpointBuilder`	`mskClient(Object mskClient)` To use a existing configured AWS MSK as client.
`default MSKEndpointBuilderFactory.MSKEndpointBuilder`	`mskClient(String mskClient)` To use a existing configured AWS MSK as client.
`default MSKEndpointBuilderFactory.MSKEndpointBuilder`	`operation(MSKEndpointBuilderFactory.MSKOperations operation)` The operation to perform.
`default MSKEndpointBuilderFactory.MSKEndpointBuilder`	`operation(String operation)` The operation to perform.
`default MSKEndpointBuilderFactory.MSKEndpointBuilder`	`proxyHost(String proxyHost)` To define a proxy host when instantiating the MSK client.
`default MSKEndpointBuilderFactory.MSKEndpointBuilder`	`proxyPort(Integer proxyPort)` To define a proxy port when instantiating the MSK client.
`default MSKEndpointBuilderFactory.MSKEndpointBuilder`	`proxyPort(String proxyPort)` To define a proxy port when instantiating the MSK client.
`default MSKEndpointBuilderFactory.MSKEndpointBuilder`	`proxyProtocol(MSKEndpointBuilderFactory.Protocol proxyProtocol)` To define a proxy protocol when instantiating the MSK client.
`default MSKEndpointBuilderFactory.MSKEndpointBuilder`	`proxyProtocol(String proxyProtocol)` To define a proxy protocol when instantiating the MSK client.
`default MSKEndpointBuilderFactory.MSKEndpointBuilder`	`region(String region)` The region in which MSK client needs to work.
`default MSKEndpointBuilderFactory.MSKEndpointBuilder`	`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 MSKEndpointBuilderFactory.AdvancedMSKEndpointBuilder advanced()
```
  - autoDiscoverClient
```
default MSKEndpointBuilderFactory.MSKEndpointBuilder 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 MSKEndpointBuilderFactory.MSKEndpointBuilder 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 MSKEndpointBuilderFactory.MSKEndpointBuilder 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
  - lazyStartProducer
```
default MSKEndpointBuilderFactory.MSKEndpointBuilder 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 MSKEndpointBuilderFactory.MSKEndpointBuilder 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
  - mskClient
```
default MSKEndpointBuilderFactory.MSKEndpointBuilder mskClient(Object mskClient)
```
    To use a existing configured AWS MSK as client. The option is a: <code>com.amazonaws.services.kafka.AWSKafka</code> type. Group: producer
    
    Parameters:
    
    mskClient - the value to set
    
    Returns:
    
    the dsl builder
  - mskClient
```
default MSKEndpointBuilderFactory.MSKEndpointBuilder mskClient(String mskClient)
```
    To use a existing configured AWS MSK as client. The option will be converted to a <code>com.amazonaws.services.kafka.AWSKafka</code> type. Group: producer
    
    Parameters:
    
    mskClient - the value to set
    
    Returns:
    
    the dsl builder
  - operation
```
default MSKEndpointBuilderFactory.MSKEndpointBuilder operation(MSKEndpointBuilderFactory.MSKOperations operation)
```
    The operation to perform. The option is a: <code>org.apache.camel.component.aws.msk.MSKOperations</code> type. Required: true Group: producer
    
    Parameters:
    
    operation - the value to set
    
    Returns:
    
    the dsl builder
  - operation
```
default MSKEndpointBuilderFactory.MSKEndpointBuilder operation(String operation)
```
    The operation to perform. The option will be converted to a <code>org.apache.camel.component.aws.msk.MSKOperations</code> type. Required: true Group: producer
    
    Parameters:
    
    operation - the value to set
    
    Returns:
    
    the dsl builder
  - proxyHost
```
default MSKEndpointBuilderFactory.MSKEndpointBuilder proxyHost(String proxyHost)
```
    To define a proxy host when instantiating the MSK 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 MSKEndpointBuilderFactory.MSKEndpointBuilder proxyPort(Integer proxyPort)
```
    To define a proxy port when instantiating the MSK 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 MSKEndpointBuilderFactory.MSKEndpointBuilder proxyPort(String proxyPort)
```
    To define a proxy port when instantiating the MSK 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 MSKEndpointBuilderFactory.MSKEndpointBuilder proxyProtocol(MSKEndpointBuilderFactory.Protocol proxyProtocol)
```
    To define a proxy protocol when instantiating the MSK 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 MSKEndpointBuilderFactory.MSKEndpointBuilder proxyProtocol(String proxyProtocol)
```
    To define a proxy protocol when instantiating the MSK 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 MSKEndpointBuilderFactory.MSKEndpointBuilder region(String region)
```
    The region in which MSK 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 MSKEndpointBuilderFactory.MSKEndpointBuilder 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

Interface MSKEndpointBuilderFactory.MSKEndpointBuilder

Method Summary

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

Methods inherited from interface org.apache.camel.EndpointProducerResolver

Method Detail

advanced

autoDiscoverClient

autoDiscoverClient

accessKey

lazyStartProducer

lazyStartProducer

mskClient

mskClient

operation

operation

proxyHost

proxyPort

proxyPort

proxyProtocol

proxyProtocol

region

secretKey