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

Interface Ddb2EndpointBuilderFactory.Ddb2EndpointBuilder

  • All Superinterfaces:
    org.apache.camel.builder.EndpointProducerBuilder, org.apache.camel.EndpointProducerResolver
    Enclosing interface:
    Ddb2EndpointBuilderFactory
    public static interface Ddb2EndpointBuilderFactory.Ddb2EndpointBuilder
extends org.apache.camel.builder.EndpointProducerBuilder
    Builder for endpoint for the AWS DynamoDB component.

    • Method Detail

      • amazonDDBClient

        default Ddb2EndpointBuilderFactory.Ddb2EndpointBuilder amazonDDBClient​(Object amazonDDBClient)
        To use the AmazonDynamoDB as the client. The option is a: <code>software.amazon.awssdk.services.dynamodb.DynamoDbClient</code> type. Group: producer
        Parameters:
        amazonDDBClient - the value to set
        Returns:
        the dsl builder

      • amazonDDBClient

        default Ddb2EndpointBuilderFactory.Ddb2EndpointBuilder amazonDDBClient​(String amazonDDBClient)
        To use the AmazonDynamoDB as the client. The option will be converted to a <code>software.amazon.awssdk.services.dynamodb.DynamoDbClient</code> type. Group: producer
        Parameters:
        amazonDDBClient - the value to set
        Returns:
        the dsl builder

      • consistentRead

        default Ddb2EndpointBuilderFactory.Ddb2EndpointBuilder consistentRead​(boolean consistentRead)
        Determines whether or not strong consistency should be enforced when data is read. The option is a: <code>boolean</code> type. Default: false Group: producer
        Parameters:
        consistentRead - the value to set
        Returns:
        the dsl builder

      • consistentRead

        default Ddb2EndpointBuilderFactory.Ddb2EndpointBuilder consistentRead​(String consistentRead)
        Determines whether or not strong consistency should be enforced when data is read. The option will be converted to a <code>boolean</code> type. Default: false Group: producer
        Parameters:
        consistentRead - the value to set
        Returns:
        the dsl builder

      • enabledInitialDescribeTable

        default Ddb2EndpointBuilderFactory.Ddb2EndpointBuilder enabledInitialDescribeTable​(boolean enabledInitialDescribeTable)
        Set whether the initial Describe table operation in the DDB Endpoint must be done, or not. The option is a: <code>boolean</code> type. Default: true Group: producer
        Parameters:
        enabledInitialDescribeTable - the value to set
        Returns:
        the dsl builder

      • enabledInitialDescribeTable

        default Ddb2EndpointBuilderFactory.Ddb2EndpointBuilder enabledInitialDescribeTable​(String enabledInitialDescribeTable)
        Set whether the initial Describe table operation in the DDB Endpoint must be done, or not. The option will be converted to a <code>boolean</code> type. Default: true Group: producer
        Parameters:
        enabledInitialDescribeTable - the value to set
        Returns:
        the dsl builder

      • keyAttributeName

        default Ddb2EndpointBuilderFactory.Ddb2EndpointBuilder keyAttributeName​(String keyAttributeName)
        Attribute name when creating table. The option is a: <code>java.lang.String</code> type. Group: producer
        Parameters:
        keyAttributeName - the value to set
        Returns:
        the dsl builder

      • keyAttributeType

        default Ddb2EndpointBuilderFactory.Ddb2EndpointBuilder keyAttributeType​(String keyAttributeType)
        Attribute type when creating table. The option is a: <code>java.lang.String</code> type. Group: producer
        Parameters:
        keyAttributeType - the value to set
        Returns:
        the dsl builder

      • keyScalarType

        default Ddb2EndpointBuilderFactory.Ddb2EndpointBuilder keyScalarType​(String keyScalarType)
        The key scalar type, it can be S (String), N (Number) and B (Bytes). The option is a: <code>java.lang.String</code> type. Group: producer
        Parameters:
        keyScalarType - the value to set
        Returns:
        the dsl builder

      • lazyStartProducer

        default Ddb2EndpointBuilderFactory.Ddb2EndpointBuilder 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 Ddb2EndpointBuilderFactory.Ddb2EndpointBuilder 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

      • operation

        default Ddb2EndpointBuilderFactory.Ddb2EndpointBuilder operation​(String operation)
        What operation to perform. The option will be converted to a <code>org.apache.camel.component.aws2.ddb.Ddb2Operations</code> type. Default: PutItem Group: producer
        Parameters:
        operation - the value to set
        Returns:
        the dsl builder

      • overrideEndpoint

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

      • overrideEndpoint

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

      • proxyHost

        default Ddb2EndpointBuilderFactory.Ddb2EndpointBuilder proxyHost​(String proxyHost)
        To define a proxy host when instantiating the DDB 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 Ddb2EndpointBuilderFactory.Ddb2EndpointBuilder proxyPort​(Integer proxyPort)
        The region in which DynamoDB 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.Integer</code> type. Group: producer
        Parameters:
        proxyPort - the value to set
        Returns:
        the dsl builder

      • proxyPort

        default Ddb2EndpointBuilderFactory.Ddb2EndpointBuilder proxyPort​(String proxyPort)
        The region in which DynamoDB 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 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 Ddb2EndpointBuilderFactory.Ddb2EndpointBuilder proxyProtocol​(String proxyProtocol)
        To define a proxy protocol when instantiating the DDB client. The option will be converted to a <code>software.amazon.awssdk.core.Protocol</code> type. Default: HTTPS Group: producer
        Parameters:
        proxyProtocol - the value to set
        Returns:
        the dsl builder

      • readCapacity

        default Ddb2EndpointBuilderFactory.Ddb2EndpointBuilder readCapacity​(Long readCapacity)
        The provisioned throughput to reserve for reading resources from your table. The option is a: <code>java.lang.Long</code> type. Group: producer
        Parameters:
        readCapacity - the value to set
        Returns:
        the dsl builder

      • readCapacity

        default Ddb2EndpointBuilderFactory.Ddb2EndpointBuilder readCapacity​(String readCapacity)
        The provisioned throughput to reserve for reading resources from your table. The option will be converted to a <code>java.lang.Long</code> type. Group: producer
        Parameters:
        readCapacity - the value to set
        Returns:
        the dsl builder

      • region

        default Ddb2EndpointBuilderFactory.Ddb2EndpointBuilder region​(String region)
        The region in which DDB client needs to work. The option is a: <code>java.lang.String</code> type. Group: producer
        Parameters:
        region - the value to set
        Returns:
        the dsl builder

      • trustAllCertificates

        default Ddb2EndpointBuilderFactory.Ddb2EndpointBuilder 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: producer
        Parameters:
        trustAllCertificates - the value to set
        Returns:
        the dsl builder

      • trustAllCertificates

        default Ddb2EndpointBuilderFactory.Ddb2EndpointBuilder 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: producer
        Parameters:
        trustAllCertificates - the value to set
        Returns:
        the dsl builder

      • uriEndpointOverride

        default Ddb2EndpointBuilderFactory.Ddb2EndpointBuilder 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: producer
        Parameters:
        uriEndpointOverride - the value to set
        Returns:
        the dsl builder

      • useDefaultCredentialsProvider

        default Ddb2EndpointBuilderFactory.Ddb2EndpointBuilder useDefaultCredentialsProvider​(boolean useDefaultCredentialsProvider)
        Set whether the S3 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: producer
        Parameters:
        useDefaultCredentialsProvider - the value to set
        Returns:
        the dsl builder

      • useDefaultCredentialsProvider

        default Ddb2EndpointBuilderFactory.Ddb2EndpointBuilder useDefaultCredentialsProvider​(String useDefaultCredentialsProvider)
        Set whether the S3 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: producer
        Parameters:
        useDefaultCredentialsProvider - the value to set
        Returns:
        the dsl builder

      • writeCapacity

        default Ddb2EndpointBuilderFactory.Ddb2EndpointBuilder writeCapacity​(Long writeCapacity)
        The provisioned throughput to reserved for writing resources to your table. The option is a: <code>java.lang.Long</code> type. Group: producer
        Parameters:
        writeCapacity - the value to set
        Returns:
        the dsl builder

      • writeCapacity

        default Ddb2EndpointBuilderFactory.Ddb2EndpointBuilder writeCapacity​(String writeCapacity)
        The provisioned throughput to reserved for writing resources to your table. The option will be converted to a <code>java.lang.Long</code> type. Group: producer
        Parameters:
        writeCapacity - the value to set
        Returns:
        the dsl builder