Interface Kinesis2EndpointBuilderFactory.Kinesis2EndpointConsumerBuilder
- All Superinterfaces:
org.apache.camel.builder.EndpointConsumerBuilder
,org.apache.camel.EndpointConsumerResolver
- All Known Subinterfaces:
Kinesis2EndpointBuilderFactory.Kinesis2EndpointBuilder
- Enclosing interface:
Kinesis2EndpointBuilderFactory
public static interface Kinesis2EndpointBuilderFactory.Kinesis2EndpointConsumerBuilder
extends org.apache.camel.builder.EndpointConsumerBuilder
Builder for endpoint consumers for the AWS Kinesis component.
-
Method Summary
Modifier and TypeMethodDescriptionAmazon AWS Access Key.advanced()
backoffErrorThreshold
(int backoffErrorThreshold) The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in.backoffErrorThreshold
(String backoffErrorThreshold) The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in.backoffIdleThreshold
(int backoffIdleThreshold) The number of subsequent idle polls that should happen before the backoffMultipler should kick-in.backoffIdleThreshold
(String backoffIdleThreshold) The number of subsequent idle polls that should happen before the backoffMultipler should kick-in.backoffMultiplier
(int backoffMultiplier) To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row.backoffMultiplier
(String backoffMultiplier) To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row.cborEnabled
(boolean cborEnabled) This option will set the CBOR_ENABLED property during the execution.cborEnabled
(String cborEnabled) This option will set the CBOR_ENABLED property during the execution.delay
(long delay) Milliseconds before the next poll.Milliseconds before the next poll.greedy
(boolean greedy) If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages.If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages.initialDelay
(long initialDelay) Milliseconds before the first poll starts.initialDelay
(String initialDelay) Milliseconds before the first poll starts.iteratorType
(String iteratorType) Defines where in the Kinesis stream to start getting records.iteratorType
(software.amazon.awssdk.services.kinesis.model.ShardIteratorType iteratorType) Defines where in the Kinesis stream to start getting records.maxResultsPerRequest
(int maxResultsPerRequest) Maximum number of records that will be fetched in each poll.maxResultsPerRequest
(String maxResultsPerRequest) Maximum number of records that will be fetched in each poll.messageTimestamp
(String messageTimestamp) The message timestamp to start polling from.overrideEndpoint
(boolean overrideEndpoint) Set the need for overriding the endpoint.overrideEndpoint
(String overrideEndpoint) Set the need for overriding the endpoint.profileCredentialsName
(String profileCredentialsName) If using a profile credentials provider this parameter will set the profile name.To define a proxy host when instantiating the Kinesis client.To define a proxy port when instantiating the Kinesis client.To define a proxy port when instantiating the Kinesis client.proxyProtocol
(String proxyProtocol) To define a proxy protocol when instantiating the Kinesis client.proxyProtocol
(software.amazon.awssdk.core.Protocol proxyProtocol) To define a proxy protocol when instantiating the Kinesis client.The region in which Kinesis Firehose client needs to work.repeatCount
(long repeatCount) Specifies a maximum limit of number of fires.repeatCount
(String repeatCount) Specifies a maximum limit of number of fires.runLoggingLevel
(String runLoggingLevel) The consumer logs a start/complete log line when it polls.runLoggingLevel
(org.apache.camel.LoggingLevel runLoggingLevel) The consumer logs a start/complete log line when it polls.scheduledExecutorService
(String scheduledExecutorService) Allows for configuring a custom/shared thread pool to use for the consumer.scheduledExecutorService
(ScheduledExecutorService scheduledExecutorService) Allows for configuring a custom/shared thread pool to use for the consumer.To use a cron scheduler from either camel-spring or camel-quartz component.To use a cron scheduler from either camel-spring or camel-quartz component.schedulerProperties
(String key, Object value) To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler.schedulerProperties
(Map values) To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler.Amazon AWS Secret Key.sendEmptyMessageWhenIdle
(boolean sendEmptyMessageWhenIdle) If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead.sendEmptyMessageWhenIdle
(String sendEmptyMessageWhenIdle) If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead.sequenceNumber
(String sequenceNumber) The sequence number to start polling from.sessionToken
(String sessionToken) Amazon AWS Session Token used when the user needs to assume a IAM role.shardClosed
(String shardClosed) Define what will be the behavior in case of shard closed.shardClosed
(org.apache.camel.component.aws2.kinesis.Kinesis2ShardClosedStrategyEnum shardClosed) Define what will be the behavior in case of shard closed.Defines which shardId in the Kinesis stream to get records from.startScheduler
(boolean startScheduler) Whether the scheduler should be auto started.startScheduler
(String startScheduler) Whether the scheduler should be auto started.Time unit for initialDelay and delay options.Time unit for initialDelay and delay options.trustAllCertificates
(boolean trustAllCertificates) If we want to trust all certificates in case of overriding the endpoint.trustAllCertificates
(String trustAllCertificates) If we want to trust all certificates in case of overriding the endpoint.uriEndpointOverride
(String uriEndpointOverride) Set the overriding uri endpoint.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.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.useFixedDelay
(boolean useFixedDelay) Controls if fixed delay or fixed rate is used.useFixedDelay
(String useFixedDelay) Controls if fixed delay or fixed rate is used.useProfileCredentialsProvider
(boolean useProfileCredentialsProvider) Set whether the Kinesis client should expect to load credentials through a profile credentials provider.useProfileCredentialsProvider
(String useProfileCredentialsProvider) Set whether the Kinesis client should expect to load credentials through a profile credentials provider.useSessionCredentials
(boolean useSessionCredentials) Set whether the Kinesis client should expect to use Session Credentials.useSessionCredentials
(String useSessionCredentials) Set whether the Kinesis client should expect to use Session Credentials.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
-
Method Details
-
advanced
-
cborEnabled
default Kinesis2EndpointBuilderFactory.Kinesis2EndpointConsumerBuilder cborEnabled(boolean cborEnabled) This option will set the CBOR_ENABLED property during the execution. The option is a:boolean
type. Default: true Group: common- Parameters:
cborEnabled
- the value to set- Returns:
- the dsl builder
-
cborEnabled
default Kinesis2EndpointBuilderFactory.Kinesis2EndpointConsumerBuilder cborEnabled(String cborEnabled) This option will set the CBOR_ENABLED property during the execution. The option will be converted to aboolean
type. Default: true Group: common- Parameters:
cborEnabled
- the value to set- Returns:
- the dsl builder
-
overrideEndpoint
default Kinesis2EndpointBuilderFactory.Kinesis2EndpointConsumerBuilder overrideEndpoint(boolean overrideEndpoint) Set the need for overriding the endpoint. This option needs to be used in combination with uriEndpointOverride option. The option is a:boolean
type. Default: false Group: common- Parameters:
overrideEndpoint
- the value to set- Returns:
- the dsl builder
-
overrideEndpoint
default Kinesis2EndpointBuilderFactory.Kinesis2EndpointConsumerBuilder overrideEndpoint(String overrideEndpoint) Set the need for overriding the endpoint. This option needs to be used in combination with uriEndpointOverride option. The option will be converted to aboolean
type. Default: false Group: common- Parameters:
overrideEndpoint
- the value to set- Returns:
- the dsl builder
-
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:java.lang.String
type. Group: common- Parameters:
region
- the value to set- Returns:
- the dsl builder
-
uriEndpointOverride
default Kinesis2EndpointBuilderFactory.Kinesis2EndpointConsumerBuilder uriEndpointOverride(String uriEndpointOverride) Set the overriding uri endpoint. This option needs to be used in combination with overrideEndpoint option. The option is a:java.lang.String
type. Group: common- Parameters:
uriEndpointOverride
- the value to set- Returns:
- the dsl builder
-
iteratorType
default Kinesis2EndpointBuilderFactory.Kinesis2EndpointConsumerBuilder iteratorType(software.amazon.awssdk.services.kinesis.model.ShardIteratorType iteratorType) Defines where in the Kinesis stream to start getting records. The option is a:software.amazon.awssdk.services.kinesis.model.ShardIteratorType
type. Default: TRIM_HORIZON Group: consumer- Parameters:
iteratorType
- the value to set- Returns:
- the dsl builder
-
iteratorType
default Kinesis2EndpointBuilderFactory.Kinesis2EndpointConsumerBuilder iteratorType(String iteratorType) Defines where in the Kinesis stream to start getting records. The option will be converted to asoftware.amazon.awssdk.services.kinesis.model.ShardIteratorType
type. Default: TRIM_HORIZON Group: consumer- Parameters:
iteratorType
- the value to set- Returns:
- the dsl builder
-
maxResultsPerRequest
default Kinesis2EndpointBuilderFactory.Kinesis2EndpointConsumerBuilder maxResultsPerRequest(int maxResultsPerRequest) Maximum number of records that will be fetched in each poll. The option is a:int
type. Default: 1 Group: consumer- Parameters:
maxResultsPerRequest
- the value to set- Returns:
- the dsl builder
-
maxResultsPerRequest
default Kinesis2EndpointBuilderFactory.Kinesis2EndpointConsumerBuilder maxResultsPerRequest(String maxResultsPerRequest) Maximum number of records that will be fetched in each poll. The option will be converted to aint
type. Default: 1 Group: consumer- Parameters:
maxResultsPerRequest
- the value to set- Returns:
- the dsl builder
-
messageTimestamp
default Kinesis2EndpointBuilderFactory.Kinesis2EndpointConsumerBuilder messageTimestamp(String messageTimestamp) The message timestamp to start polling from. Required if iteratorType is set to AT_TIMESTAMP. The option is a:java.lang.String
type. Group: consumer- Parameters:
messageTimestamp
- the value to set- Returns:
- the dsl builder
-
sendEmptyMessageWhenIdle
default Kinesis2EndpointBuilderFactory.Kinesis2EndpointConsumerBuilder sendEmptyMessageWhenIdle(boolean sendEmptyMessageWhenIdle) If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead. The option is a:boolean
type. Default: false Group: consumer- Parameters:
sendEmptyMessageWhenIdle
- the value to set- Returns:
- the dsl builder
-
sendEmptyMessageWhenIdle
default Kinesis2EndpointBuilderFactory.Kinesis2EndpointConsumerBuilder sendEmptyMessageWhenIdle(String sendEmptyMessageWhenIdle) If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead. The option will be converted to aboolean
type. Default: false Group: consumer- Parameters:
sendEmptyMessageWhenIdle
- the value to set- Returns:
- the dsl builder
-
sequenceNumber
default Kinesis2EndpointBuilderFactory.Kinesis2EndpointConsumerBuilder sequenceNumber(String sequenceNumber) The sequence number to start polling from. Required if iteratorType is set to AFTER_SEQUENCE_NUMBER or AT_SEQUENCE_NUMBER. The option is a:java.lang.String
type. Group: consumer- Parameters:
sequenceNumber
- the value to set- Returns:
- the dsl builder
-
shardClosed
default Kinesis2EndpointBuilderFactory.Kinesis2EndpointConsumerBuilder shardClosed(org.apache.camel.component.aws2.kinesis.Kinesis2ShardClosedStrategyEnum shardClosed) Define what will be the behavior in case of shard closed. Possible value are ignore, silent and fail. In case of ignore a WARN message will be logged once and the consumer will not process new messages until restarted,in case of silent there will be no logging and the consumer will not process new messages until restarted,in case of fail a ReachedClosedStateException will be thrown. The option is a:org.apache.camel.component.aws2.kinesis.Kinesis2ShardClosedStrategyEnum
type. Default: ignore Group: consumer- Parameters:
shardClosed
- the value to set- Returns:
- the dsl builder
-
shardClosed
default Kinesis2EndpointBuilderFactory.Kinesis2EndpointConsumerBuilder shardClosed(String shardClosed) Define what will be the behavior in case of shard closed. Possible value are ignore, silent and fail. In case of ignore a WARN message will be logged once and the consumer will not process new messages until restarted,in case of silent there will be no logging and the consumer will not process new messages until restarted,in case of fail a ReachedClosedStateException will be thrown. The option will be converted to aorg.apache.camel.component.aws2.kinesis.Kinesis2ShardClosedStrategyEnum
type. Default: ignore Group: consumer- Parameters:
shardClosed
- the value to set- Returns:
- the dsl builder
-
shardId
Defines which shardId in the Kinesis stream to get records from. The option is a:java.lang.String
type. Group: consumer- Parameters:
shardId
- the value to set- Returns:
- the dsl builder
-
proxyHost
To define a proxy host when instantiating the Kinesis client. The option is a:java.lang.String
type. Group: proxy- Parameters:
proxyHost
- the value to set- Returns:
- the dsl builder
-
proxyPort
To define a proxy port when instantiating the Kinesis client. The option is a:java.lang.Integer
type. Group: proxy- Parameters:
proxyPort
- the value to set- Returns:
- the dsl builder
-
proxyPort
To define a proxy port when instantiating the Kinesis client. The option will be converted to ajava.lang.Integer
type. Group: proxy- Parameters:
proxyPort
- the value to set- Returns:
- the dsl builder
-
proxyProtocol
default Kinesis2EndpointBuilderFactory.Kinesis2EndpointConsumerBuilder proxyProtocol(software.amazon.awssdk.core.Protocol proxyProtocol) To define a proxy protocol when instantiating the Kinesis client. The option is a:software.amazon.awssdk.core.Protocol
type. Default: HTTPS Group: proxy- Parameters:
proxyProtocol
- the value to set- Returns:
- the dsl builder
-
proxyProtocol
default Kinesis2EndpointBuilderFactory.Kinesis2EndpointConsumerBuilder proxyProtocol(String proxyProtocol) To define a proxy protocol when instantiating the Kinesis client. The option will be converted to asoftware.amazon.awssdk.core.Protocol
type. Default: HTTPS Group: proxy- Parameters:
proxyProtocol
- the value to set- Returns:
- the dsl builder
-
backoffErrorThreshold
default Kinesis2EndpointBuilderFactory.Kinesis2EndpointConsumerBuilder backoffErrorThreshold(int backoffErrorThreshold) The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in. The option is a:int
type. Group: scheduler- Parameters:
backoffErrorThreshold
- the value to set- Returns:
- the dsl builder
-
backoffErrorThreshold
default Kinesis2EndpointBuilderFactory.Kinesis2EndpointConsumerBuilder backoffErrorThreshold(String backoffErrorThreshold) The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in. The option will be converted to aint
type. Group: scheduler- Parameters:
backoffErrorThreshold
- the value to set- Returns:
- the dsl builder
-
backoffIdleThreshold
default Kinesis2EndpointBuilderFactory.Kinesis2EndpointConsumerBuilder backoffIdleThreshold(int backoffIdleThreshold) The number of subsequent idle polls that should happen before the backoffMultipler should kick-in. The option is a:int
type. Group: scheduler- Parameters:
backoffIdleThreshold
- the value to set- Returns:
- the dsl builder
-
backoffIdleThreshold
default Kinesis2EndpointBuilderFactory.Kinesis2EndpointConsumerBuilder backoffIdleThreshold(String backoffIdleThreshold) The number of subsequent idle polls that should happen before the backoffMultipler should kick-in. The option will be converted to aint
type. Group: scheduler- Parameters:
backoffIdleThreshold
- the value to set- Returns:
- the dsl builder
-
backoffMultiplier
default Kinesis2EndpointBuilderFactory.Kinesis2EndpointConsumerBuilder backoffMultiplier(int backoffMultiplier) To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured. The option is a:int
type. Group: scheduler- Parameters:
backoffMultiplier
- the value to set- Returns:
- the dsl builder
-
backoffMultiplier
default Kinesis2EndpointBuilderFactory.Kinesis2EndpointConsumerBuilder backoffMultiplier(String backoffMultiplier) To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured. The option will be converted to aint
type. Group: scheduler- Parameters:
backoffMultiplier
- the value to set- Returns:
- the dsl builder
-
delay
Milliseconds before the next poll. The option is a:long
type. Default: 500 Group: scheduler- Parameters:
delay
- the value to set- Returns:
- the dsl builder
-
delay
Milliseconds before the next poll. The option will be converted to along
type. Default: 500 Group: scheduler- Parameters:
delay
- the value to set- Returns:
- the dsl builder
-
greedy
If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages. The option is a:boolean
type. Default: false Group: scheduler- Parameters:
greedy
- the value to set- Returns:
- the dsl builder
-
greedy
If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages. The option will be converted to aboolean
type. Default: false Group: scheduler- Parameters:
greedy
- the value to set- Returns:
- the dsl builder
-
initialDelay
default Kinesis2EndpointBuilderFactory.Kinesis2EndpointConsumerBuilder initialDelay(long initialDelay) Milliseconds before the first poll starts. The option is a:long
type. Default: 1000 Group: scheduler- Parameters:
initialDelay
- the value to set- Returns:
- the dsl builder
-
initialDelay
default Kinesis2EndpointBuilderFactory.Kinesis2EndpointConsumerBuilder initialDelay(String initialDelay) Milliseconds before the first poll starts. The option will be converted to along
type. Default: 1000 Group: scheduler- Parameters:
initialDelay
- the value to set- Returns:
- the dsl builder
-
repeatCount
default Kinesis2EndpointBuilderFactory.Kinesis2EndpointConsumerBuilder repeatCount(long repeatCount) Specifies a maximum limit of number of fires. So if you set it to 1, the scheduler will only fire once. If you set it to 5, it will only fire five times. A value of zero or negative means fire forever. The option is a:long
type. Default: 0 Group: scheduler- Parameters:
repeatCount
- the value to set- Returns:
- the dsl builder
-
repeatCount
default Kinesis2EndpointBuilderFactory.Kinesis2EndpointConsumerBuilder repeatCount(String repeatCount) Specifies a maximum limit of number of fires. So if you set it to 1, the scheduler will only fire once. If you set it to 5, it will only fire five times. A value of zero or negative means fire forever. The option will be converted to along
type. Default: 0 Group: scheduler- Parameters:
repeatCount
- the value to set- Returns:
- the dsl builder
-
runLoggingLevel
default Kinesis2EndpointBuilderFactory.Kinesis2EndpointConsumerBuilder runLoggingLevel(org.apache.camel.LoggingLevel runLoggingLevel) The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that. The option is a:org.apache.camel.LoggingLevel
type. Default: TRACE Group: scheduler- Parameters:
runLoggingLevel
- the value to set- Returns:
- the dsl builder
-
runLoggingLevel
default Kinesis2EndpointBuilderFactory.Kinesis2EndpointConsumerBuilder runLoggingLevel(String runLoggingLevel) The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that. The option will be converted to aorg.apache.camel.LoggingLevel
type. Default: TRACE Group: scheduler- Parameters:
runLoggingLevel
- the value to set- Returns:
- the dsl builder
-
scheduledExecutorService
default Kinesis2EndpointBuilderFactory.Kinesis2EndpointConsumerBuilder scheduledExecutorService(ScheduledExecutorService scheduledExecutorService) Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool. The option is a:java.util.concurrent.ScheduledExecutorService
type. Group: scheduler- Parameters:
scheduledExecutorService
- the value to set- Returns:
- the dsl builder
-
scheduledExecutorService
default Kinesis2EndpointBuilderFactory.Kinesis2EndpointConsumerBuilder scheduledExecutorService(String scheduledExecutorService) Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool. The option will be converted to ajava.util.concurrent.ScheduledExecutorService
type. Group: scheduler- Parameters:
scheduledExecutorService
- the value to set- Returns:
- the dsl builder
-
scheduler
To use a cron scheduler from either camel-spring or camel-quartz component. Use value spring or quartz for built in scheduler. The option is a:java.lang.Object
type. Default: none Group: scheduler- Parameters:
scheduler
- the value to set- Returns:
- the dsl builder
-
scheduler
To use a cron scheduler from either camel-spring or camel-quartz component. Use value spring or quartz for built in scheduler. The option will be converted to ajava.lang.Object
type. Default: none Group: scheduler- Parameters:
scheduler
- the value to set- Returns:
- the dsl builder
-
schedulerProperties
default Kinesis2EndpointBuilderFactory.Kinesis2EndpointConsumerBuilder schedulerProperties(String key, Object value) To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler. The option is a:java.util.Map<java.lang.String, java.lang.Object>
type. The option is multivalued, and you can use the schedulerProperties(String, Object) method to add a value (call the method multiple times to set more values). Group: scheduler- Parameters:
key
- the option keyvalue
- the option value- Returns:
- the dsl builder
-
schedulerProperties
default Kinesis2EndpointBuilderFactory.Kinesis2EndpointConsumerBuilder schedulerProperties(Map values) To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler. The option is a:java.util.Map<java.lang.String, java.lang.Object>
type. The option is multivalued, and you can use the schedulerProperties(String, Object) method to add a value (call the method multiple times to set more values). Group: scheduler- Parameters:
values
- the values- Returns:
- the dsl builder
-
startScheduler
default Kinesis2EndpointBuilderFactory.Kinesis2EndpointConsumerBuilder startScheduler(boolean startScheduler) Whether the scheduler should be auto started. The option is a:boolean
type. Default: true Group: scheduler- Parameters:
startScheduler
- the value to set- Returns:
- the dsl builder
-
startScheduler
default Kinesis2EndpointBuilderFactory.Kinesis2EndpointConsumerBuilder startScheduler(String startScheduler) Whether the scheduler should be auto started. The option will be converted to aboolean
type. Default: true Group: scheduler- Parameters:
startScheduler
- the value to set- Returns:
- the dsl builder
-
timeUnit
Time unit for initialDelay and delay options. The option is a:java.util.concurrent.TimeUnit
type. Default: MILLISECONDS Group: scheduler- Parameters:
timeUnit
- the value to set- Returns:
- the dsl builder
-
timeUnit
Time unit for initialDelay and delay options. The option will be converted to ajava.util.concurrent.TimeUnit
type. Default: MILLISECONDS Group: scheduler- Parameters:
timeUnit
- the value to set- Returns:
- the dsl builder
-
useFixedDelay
default Kinesis2EndpointBuilderFactory.Kinesis2EndpointConsumerBuilder useFixedDelay(boolean useFixedDelay) Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details. The option is a:boolean
type. Default: true Group: scheduler- Parameters:
useFixedDelay
- the value to set- Returns:
- the dsl builder
-
useFixedDelay
default Kinesis2EndpointBuilderFactory.Kinesis2EndpointConsumerBuilder useFixedDelay(String useFixedDelay) Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details. The option will be converted to aboolean
type. Default: true Group: scheduler- Parameters:
useFixedDelay
- the value to set- Returns:
- the dsl builder
-
accessKey
Amazon AWS Access Key. The option is a:java.lang.String
type. Group: security- Parameters:
accessKey
- the value to set- Returns:
- the dsl builder
-
profileCredentialsName
default Kinesis2EndpointBuilderFactory.Kinesis2EndpointConsumerBuilder profileCredentialsName(String profileCredentialsName) If using a profile credentials provider this parameter will set the profile name. The option is a:java.lang.String
type. Group: security- Parameters:
profileCredentialsName
- the value to set- Returns:
- the dsl builder
-
secretKey
Amazon AWS Secret Key. The option is a:java.lang.String
type. Group: security- Parameters:
secretKey
- the value to set- Returns:
- the dsl builder
-
sessionToken
default Kinesis2EndpointBuilderFactory.Kinesis2EndpointConsumerBuilder sessionToken(String sessionToken) Amazon AWS Session Token used when the user needs to assume a IAM role. The option is a:java.lang.String
type. Group: security- Parameters:
sessionToken
- the value to set- Returns:
- the dsl builder
-
trustAllCertificates
default Kinesis2EndpointBuilderFactory.Kinesis2EndpointConsumerBuilder trustAllCertificates(boolean trustAllCertificates) If we want to trust all certificates in case of overriding the endpoint. The option is a:boolean
type. Default: false Group: security- Parameters:
trustAllCertificates
- the value to set- Returns:
- the dsl builder
-
trustAllCertificates
default Kinesis2EndpointBuilderFactory.Kinesis2EndpointConsumerBuilder trustAllCertificates(String trustAllCertificates) If we want to trust all certificates in case of overriding the endpoint. The option will be converted to aboolean
type. Default: false Group: security- Parameters:
trustAllCertificates
- the value to set- Returns:
- the dsl builder
-
useDefaultCredentialsProvider
default Kinesis2EndpointBuilderFactory.Kinesis2EndpointConsumerBuilder 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:boolean
type. Default: false Group: security- Parameters:
useDefaultCredentialsProvider
- the value to set- Returns:
- the dsl builder
-
useDefaultCredentialsProvider
default Kinesis2EndpointBuilderFactory.Kinesis2EndpointConsumerBuilder 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 aboolean
type. Default: false Group: security- Parameters:
useDefaultCredentialsProvider
- the value to set- Returns:
- the dsl builder
-
useProfileCredentialsProvider
default Kinesis2EndpointBuilderFactory.Kinesis2EndpointConsumerBuilder useProfileCredentialsProvider(boolean useProfileCredentialsProvider) Set whether the Kinesis client should expect to load credentials through a profile credentials provider. The option is a:boolean
type. Default: false Group: security- Parameters:
useProfileCredentialsProvider
- the value to set- Returns:
- the dsl builder
-
useProfileCredentialsProvider
default Kinesis2EndpointBuilderFactory.Kinesis2EndpointConsumerBuilder useProfileCredentialsProvider(String useProfileCredentialsProvider) Set whether the Kinesis client should expect to load credentials through a profile credentials provider. The option will be converted to aboolean
type. Default: false Group: security- Parameters:
useProfileCredentialsProvider
- the value to set- Returns:
- the dsl builder
-
useSessionCredentials
default Kinesis2EndpointBuilderFactory.Kinesis2EndpointConsumerBuilder useSessionCredentials(boolean useSessionCredentials) Set whether the Kinesis client should expect to use Session Credentials. This is useful in situation in which the user needs to assume a IAM role for doing operations in Kinesis. The option is a:boolean
type. Default: false Group: security- Parameters:
useSessionCredentials
- the value to set- Returns:
- the dsl builder
-
useSessionCredentials
default Kinesis2EndpointBuilderFactory.Kinesis2EndpointConsumerBuilder useSessionCredentials(String useSessionCredentials) Set whether the Kinesis client should expect to use Session Credentials. This is useful in situation in which the user needs to assume a IAM role for doing operations in Kinesis. The option will be converted to aboolean
type. Default: false Group: security- Parameters:
useSessionCredentials
- the value to set- Returns:
- the dsl builder
-