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

Class Athena2EndpointBuilderFactory.Athena2HeaderNameBuilder

  • Enclosing interface:
    Athena2EndpointBuilderFactory
    public static class Athena2EndpointBuilderFactory.Athena2HeaderNameBuilder
extends Object
    The builder of headers' name for the AWS Athena component.

    • Constructor Detail

      • Athena2HeaderNameBuilder

        public Athena2HeaderNameBuilder()

    • Method Detail

      • awsAthenaOperation

        public String awsAthenaOperation()
        The operation to perform. Permitted values are getQueryExecution, getQueryResults, listQueryExecutions, startQueryExecution. The option is a: org.apache.camel.component.aws2.athena.Athena2Operations type. Default: startQueryExecution Group: all
        Returns:
        the name of the header AwsAthenaOperation.

      • awsAthenaDatabase

        public String awsAthenaDatabase()
        The Athena database to use. The option is a: String type. Group: startQueryExecution
        Returns:
        the name of the header AwsAthenaDatabase.

      • awsAthenaQueryExecutionId

        public String awsAthenaQueryExecutionId()
        The unique ID identifying the query execution. The option is a: String type. Group: getQueryExecution getQueryResults startQueryExecution
        Returns:
        the name of the header AwsAthenaQueryExecutionId.

      • awsAthenaWorkGroup

        public String awsAthenaWorkGroup()
        The workgroup to use for running the query. The option is a: String type. Group: listQueryExecutions startQueryExecution
        Returns:
        the name of the header AwsAthenaWorkGroup.

      • awsAthenaNextToken

        public String awsAthenaNextToken()
        Pagination token to use in the case where the response from the previous request was truncated. The option is a: String type. Group: getQueryResults listQueryExecutions
        Returns:
        the name of the header AwsAthenaNextToken.

      • awsAthenaMaxResults

        public String awsAthenaMaxResults()
        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: Integer type. Group: getQueryResults listQueryExecutions
        Returns:
        the name of the header AwsAthenaMaxResults.

      • awsAthenaIncludeTrace

        public String awsAthenaIncludeTrace()
        Include useful trace information at the beginning of queries as an SQL comment (prefixed with --). The option is a: boolean type. Group: startQueryExecution
        Returns:
        the name of the header AwsAthenaIncludeTrace.

      • awsAthenaOutputLocation

        public String awsAthenaOutputLocation()
        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: String type. Group: getQueryExecution getQueryResults startQueryExecution
        Returns:
        the name of the header AwsAthenaOutputLocation.

      • awsAthenaOutputType

        public String awsAthenaOutputType()
        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. Group: getQueryResults
        Returns:
        the name of the header AwsAthenaOutputType.

      • awsAthenaQueryExecutionState

        public String awsAthenaQueryExecutionState()
        The state of the query execution. The option is a: software.amazon.awssdk.services.athena.model.QueryExecutionState type. Group: getQueryExecution getQueryResults startQueryExecution
        Returns:
        the name of the header AwsAthenaQueryExecutionState.

      • awsAthenaClientRequestToken

        public String awsAthenaClientRequestToken()
        A unique string to ensure issues queries are idempotent. It is unlikely you will need to set this. The option is a: String type. Group: startQueryExecution
        Returns:
        the name of the header AwsAthenaClientRequestToken.

      • awsAthenaQueryString

        public String awsAthenaQueryString()
        The SQL query to run. Except for simple queries, prefer setting this as the body of the Exchange or as this header to avoid having to deal with URL encoding issues. The option is a: String type. Group: startQueryExecution
        Returns:
        the name of the header AwsAthenaQueryString.

      • awsAthenaEncryptionOption

        public String awsAthenaEncryptionOption()
        The encryption type to use when storing query results in S3. The option is a: software.amazon.awssdk.services.athena.model.EncryptionOption type. Group: startQueryExecution
        Returns:
        the name of the header AwsAthenaEncryptionOption.

      • awsAthenaKmsKey

        public String awsAthenaKmsKey()
        For SSE-KMS and CSE-KMS, this is the KMS key ARN or ID. The option is a: String type. Group: startQueryExecution
        Returns:
        the name of the header AwsAthenaKmsKey.

      • awsAthenaWaitTimeout

        public String awsAthenaWaitTimeout()
        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. Group: startQueryExecution
        Returns:
        the name of the header AwsAthenaWaitTimeout.

      • awsAthenaInitialDelay

        public String awsAthenaInitialDelay()
        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. Group: startQueryExecution
        Returns:
        the name of the header AwsAthenaInitialDelay.

      • awsAthenaDelay

        public String awsAthenaDelay()
        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. Group: startQueryExecution
        Returns:
        the name of the header AwsAthenaDelay.

      • awsAthenaMaxAttempts

        public String awsAthenaMaxAttempts()
        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. Group: startQueryExecution
        Returns:
        the name of the header AwsAthenaMaxAttempts.

      • awsAthenaRetry

        public String awsAthenaRetry()
        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: String type. Group: startQueryExecution
        Returns:
        the name of the header AwsAthenaRetry.

      • awsAthenaResetWaitTimeoutOnRetry

        public String awsAthenaResetWaitTimeoutOnRetry()
        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. Group: startQueryExecution
        Returns:
        the name of the header AwsAthenaResetWaitTimeoutOnRetry.

      • awsAthenaStartQueryExecutionAttempts

        public String awsAthenaStartQueryExecutionAttempts()
        Total number of attempts made to run the query. Will be greater than 1 if the query is retried. The option is a: int type. Group: startQueryExecution
        Returns:
        the name of the header AwsAthenaStartQueryExecutionAttempts.

      • awsAthenaStartQueryExecutionElapsedMillis

        public String awsAthenaStartQueryExecutionElapsedMillis()
        Total time in millis taken in startQueryExecution (mostly relevant when waiting for query completion within startQueryExecution). The option is a: long type. Group: startQueryExecution
        Returns:
        the name of the header AwsAthenaStartQueryExecutionElapsedMillis.