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

Interface Kinesis2EndpointBuilderFactory.Kinesis2EndpointProducerBuilder

  • All Superinterfaces:
    org.apache.camel.builder.EndpointProducerBuilder, org.apache.camel.EndpointProducerResolver
    All Known Subinterfaces:
    Kinesis2EndpointBuilderFactory.Kinesis2EndpointBuilder
    Enclosing interface:
    Kinesis2EndpointBuilderFactory
    public static interface Kinesis2EndpointBuilderFactory.Kinesis2EndpointProducerBuilder
extends org.apache.camel.builder.EndpointProducerBuilder
    Builder for endpoint producers for the AWS Kinesis component.

    • Method Detail

      • amazonKinesisClient

        default Kinesis2EndpointBuilderFactory.Kinesis2EndpointProducerBuilder amazonKinesisClient​(software.amazon.awssdk.services.kinesis.KinesisClient amazonKinesisClient)
        Amazon Kinesis client to use for all requests for this endpoint. The option is a: <code>software.amazon.awssdk.services.kinesis.KinesisClient</code> type. Group: common
        Parameters:
        amazonKinesisClient - the value to set
        Returns:
        the dsl builder

      • amazonKinesisClient

        default Kinesis2EndpointBuilderFactory.Kinesis2EndpointProducerBuilder amazonKinesisClient​(String amazonKinesisClient)
        Amazon Kinesis client to use for all requests for this endpoint. The option will be converted to a <code>software.amazon.awssdk.services.kinesis.KinesisClient</code> type. Group: common
        Parameters:
        amazonKinesisClient - the value to set
        Returns:
        the dsl builder

      • cborEnabled

        default Kinesis2EndpointBuilderFactory.Kinesis2EndpointProducerBuilder 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

      • cborEnabled

        default Kinesis2EndpointBuilderFactory.Kinesis2EndpointProducerBuilder 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
        Parameters:
        cborEnabled - the value to set
        Returns:
        the dsl builder

      • overrideEndpoint

        default Kinesis2EndpointBuilderFactory.Kinesis2EndpointProducerBuilder 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
        Parameters:
        overrideEndpoint - the value to set
        Returns:
        the dsl builder

      • overrideEndpoint

        default Kinesis2EndpointBuilderFactory.Kinesis2EndpointProducerBuilder 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
        Parameters:
        overrideEndpoint - the value to set
        Returns:
        the dsl builder

      • proxyProtocol

        default Kinesis2EndpointBuilderFactory.Kinesis2EndpointProducerBuilder 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: common
        Parameters:
        proxyProtocol - the value to set
        Returns:
        the dsl builder

      • proxyProtocol

        default Kinesis2EndpointBuilderFactory.Kinesis2EndpointProducerBuilder 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: common
        Parameters:
        proxyProtocol - the value to set
        Returns:
        the dsl builder

      • region

        default Kinesis2EndpointBuilderFactory.Kinesis2EndpointProducerBuilder 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
        Parameters:
        region - the value to set
        Returns:
        the dsl builder

      • trustAllCertificates

        default Kinesis2EndpointBuilderFactory.Kinesis2EndpointProducerBuilder 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: common
        Parameters:
        trustAllCertificates - the value to set
        Returns:
        the dsl builder

      • trustAllCertificates

        default Kinesis2EndpointBuilderFactory.Kinesis2EndpointProducerBuilder 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: common
        Parameters:
        trustAllCertificates - the value to set
        Returns:
        the dsl builder

      • uriEndpointOverride

        default Kinesis2EndpointBuilderFactory.Kinesis2EndpointProducerBuilder 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 Kinesis2EndpointBuilderFactory.Kinesis2EndpointProducerBuilder 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: common
        Parameters:
        useDefaultCredentialsProvider - the value to set
        Returns:
        the dsl builder

      • useDefaultCredentialsProvider

        default Kinesis2EndpointBuilderFactory.Kinesis2EndpointProducerBuilder 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: common
        Parameters:
        useDefaultCredentialsProvider - the value to set
        Returns:
        the dsl builder

      • lazyStartProducer

        default Kinesis2EndpointBuilderFactory.Kinesis2EndpointProducerBuilder 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 Kinesis2EndpointBuilderFactory.Kinesis2EndpointProducerBuilder 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