Package org.apache.camel.builder.endpoint.dsl

Interface Kinesis2EndpointBuilderFactory.Kinesis2EndpointBuilder

All Superinterfaces:

org.apache.camel.builder.EndpointConsumerBuilder, org.apache.camel.EndpointConsumerResolver, org.apache.camel.builder.EndpointProducerBuilder, org.apache.camel.EndpointProducerResolver, Kinesis2EndpointBuilderFactory.Kinesis2EndpointConsumerBuilder, Kinesis2EndpointBuilderFactory.Kinesis2EndpointProducerBuilder

Enclosing interface:

Kinesis2EndpointBuilderFactory

public static interface Kinesis2EndpointBuilderFactory.Kinesis2EndpointBuilder
extends Kinesis2EndpointBuilderFactory.Kinesis2EndpointConsumerBuilder, Kinesis2EndpointBuilderFactory.Kinesis2EndpointProducerBuilder

Builder for endpoint for the AWS Kinesis component.

Method Summary

Modifier and Type	Method	Description
default Kinesis2EndpointBuilderFactory.Kinesis2EndpointBuilder	accessKey(String accessKey)	Amazon AWS Access Key.
default Kinesis2EndpointBuilderFactory.AdvancedKinesis2EndpointBuilder	advanced()
default Kinesis2EndpointBuilderFactory.Kinesis2EndpointBuilder	cborEnabled(boolean cborEnabled)	This option will set the CBOR_ENABLED property during the execution.
default Kinesis2EndpointBuilderFactory.Kinesis2EndpointBuilder	cborEnabled(String cborEnabled)	This option will set the CBOR_ENABLED property during the execution.
default Kinesis2EndpointBuilderFactory.Kinesis2EndpointBuilder	overrideEndpoint(boolean overrideEndpoint)	Set the need for overidding the endpoint.
default Kinesis2EndpointBuilderFactory.Kinesis2EndpointBuilder	overrideEndpoint(String overrideEndpoint)	Set the need for overidding the endpoint.
default Kinesis2EndpointBuilderFactory.Kinesis2EndpointBuilder	profileCredentialsName(String profileCredentialsName)	If using a profile credentials provider this parameter will set the profile name.
default Kinesis2EndpointBuilderFactory.Kinesis2EndpointBuilder	proxyHost(String proxyHost)	To define a proxy host when instantiating the Kinesis client.
default Kinesis2EndpointBuilderFactory.Kinesis2EndpointBuilder	proxyPort(Integer proxyPort)	To define a proxy port when instantiating the Kinesis client.
default Kinesis2EndpointBuilderFactory.Kinesis2EndpointBuilder	proxyPort(String proxyPort)	To define a proxy port when instantiating the Kinesis client.
default Kinesis2EndpointBuilderFactory.Kinesis2EndpointBuilder	proxyProtocol(String proxyProtocol)	To define a proxy protocol when instantiating the Kinesis client.
default Kinesis2EndpointBuilderFactory.Kinesis2EndpointBuilder	proxyProtocol(software.amazon.awssdk.core.Protocol proxyProtocol)	To define a proxy protocol when instantiating the Kinesis client.
default Kinesis2EndpointBuilderFactory.Kinesis2EndpointBuilder	region(String region)	The region in which Kinesis Firehose client needs to work.
default Kinesis2EndpointBuilderFactory.Kinesis2EndpointBuilder	secretKey(String secretKey)	Amazon AWS Secret Key.
default Kinesis2EndpointBuilderFactory.Kinesis2EndpointBuilder	trustAllCertificates(boolean trustAllCertificates)	If we want to trust all certificates in case of overriding the endpoint.
default Kinesis2EndpointBuilderFactory.Kinesis2EndpointBuilder	trustAllCertificates(String trustAllCertificates)	If we want to trust all certificates in case of overriding the endpoint.
default Kinesis2EndpointBuilderFactory.Kinesis2EndpointBuilder	uriEndpointOverride(String uriEndpointOverride)	Set the overriding uri endpoint.
default Kinesis2EndpointBuilderFactory.Kinesis2EndpointBuilder	useDefaultCredentialsProvider(boolean useDefaultCredentialsProvider)	Set whether the Kinesis client should expect to load credentials through a default credentials provider or to expect static credentials to be passed in.
default Kinesis2EndpointBuilderFactory.Kinesis2EndpointBuilder	useDefaultCredentialsProvider(String useDefaultCredentialsProvider)	Set whether the Kinesis client should expect to load credentials through a default credentials provider or to expect static credentials to be passed in.
default Kinesis2EndpointBuilderFactory.Kinesis2EndpointBuilder	useProfileCredentialsProvider(boolean useProfileCredentialsProvider)	Set whether the Kinesis client should expect to load credentials through a profile credentials provider.
default Kinesis2EndpointBuilderFactory.Kinesis2EndpointBuilder	useProfileCredentialsProvider(String useProfileCredentialsProvider)	Set whether the Kinesis client should expect to load credentials through a profile credentials provider.

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

doSetMultiValueProperties, doSetMultiValueProperty, doSetProperty, expr, getRawUri, getUri

Methods inherited from interface org.apache.camel.EndpointConsumerResolver

resolve, resolve

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

doSetMultiValueProperties, doSetMultiValueProperty, doSetProperty, expr, getRawUri, getUri

Methods inherited from interface org.apache.camel.EndpointProducerResolver

resolve, resolve

Methods inherited from interface org.apache.camel.builder.endpoint.dsl.Kinesis2EndpointBuilderFactory.Kinesis2EndpointConsumerBuilder

backoffErrorThreshold, backoffErrorThreshold, backoffIdleThreshold, backoffIdleThreshold, backoffMultiplier, backoffMultiplier, delay, delay, greedy, greedy, initialDelay, initialDelay, iteratorType, iteratorType, maxResultsPerRequest, maxResultsPerRequest, repeatCount, repeatCount, runLoggingLevel, runLoggingLevel, scheduledExecutorService, scheduledExecutorService, scheduler, scheduler, schedulerProperties, schedulerProperties, sendEmptyMessageWhenIdle, sendEmptyMessageWhenIdle, sequenceNumber, shardClosed, shardClosed, shardId, startScheduler, startScheduler, timeUnit, timeUnit, useFixedDelay, useFixedDelay

Method Details

advanced

default Kinesis2EndpointBuilderFactory.AdvancedKinesis2EndpointBuilder advanced()

Specified by:

advanced in interface Kinesis2EndpointBuilderFactory.Kinesis2EndpointConsumerBuilder

Specified by:

advanced in interface Kinesis2EndpointBuilderFactory.Kinesis2EndpointProducerBuilder

cborEnabled

default Kinesis2EndpointBuilderFactory.Kinesis2EndpointBuilder cborEnabled(boolean cborEnabled)

This option will set the CBOR_ENABLED property during the execution. The option is a: <code>boolean</code> type. Default: true Group: common

Specified by:

cborEnabled in interface Kinesis2EndpointBuilderFactory.Kinesis2EndpointConsumerBuilder

Specified by:

cborEnabled in interface Kinesis2EndpointBuilderFactory.Kinesis2EndpointProducerBuilder

Parameters:

cborEnabled - the value to set

Returns:

the dsl builder

cborEnabled

default Kinesis2EndpointBuilderFactory.Kinesis2EndpointBuilder cborEnabled(String cborEnabled)

This option will set the CBOR_ENABLED property during the execution. The option will be converted to a <code>boolean</code> type. Default: true Group: common

Specified by:

cborEnabled in interface Kinesis2EndpointBuilderFactory.Kinesis2EndpointConsumerBuilder

Specified by:

cborEnabled in interface Kinesis2EndpointBuilderFactory.Kinesis2EndpointProducerBuilder

Parameters:

cborEnabled - the value to set

Returns:

the dsl builder

overrideEndpoint

default Kinesis2EndpointBuilderFactory.Kinesis2EndpointBuilder 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: common

Specified by:

overrideEndpoint in interface Kinesis2EndpointBuilderFactory.Kinesis2EndpointConsumerBuilder

Specified by:

overrideEndpoint in interface Kinesis2EndpointBuilderFactory.Kinesis2EndpointProducerBuilder

Parameters:

overrideEndpoint - the value to set

Returns:

the dsl builder

overrideEndpoint

default Kinesis2EndpointBuilderFactory.Kinesis2EndpointBuilder 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: common

Specified by:

overrideEndpoint in interface Kinesis2EndpointBuilderFactory.Kinesis2EndpointConsumerBuilder

Specified by:

overrideEndpoint in interface Kinesis2EndpointBuilderFactory.Kinesis2EndpointProducerBuilder

Parameters:

overrideEndpoint - the value to set

Returns:

the dsl builder

region

default Kinesis2EndpointBuilderFactory.Kinesis2EndpointBuilder region(String region)

The region in which Kinesis Firehose 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: common

Specified by:

region in interface Kinesis2EndpointBuilderFactory.Kinesis2EndpointConsumerBuilder

Specified by:

region in interface Kinesis2EndpointBuilderFactory.Kinesis2EndpointProducerBuilder

Parameters:

region - the value to set

Returns:

the dsl builder

uriEndpointOverride

default Kinesis2EndpointBuilderFactory.Kinesis2EndpointBuilder 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: common

Specified by:

uriEndpointOverride in interface Kinesis2EndpointBuilderFactory.Kinesis2EndpointConsumerBuilder

Specified by:

uriEndpointOverride in interface Kinesis2EndpointBuilderFactory.Kinesis2EndpointProducerBuilder

Parameters:

uriEndpointOverride - the value to set

Returns:

the dsl builder

proxyHost

default Kinesis2EndpointBuilderFactory.Kinesis2EndpointBuilder proxyHost(String proxyHost)

To define a proxy host when instantiating the Kinesis client. The option is a: <code>java.lang.String</code> type. Group: proxy

Specified by:

proxyHost in interface Kinesis2EndpointBuilderFactory.Kinesis2EndpointConsumerBuilder

Specified by:

proxyHost in interface Kinesis2EndpointBuilderFactory.Kinesis2EndpointProducerBuilder

Parameters:

proxyHost - the value to set

Returns:

the dsl builder

proxyPort

default Kinesis2EndpointBuilderFactory.Kinesis2EndpointBuilder proxyPort(Integer proxyPort)

To define a proxy port when instantiating the Kinesis client. The option is a: <code>java.lang.Integer</code> type. Group: proxy

Specified by:

proxyPort in interface Kinesis2EndpointBuilderFactory.Kinesis2EndpointConsumerBuilder

Specified by:

proxyPort in interface Kinesis2EndpointBuilderFactory.Kinesis2EndpointProducerBuilder

Parameters:

proxyPort - the value to set

Returns:

the dsl builder

proxyPort

default Kinesis2EndpointBuilderFactory.Kinesis2EndpointBuilder proxyPort(String proxyPort)

To define a proxy port when instantiating the Kinesis client. The option will be converted to a <code>java.lang.Integer</code> type. Group: proxy

Specified by:

proxyPort in interface Kinesis2EndpointBuilderFactory.Kinesis2EndpointConsumerBuilder

Specified by:

proxyPort in interface Kinesis2EndpointBuilderFactory.Kinesis2EndpointProducerBuilder

Parameters:

proxyPort - the value to set

Returns:

the dsl builder

proxyProtocol

default Kinesis2EndpointBuilderFactory.Kinesis2EndpointBuilder proxyProtocol(software.amazon.awssdk.core.Protocol proxyProtocol)

To define a proxy protocol when instantiating the Kinesis client. The option is a: <code>software.amazon.awssdk.core.Protocol</code> type. Default: HTTPS Group: proxy

Specified by:

proxyProtocol in interface Kinesis2EndpointBuilderFactory.Kinesis2EndpointConsumerBuilder

Specified by:

proxyProtocol in interface Kinesis2EndpointBuilderFactory.Kinesis2EndpointProducerBuilder

Parameters:

proxyProtocol - the value to set

Returns:

the dsl builder

proxyProtocol

default Kinesis2EndpointBuilderFactory.Kinesis2EndpointBuilder proxyProtocol(String proxyProtocol)

To define a proxy protocol when instantiating the Kinesis client. The option will be converted to a <code>software.amazon.awssdk.core.Protocol</code> type. Default: HTTPS Group: proxy

Specified by:

proxyProtocol in interface Kinesis2EndpointBuilderFactory.Kinesis2EndpointConsumerBuilder

Specified by:

proxyProtocol in interface Kinesis2EndpointBuilderFactory.Kinesis2EndpointProducerBuilder

Parameters:

proxyProtocol - the value to set

Returns:

the dsl builder

accessKey

default Kinesis2EndpointBuilderFactory.Kinesis2EndpointBuilder accessKey(String accessKey)

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

Specified by:

accessKey in interface Kinesis2EndpointBuilderFactory.Kinesis2EndpointConsumerBuilder

Specified by:

accessKey in interface Kinesis2EndpointBuilderFactory.Kinesis2EndpointProducerBuilder

Parameters:

accessKey - the value to set

Returns:

the dsl builder

profileCredentialsName

default Kinesis2EndpointBuilderFactory.Kinesis2EndpointBuilder profileCredentialsName(String profileCredentialsName)

If using a profile credentials provider this parameter will set the profile name. The option is a: <code>java.lang.String</code> type. Group: security

Specified by:

profileCredentialsName in interface Kinesis2EndpointBuilderFactory.Kinesis2EndpointConsumerBuilder

Specified by:

profileCredentialsName in interface Kinesis2EndpointBuilderFactory.Kinesis2EndpointProducerBuilder

Parameters:

profileCredentialsName - the value to set

Returns:

the dsl builder

secretKey

default Kinesis2EndpointBuilderFactory.Kinesis2EndpointBuilder secretKey(String secretKey)

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

Specified by:

secretKey in interface Kinesis2EndpointBuilderFactory.Kinesis2EndpointConsumerBuilder

Specified by:

secretKey in interface Kinesis2EndpointBuilderFactory.Kinesis2EndpointProducerBuilder

Parameters:

secretKey - the value to set

Returns:

the dsl builder

trustAllCertificates

default Kinesis2EndpointBuilderFactory.Kinesis2EndpointBuilder 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: security

Specified by:

trustAllCertificates in interface Kinesis2EndpointBuilderFactory.Kinesis2EndpointConsumerBuilder

Specified by:

trustAllCertificates in interface Kinesis2EndpointBuilderFactory.Kinesis2EndpointProducerBuilder

Parameters:

trustAllCertificates - the value to set

Returns:

the dsl builder

trustAllCertificates

default Kinesis2EndpointBuilderFactory.Kinesis2EndpointBuilder 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: security

Specified by:

trustAllCertificates in interface Kinesis2EndpointBuilderFactory.Kinesis2EndpointConsumerBuilder

Specified by:

trustAllCertificates in interface Kinesis2EndpointBuilderFactory.Kinesis2EndpointProducerBuilder

Parameters:

trustAllCertificates - the value to set

Returns:

the dsl builder

useDefaultCredentialsProvider

default Kinesis2EndpointBuilderFactory.Kinesis2EndpointBuilder useDefaultCredentialsProvider(boolean useDefaultCredentialsProvider)

Set whether the Kinesis 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: security

Specified by:

useDefaultCredentialsProvider in interface Kinesis2EndpointBuilderFactory.Kinesis2EndpointConsumerBuilder

Specified by:

useDefaultCredentialsProvider in interface Kinesis2EndpointBuilderFactory.Kinesis2EndpointProducerBuilder

Parameters:

useDefaultCredentialsProvider - the value to set

Returns:

the dsl builder

useDefaultCredentialsProvider

default Kinesis2EndpointBuilderFactory.Kinesis2EndpointBuilder useDefaultCredentialsProvider(String useDefaultCredentialsProvider)

Set whether the Kinesis 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: security

Specified by:

useDefaultCredentialsProvider in interface Kinesis2EndpointBuilderFactory.Kinesis2EndpointConsumerBuilder

Specified by:

useDefaultCredentialsProvider in interface Kinesis2EndpointBuilderFactory.Kinesis2EndpointProducerBuilder

Parameters:

useDefaultCredentialsProvider - the value to set

Returns:

the dsl builder

useProfileCredentialsProvider

default Kinesis2EndpointBuilderFactory.Kinesis2EndpointBuilder useProfileCredentialsProvider(boolean useProfileCredentialsProvider)

Set whether the Kinesis client should expect to load credentials through a profile credentials provider. The option is a: <code>boolean</code> type. Default: false Group: security

Specified by:

useProfileCredentialsProvider in interface Kinesis2EndpointBuilderFactory.Kinesis2EndpointConsumerBuilder

Specified by:

useProfileCredentialsProvider in interface Kinesis2EndpointBuilderFactory.Kinesis2EndpointProducerBuilder

Parameters:

useProfileCredentialsProvider - the value to set

Returns:

the dsl builder

useProfileCredentialsProvider

default Kinesis2EndpointBuilderFactory.Kinesis2EndpointBuilder useProfileCredentialsProvider(String useProfileCredentialsProvider)

Set whether the Kinesis client should expect to load credentials through a profile credentials provider. The option will be converted to a <code>boolean</code> type. Default: false Group: security

Specified by:

useProfileCredentialsProvider in interface Kinesis2EndpointBuilderFactory.Kinesis2EndpointConsumerBuilder

Specified by:

useProfileCredentialsProvider in interface Kinesis2EndpointBuilderFactory.Kinesis2EndpointProducerBuilder

Parameters:

useProfileCredentialsProvider - the value to set

Returns:

the dsl builder