Interface Aws2AthenaComponentBuilderFactory.Aws2AthenaComponentBuilder

    • Method Detail

      • amazonAthenaClient

        default Aws2AthenaComponentBuilderFactory.Aws2AthenaComponentBuilder amazonAthenaClient​(software.amazon.awssdk.services.athena.AthenaClient amazonAthenaClient)
        The AmazonAthena instance to use as the client. The option is a: software.amazon.awssdk.services.athena.AthenaClient type. Group: producer
      • configuration

        default Aws2AthenaComponentBuilderFactory.Aws2AthenaComponentBuilder configuration​(org.apache.camel.component.aws2.athena.Athena2Configuration configuration)
        The component configuration. The option is a: org.apache.camel.component.aws2.athena.Athena2Configuration type. Group: producer
      • delay

        default Aws2AthenaComponentBuilderFactory.Aws2AthenaComponentBuilder delay​(long delay)
        Milliseconds before the next poll for query execution status. See the section 'Waiting for Query Completion and Retrying Failed Queries' to learn more. The option is a: long type. Default: 2000 Group: producer
      • encryptionOption

        default Aws2AthenaComponentBuilderFactory.Aws2AthenaComponentBuilder encryptionOption​(software.amazon.awssdk.services.athena.model.EncryptionOption encryptionOption)
        The encryption type to use when storing query results in S3. One of SSE_S3, SSE_KMS, or CSE_KMS. The option is a: software.amazon.awssdk.services.athena.model.EncryptionOption type. Group: producer
      • initialDelay

        default Aws2AthenaComponentBuilderFactory.Aws2AthenaComponentBuilder initialDelay​(long initialDelay)
        Milliseconds before the first poll for query execution status. See the section 'Waiting for Query Completion and Retrying Failed Queries' to learn more. The option is a: long type. Default: 1000 Group: producer
      • lazyStartProducer

        default Aws2AthenaComponentBuilderFactory.Aws2AthenaComponentBuilder 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: boolean type. Default: false Group: producer
      • maxAttempts

        default Aws2AthenaComponentBuilderFactory.Aws2AthenaComponentBuilder maxAttempts​(int maxAttempts)
        Maximum number of times to attempt a query. Set to 1 to disable retries. See the section 'Waiting for Query Completion and Retrying Failed Queries' to learn more. The option is a: int type. Default: 1 Group: producer
      • maxResults

        default Aws2AthenaComponentBuilderFactory.Aws2AthenaComponentBuilder maxResults​(Integer maxResults)
        Max number of results to return for the given operation (if supported by the Athena API endpoint). If not set, will use the Athena API default for the given operation. The option is a: java.lang.Integer type. Group: producer
      • operation

        default Aws2AthenaComponentBuilderFactory.Aws2AthenaComponentBuilder operation​(org.apache.camel.component.aws2.athena.Athena2Operations operation)
        The Athena API function to call. The option is a: org.apache.camel.component.aws2.athena.Athena2Operations type. Default: startQueryExecution Group: producer
      • outputLocation

        default Aws2AthenaComponentBuilderFactory.Aws2AthenaComponentBuilder outputLocation​(String outputLocation)
        The location in Amazon S3 where query results are stored, such as s3://path/to/query/bucket/. Ensure this value ends with a forward slash ('/'). The option is a: java.lang.String type. Group: producer
      • outputType

        default Aws2AthenaComponentBuilderFactory.Aws2AthenaComponentBuilder outputType​(org.apache.camel.component.aws2.athena.Athena2OutputType outputType)
        How query results should be returned. One of StreamList (default - return a GetQueryResultsIterable that can page through all results), SelectList (returns at most 1,000 rows at a time, plus a NextToken value as a header than can be used for manual pagination of results), S3Pointer (return an S3 path pointing to the results). The option is a: org.apache.camel.component.aws2.athena.Athena2OutputType type. Default: StreamList Group: producer
      • proxyProtocol

        default Aws2AthenaComponentBuilderFactory.Aws2AthenaComponentBuilder proxyProtocol​(software.amazon.awssdk.core.Protocol proxyProtocol)
        To define a proxy protocol when instantiating the Athena client. The option is a: software.amazon.awssdk.core.Protocol type. Default: HTTPS Group: producer
      • queryString

        default Aws2AthenaComponentBuilderFactory.Aws2AthenaComponentBuilder queryString​(String queryString)
        The SQL query to run. Except for simple queries, prefer setting this as the body of the Exchange or as a header using Athena2Constants.QUERY_STRING to avoid having to deal with URL encoding issues. The option is a: java.lang.String type. Group: producer
      • region

        default Aws2AthenaComponentBuilderFactory.Aws2AthenaComponentBuilder region​(String region)
        The region in which Athena 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: producer
      • resetWaitTimeoutOnRetry

        default Aws2AthenaComponentBuilderFactory.Aws2AthenaComponentBuilder resetWaitTimeoutOnRetry​(boolean resetWaitTimeoutOnRetry)
        Reset the waitTimeout countdown in the event of a query retry. If set to true, potential max time spent waiting for queries is equal to waitTimeout x maxAttempts. See the section 'Waiting for Query Completion and Retrying Failed Queries' to learn more. The option is a: boolean type. Default: true Group: producer
      • retry

        default Aws2AthenaComponentBuilderFactory.Aws2AthenaComponentBuilder retry​(String retry)
        Optional comma separated list of error types to retry the query for. Use 'retryable' to retry all retryable failure conditions (e.g. generic errors and resources exhausted), 'generic' to retry 'GENERIC_INTERNAL_ERROR' failures, 'exhausted' to retry queries that have exhausted resource limits, 'always' to always retry regardless of failure condition, or 'never' or null to never retry (default). See the section 'Waiting for Query Completion and Retrying Failed Queries' to learn more. The option is a: java.lang.String type. Default: never Group: producer
      • waitTimeout

        default Aws2AthenaComponentBuilderFactory.Aws2AthenaComponentBuilder waitTimeout​(long waitTimeout)
        Optional max wait time in millis to wait for a successful query completion. See the section 'Waiting for Query Completion and Retrying Failed Queries' to learn more. The option is a: long type. Default: 0 Group: producer
      • autowiredEnabled

        default Aws2AthenaComponentBuilderFactory.Aws2AthenaComponentBuilder 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: boolean type. Default: true Group: advanced