Interface Aws2KinesisFirehoseComponentBuilderFactory.Aws2KinesisFirehoseComponentBuilder
- All Superinterfaces:
ComponentBuilder<org.apache.camel.component.aws2.firehose.KinesisFirehose2Component>
- All Known Implementing Classes:
Aws2KinesisFirehoseComponentBuilderFactory.Aws2KinesisFirehoseComponentBuilderImpl
- Enclosing interface:
Aws2KinesisFirehoseComponentBuilderFactory
public static interface Aws2KinesisFirehoseComponentBuilderFactory.Aws2KinesisFirehoseComponentBuilder
extends ComponentBuilder<org.apache.camel.component.aws2.firehose.KinesisFirehose2Component>
Builder for the AWS Kinesis Firehose component.
-
Method Summary
Modifier and TypeMethodDescriptionAmazon AWS Access Key.amazonKinesisFirehoseClient
(software.amazon.awssdk.services.firehose.FirehoseClient amazonKinesisFirehoseClient) Amazon Kinesis Firehose client to use for all requests for this endpoint.autowiredEnabled
(boolean autowiredEnabled) Whether autowiring is enabled.cborEnabled
(boolean cborEnabled) This option will set the CBOR_ENABLED property during the execution.configuration
(org.apache.camel.component.aws2.firehose.KinesisFirehose2Configuration configuration) Component configuration.lazyStartProducer
(boolean lazyStartProducer) Whether the producer should be started lazy (on the first message).operation
(org.apache.camel.component.aws2.firehose.KinesisFirehose2Operations operation) The operation to do in case the user don't want to send only a record.overrideEndpoint
(boolean 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 Firehose client.To define a proxy port when instantiating the Kinesis Firehose client.proxyProtocol
(software.amazon.awssdk.core.Protocol proxyProtocol) To define a proxy protocol when instantiating the Kinesis Firehose client.The region in which Kinesis Firehose client needs to work.Amazon AWS Secret Key.sessionToken
(String sessionToken) Amazon AWS Session Token used when the user needs to assume a IAM role.trustAllCertificates
(boolean 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 Firehose client should expect to load credentials through a default credentials provider or to expect static credentials to be passed in.useProfileCredentialsProvider
(boolean useProfileCredentialsProvider) Set whether the Kinesis Firehose client should expect to load credentials through a profile credentials provider.useSessionCredentials
(boolean useSessionCredentials) Set whether the Kinesis Firehose client should expect to use Session Credentials.Methods inherited from interface org.apache.camel.builder.component.ComponentBuilder
build, build, doSetProperty, register
-
Method Details
-
cborEnabled
default Aws2KinesisFirehoseComponentBuilderFactory.Aws2KinesisFirehoseComponentBuilder 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- Parameters:
cborEnabled
- the value to set- Returns:
- the dsl builder
-
configuration
default Aws2KinesisFirehoseComponentBuilderFactory.Aws2KinesisFirehoseComponentBuilder configuration(org.apache.camel.component.aws2.firehose.KinesisFirehose2Configuration configuration) Component configuration. The option is a: <code>org.apache.camel.component.aws2.firehose.KinesisFirehose2Configuration</code> type. Group: producer- Parameters:
configuration
- the value to set- Returns:
- the dsl builder
-
overrideEndpoint
default Aws2KinesisFirehoseComponentBuilderFactory.Aws2KinesisFirehoseComponentBuilder 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: <code>boolean</code> type. Default: false Group: common- Parameters:
overrideEndpoint
- the value to set- Returns:
- the dsl builder
-
lazyStartProducer
default Aws2KinesisFirehoseComponentBuilderFactory.Aws2KinesisFirehoseComponentBuilder 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
-
operation
default Aws2KinesisFirehoseComponentBuilderFactory.Aws2KinesisFirehoseComponentBuilder operation(org.apache.camel.component.aws2.firehose.KinesisFirehose2Operations operation) The operation to do in case the user don't want to send only a record. The option is a: <code>org.apache.camel.component.aws2.firehose.KinesisFirehose2Operations</code> type. Group: producer- Parameters:
operation
- the value to set- Returns:
- the dsl builder
-
region
default Aws2KinesisFirehoseComponentBuilderFactory.Aws2KinesisFirehoseComponentBuilder 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: producer- Parameters:
region
- the value to set- Returns:
- the dsl builder
-
uriEndpointOverride
default Aws2KinesisFirehoseComponentBuilderFactory.Aws2KinesisFirehoseComponentBuilder 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- Parameters:
uriEndpointOverride
- the value to set- Returns:
- the dsl builder
-
useDefaultCredentialsProvider
default Aws2KinesisFirehoseComponentBuilderFactory.Aws2KinesisFirehoseComponentBuilder useDefaultCredentialsProvider(boolean useDefaultCredentialsProvider) Set whether the Kinesis Firehose 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: common- Parameters:
useDefaultCredentialsProvider
- the value to set- Returns:
- the dsl builder
-
amazonKinesisFirehoseClient
default Aws2KinesisFirehoseComponentBuilderFactory.Aws2KinesisFirehoseComponentBuilder amazonKinesisFirehoseClient(software.amazon.awssdk.services.firehose.FirehoseClient amazonKinesisFirehoseClient) Amazon Kinesis Firehose client to use for all requests for this endpoint. The option is a: <code>software.amazon.awssdk.services.firehose.FirehoseClient</code> type. Group: advanced- Parameters:
amazonKinesisFirehoseClient
- the value to set- Returns:
- the dsl builder
-
autowiredEnabled
default Aws2KinesisFirehoseComponentBuilderFactory.Aws2KinesisFirehoseComponentBuilder autowiredEnabled(boolean autowiredEnabled) Whether autowiring is enabled. This is used for automatic autowiring options (the option must be marked as autowired) by looking up in the registry to find if there is a single instance of matching type, which then gets configured on the component. This can be used for automatic configuring JDBC data sources, JMS connection factories, AWS Clients, etc. The option is a: <code>boolean</code> type. Default: true Group: advanced- Parameters:
autowiredEnabled
- the value to set- Returns:
- the dsl builder
-
proxyHost
default Aws2KinesisFirehoseComponentBuilderFactory.Aws2KinesisFirehoseComponentBuilder proxyHost(String proxyHost) To define a proxy host when instantiating the Kinesis Firehose client. The option is a: <code>java.lang.String</code> type. Group: proxy- Parameters:
proxyHost
- the value to set- Returns:
- the dsl builder
-
proxyPort
default Aws2KinesisFirehoseComponentBuilderFactory.Aws2KinesisFirehoseComponentBuilder proxyPort(Integer proxyPort) To define a proxy port when instantiating the Kinesis Firehose client. The option is a: <code>java.lang.Integer</code> type. Group: proxy- Parameters:
proxyPort
- the value to set- Returns:
- the dsl builder
-
proxyProtocol
default Aws2KinesisFirehoseComponentBuilderFactory.Aws2KinesisFirehoseComponentBuilder proxyProtocol(software.amazon.awssdk.core.Protocol proxyProtocol) To define a proxy protocol when instantiating the Kinesis Firehose client. The option is a: <code>software.amazon.awssdk.core.Protocol</code> type. Default: HTTPS Group: proxy- Parameters:
proxyProtocol
- the value to set- Returns:
- the dsl builder
-
accessKey
default Aws2KinesisFirehoseComponentBuilderFactory.Aws2KinesisFirehoseComponentBuilder 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
-
profileCredentialsName
default Aws2KinesisFirehoseComponentBuilderFactory.Aws2KinesisFirehoseComponentBuilder 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- Parameters:
profileCredentialsName
- the value to set- Returns:
- the dsl builder
-
secretKey
default Aws2KinesisFirehoseComponentBuilderFactory.Aws2KinesisFirehoseComponentBuilder 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
-
sessionToken
default Aws2KinesisFirehoseComponentBuilderFactory.Aws2KinesisFirehoseComponentBuilder sessionToken(String sessionToken) Amazon AWS Session Token used when the user needs to assume a IAM role. The option is a: <code>java.lang.String</code> type. Group: security- Parameters:
sessionToken
- the value to set- Returns:
- the dsl builder
-
trustAllCertificates
default Aws2KinesisFirehoseComponentBuilderFactory.Aws2KinesisFirehoseComponentBuilder 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- Parameters:
trustAllCertificates
- the value to set- Returns:
- the dsl builder
-
useProfileCredentialsProvider
default Aws2KinesisFirehoseComponentBuilderFactory.Aws2KinesisFirehoseComponentBuilder useProfileCredentialsProvider(boolean useProfileCredentialsProvider) Set whether the Kinesis Firehose client should expect to load credentials through a profile credentials provider. The option is a: <code>boolean</code> type. Default: false Group: security- Parameters:
useProfileCredentialsProvider
- the value to set- Returns:
- the dsl builder
-
useSessionCredentials
default Aws2KinesisFirehoseComponentBuilderFactory.Aws2KinesisFirehoseComponentBuilder useSessionCredentials(boolean useSessionCredentials) Set whether the Kinesis Firehose 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 Firehose. The option is a: <code>boolean</code> type. Default: false Group: security- Parameters:
useSessionCredentials
- the value to set- Returns:
- the dsl builder
-