Package org.apache.camel.builder.component.dsl

Interface Aws2AthenaComponentBuilderFactory.Aws2AthenaComponentBuilder

All Superinterfaces:
ComponentBuilder<org.apache.camel.component.aws2.athena.Athena2Component>
All Known Implementing Classes:
Aws2AthenaComponentBuilderFactory.Aws2AthenaComponentBuilderImpl
Enclosing interface:
Aws2AthenaComponentBuilderFactory
public static interface Aws2AthenaComponentBuilderFactory.Aws2AthenaComponentBuilder extends ComponentBuilder<org.apache.camel.component.aws2.athena.Athena2Component>
Builder for the AWS Athena component.

  • Method Details

    • configuration

      default Aws2AthenaComponentBuilderFactory.Aws2AthenaComponentBuilder configuration(org.apache.camel.component.aws2.athena.Athena2Configuration configuration)
      The component configuration. The option is a: <code>org.apache.camel.component.aws2.athena.Athena2Configuration</code> type. Group: producer
      Parameters:
      configuration - the value to set
      Returns:
      the dsl builder

    • database

      default Aws2AthenaComponentBuilderFactory.Aws2AthenaComponentBuilder database(String database)
      The Athena database to use. The option is a: <code>java.lang.String</code> type. Group: producer
      Parameters:
      database - the value to set
      Returns:
      the dsl builder

    • 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: <code>long</code> type. Default: 2000 Group: producer
      Parameters:
      delay - the value to set
      Returns:
      the dsl builder

    • 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: <code>long</code> type. Default: 1000 Group: producer
      Parameters:
      initialDelay - the value to set
      Returns:
      the dsl builder

    • 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: <code>boolean</code> type. Default: false Group: producer
      Parameters:
      lazyStartProducer - the value to set
      Returns:
      the dsl builder

    • 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: <code>int</code> type. Default: 1 Group: producer
      Parameters:
      maxAttempts - the value to set
      Returns:
      the dsl builder

    • 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: <code>java.lang.Integer</code> type. Group: producer
      Parameters:
      maxResults - the value to set
      Returns:
      the dsl builder

    • nextToken

      default Aws2AthenaComponentBuilderFactory.Aws2AthenaComponentBuilder nextToken(String nextToken)
      Pagination token to use in the case where the response from the previous request was truncated. The option is a: <code>java.lang.String</code> type. Group: producer
      Parameters:
      nextToken - the value to set
      Returns:
      the dsl builder

    • operation

      default Aws2AthenaComponentBuilderFactory.Aws2AthenaComponentBuilder operation(org.apache.camel.component.aws2.athena.Athena2Operations operation)
      The Athena API function to call. The option is a: <code>org.apache.camel.component.aws2.athena.Athena2Operations</code> type. Default: startQueryExecution Group: producer
      Parameters:
      operation - the value to set
      Returns:
      the dsl builder

    • 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: <code>java.lang.String</code> type. Group: producer
      Parameters:
      outputLocation - the value to set
      Returns:
      the dsl builder

    • 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 1000 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: <code>org.apache.camel.component.aws2.athena.Athena2OutputType</code> type. Default: StreamList Group: producer
      Parameters:
      outputType - the value to set
      Returns:
      the dsl builder

    • queryExecutionId

      default Aws2AthenaComponentBuilderFactory.Aws2AthenaComponentBuilder queryExecutionId(String queryExecutionId)
      The unique ID identifying the query execution. The option is a: <code>java.lang.String</code> type. Group: producer
      Parameters:
      queryExecutionId - the value to set
      Returns:
      the dsl builder

    • 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: <code>java.lang.String</code> type. Group: producer
      Parameters:
      queryString - the value to set
      Returns:
      the dsl builder

    • 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). The option is a: <code>java.lang.String</code> type. Group: producer
      Parameters:
      region - the value to set
      Returns:
      the dsl builder

    • 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: <code>boolean</code> type. Default: true Group: producer
      Parameters:
      resetWaitTimeoutOnRetry - the value to set
      Returns:
      the dsl builder

    • 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: <code>java.lang.String</code> type. Default: never Group: producer
      Parameters:
      retry - the value to set
      Returns:
      the dsl builder

    • 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: <code>long</code> type. Group: producer
      Parameters:
      waitTimeout - the value to set
      Returns:
      the dsl builder

    • workGroup

      default Aws2AthenaComponentBuilderFactory.Aws2AthenaComponentBuilder workGroup(String workGroup)
      The workgroup to use for running the query. The option is a: <code>java.lang.String</code> type. Group: producer
      Parameters:
      workGroup - the value to set
      Returns:
      the dsl builder

    • amazonAthenaClient

      default Aws2AthenaComponentBuilderFactory.Aws2AthenaComponentBuilder amazonAthenaClient(software.amazon.awssdk.services.athena.AthenaClient amazonAthenaClient)
      The AmazonAthena instance to use as the client. The option is a: <code>software.amazon.awssdk.services.athena.AthenaClient</code> type. Group: advanced
      Parameters:
      amazonAthenaClient - the value to set
      Returns:
      the dsl builder

    • 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: <code>boolean</code> type. Default: true Group: advanced
      Parameters:
      autowiredEnabled - the value to set
      Returns:
      the dsl builder

    • clientRequestToken

      default Aws2AthenaComponentBuilderFactory.Aws2AthenaComponentBuilder clientRequestToken(String clientRequestToken)
      A unique string to ensure issues queries are idempotent. It is unlikely you will need to set this. The option is a: <code>java.lang.String</code> type. Group: advanced
      Parameters:
      clientRequestToken - the value to set
      Returns:
      the dsl builder

    • includeTrace

      default Aws2AthenaComponentBuilderFactory.Aws2AthenaComponentBuilder includeTrace(boolean includeTrace)
      Include useful trace information at the beginning of queries as an SQL comment (prefixed with --). The option is a: <code>boolean</code> type. Default: false Group: advanced
      Parameters:
      includeTrace - the value to set
      Returns:
      the dsl builder

    • healthCheckConsumerEnabled

      default Aws2AthenaComponentBuilderFactory.Aws2AthenaComponentBuilder healthCheckConsumerEnabled(boolean healthCheckConsumerEnabled)
      Used for enabling or disabling all consumer based health checks from this component. The option is a: <code>boolean</code> type. Default: true Group: health
      Parameters:
      healthCheckConsumerEnabled - the value to set
      Returns:
      the dsl builder

    • healthCheckProducerEnabled

      default Aws2AthenaComponentBuilderFactory.Aws2AthenaComponentBuilder healthCheckProducerEnabled(boolean healthCheckProducerEnabled)
      Used for enabling or disabling all producer based health checks from this component. Notice: Camel has by default disabled all producer based health-checks. You can turn on producer checks globally by setting camel.health.producersEnabled=true. The option is a: <code>boolean</code> type. Default: true Group: health
      Parameters:
      healthCheckProducerEnabled - the value to set
      Returns:
      the dsl builder

    • proxyHost

      default Aws2AthenaComponentBuilderFactory.Aws2AthenaComponentBuilder proxyHost(String proxyHost)
      To define a proxy host when instantiating the Athena 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 Aws2AthenaComponentBuilderFactory.Aws2AthenaComponentBuilder proxyPort(Integer proxyPort)
      To define a proxy port when instantiating the Athena 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 Aws2AthenaComponentBuilderFactory.Aws2AthenaComponentBuilder proxyProtocol(software.amazon.awssdk.core.Protocol proxyProtocol)
      To define a proxy protocol when instantiating the Athena 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 Aws2AthenaComponentBuilderFactory.Aws2AthenaComponentBuilder 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

    • 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: <code>software.amazon.awssdk.services.athena.model.EncryptionOption</code> type. Group: security
      Parameters:
      encryptionOption - the value to set
      Returns:
      the dsl builder

    • kmsKey

      default Aws2AthenaComponentBuilderFactory.Aws2AthenaComponentBuilder kmsKey(String kmsKey)
      For SSE-KMS and CSE-KMS, this is the KMS key ARN or ID. The option is a: <code>java.lang.String</code> type. Group: security
      Parameters:
      kmsKey - the value to set
      Returns:
      the dsl builder

    • profileCredentialsName

      default Aws2AthenaComponentBuilderFactory.Aws2AthenaComponentBuilder 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 Aws2AthenaComponentBuilderFactory.Aws2AthenaComponentBuilder 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 Aws2AthenaComponentBuilderFactory.Aws2AthenaComponentBuilder sessionToken(String sessionToken)
      Amazon AWS Session Token used when the user needs to assume an IAM role. The option is a: <code>java.lang.String</code> type. Group: security
      Parameters:
      sessionToken - the value to set
      Returns:
      the dsl builder

    • useDefaultCredentialsProvider

      default Aws2AthenaComponentBuilderFactory.Aws2AthenaComponentBuilder useDefaultCredentialsProvider(boolean useDefaultCredentialsProvider)
      Set whether the Athena 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: security
      Parameters:
      useDefaultCredentialsProvider - the value to set
      Returns:
      the dsl builder

    • useProfileCredentialsProvider

      default Aws2AthenaComponentBuilderFactory.Aws2AthenaComponentBuilder useProfileCredentialsProvider(boolean useProfileCredentialsProvider)
      Set whether the Athena 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 Aws2AthenaComponentBuilderFactory.Aws2AthenaComponentBuilder useSessionCredentials(boolean useSessionCredentials)
      Set whether the Athena client should expect to use Session Credentials. This is useful in a situation in which the user needs to assume a IAM role for doing operations in Athena. The option is a: <code>boolean</code> type. Default: false Group: security
      Parameters:
      useSessionCredentials - the value to set
      Returns:
      the dsl builder