Interface Athena2EndpointBuilderFactory.Athena2EndpointBuilder
- All Superinterfaces:
org.apache.camel.builder.EndpointProducerBuilder
,org.apache.camel.EndpointProducerResolver
- Enclosing interface:
- Athena2EndpointBuilderFactory
public static interface Athena2EndpointBuilderFactory.Athena2EndpointBuilder
extends org.apache.camel.builder.EndpointProducerBuilder
Builder for endpoint for the AWS Athena component.
-
Method Summary
Modifier and TypeMethodDescriptionAmazon AWS Access Key.advanced()
The Athena database to use.delay
(long delay) Milliseconds before the next poll for query execution status.Milliseconds before the next poll for query execution status.encryptionOption
(String encryptionOption) The encryption type to use when storing query results in S3.encryptionOption
(software.amazon.awssdk.services.athena.model.EncryptionOption encryptionOption) The encryption type to use when storing query results in S3.initialDelay
(long initialDelay) Milliseconds before the first poll for query execution status.initialDelay
(String initialDelay) Milliseconds before the first poll for query execution status.For SSE-KMS and CSE-KMS, this is the KMS key ARN or ID.maxAttempts
(int maxAttempts) Maximum number of times to attempt a query.maxAttempts
(String maxAttempts) Maximum number of times to attempt a query.maxResults
(Integer maxResults) Max number of results to return for the given operation (if supported by the Athena API endpoint).maxResults
(String maxResults) Max number of results to return for the given operation (if supported by the Athena API endpoint).Pagination token to use in the case where the response from the previous request was truncated.The Athena API function to call.operation
(org.apache.camel.component.aws2.athena.Athena2Operations operation) The Athena API function to call.outputLocation
(String outputLocation) The location in Amazon S3 where query results are stored, such as s3://path/to/query/bucket/.outputType
(String outputType) How query results should be returned.outputType
(org.apache.camel.component.aws2.athena.Athena2OutputType outputType) How query results should be returned.profileCredentialsName
(String profileCredentialsName) If using a profile credentials provider this parameter will set the profile name.To define a proxy host when instantiating the Athena client.To define a proxy port when instantiating the Athena client.To define a proxy port when instantiating the Athena client.proxyProtocol
(String proxyProtocol) To define a proxy protocol when instantiating the Athena client.proxyProtocol
(software.amazon.awssdk.core.Protocol proxyProtocol) To define a proxy protocol when instantiating the Athena client.queryExecutionId
(String queryExecutionId) The unique ID identifying the query execution.queryString
(String queryString) The SQL query to run.The region in which Athena client needs to work.resetWaitTimeoutOnRetry
(boolean resetWaitTimeoutOnRetry) Reset the waitTimeout countdown in the event of a query retry.resetWaitTimeoutOnRetry
(String resetWaitTimeoutOnRetry) Reset the waitTimeout countdown in the event of a query retry.Optional comma separated list of error types to retry the query for.Amazon AWS Secret Key.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.useDefaultCredentialsProvider
(String 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.useProfileCredentialsProvider
(boolean useProfileCredentialsProvider) Set whether the Athena client should expect to load credentials through a profile credentials provider.useProfileCredentialsProvider
(String useProfileCredentialsProvider) Set whether the Athena client should expect to load credentials through a profile credentials provider.waitTimeout
(long waitTimeout) Optional max wait time in millis to wait for a successful query completion.waitTimeout
(String waitTimeout) Optional max wait time in millis to wait for a successful query completion.The workgroup to use for running the query.Methods inherited from interface org.apache.camel.builder.EndpointProducerBuilder
doSetMultiValueProperties, doSetMultiValueProperty, doSetProperty, expr, getRawUri, getUri
Methods inherited from interface org.apache.camel.EndpointProducerResolver
resolve, resolve
-
Method Details
-
advanced
-
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
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
-
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 will be converted to a <code>long</code> type. Default: 2000 Group: producer- Parameters:
delay
- the value to set- Returns:
- the dsl builder
-
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
-
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 will be converted to a <code>long</code> type. Default: 1000 Group: producer- Parameters:
initialDelay
- the value to set- Returns:
- the dsl builder
-
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
-
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 will be converted to a <code>int</code> type. Default: 1 Group: producer- Parameters:
maxAttempts
- the value to set- Returns:
- the dsl builder
-
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
-
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 will be converted to a <code>java.lang.Integer</code> type. Group: producer- Parameters:
maxResults
- the value to set- Returns:
- the dsl builder
-
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 Athena2EndpointBuilderFactory.Athena2EndpointBuilder 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
-
operation
The Athena API function to call. The option will be converted to 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
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 Athena2EndpointBuilderFactory.Athena2EndpointBuilder 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
-
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 will be converted to 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 Athena2EndpointBuilderFactory.Athena2EndpointBuilder 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
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
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 Athena2EndpointBuilderFactory.Athena2EndpointBuilder 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
-
resetWaitTimeoutOnRetry
default Athena2EndpointBuilderFactory.Athena2EndpointBuilder resetWaitTimeoutOnRetry(String 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 will be converted to a <code>boolean</code> type. Default: true Group: producer- Parameters:
resetWaitTimeoutOnRetry
- the value to set- Returns:
- the dsl builder
-
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
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. Default: 0 Group: producer- Parameters:
waitTimeout
- the value to set- Returns:
- the dsl builder
-
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 will be converted to a <code>long</code> type. Default: 0 Group: producer- Parameters:
waitTimeout
- the value to set- Returns:
- the dsl builder
-
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
-
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
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
-
proxyPort
To define a proxy port when instantiating the Athena client. The option will be converted to a <code>java.lang.Integer</code> type. Group: proxy- Parameters:
proxyPort
- the value to set- Returns:
- the dsl builder
-
proxyProtocol
default Athena2EndpointBuilderFactory.Athena2EndpointBuilder 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
-
proxyProtocol
To define a proxy protocol when instantiating the Athena client. The option will be converted to a <code>software.amazon.awssdk.core.Protocol</code> type. Default: HTTPS Group: proxy- Parameters:
proxyProtocol
- the value to set- Returns:
- the dsl builder
-
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 Athena2EndpointBuilderFactory.Athena2EndpointBuilder 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
-
encryptionOption
default Athena2EndpointBuilderFactory.Athena2EndpointBuilder encryptionOption(String encryptionOption) The encryption type to use when storing query results in S3. One of SSE_S3, SSE_KMS, or CSE_KMS. The option will be converted to a <code>software.amazon.awssdk.services.athena.model.EncryptionOption</code> type. Group: security- Parameters:
encryptionOption
- the value to set- Returns:
- the dsl builder
-
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 Athena2EndpointBuilderFactory.Athena2EndpointBuilder 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
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
-
useDefaultCredentialsProvider
default Athena2EndpointBuilderFactory.Athena2EndpointBuilder 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
-
useDefaultCredentialsProvider
default Athena2EndpointBuilderFactory.Athena2EndpointBuilder useDefaultCredentialsProvider(String 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 will be converted to a <code>boolean</code> type. Default: false Group: security- Parameters:
useDefaultCredentialsProvider
- the value to set- Returns:
- the dsl builder
-
useProfileCredentialsProvider
default Athena2EndpointBuilderFactory.Athena2EndpointBuilder 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
-
useProfileCredentialsProvider
default Athena2EndpointBuilderFactory.Athena2EndpointBuilder useProfileCredentialsProvider(String useProfileCredentialsProvider) Set whether the Athena client should expect to load credentials through a profile credentials provider. The option will be converted to a <code>boolean</code> type. Default: false Group: security- Parameters:
useProfileCredentialsProvider
- the value to set- Returns:
- the dsl builder
-