Package software.amazon.awssdk.services.athena.model

Interface StartQueryExecutionRequest.Builder

    • Method Detail

      • queryString

        StartQueryExecutionRequest.Builder queryString​(String queryString)

        The SQL query statements to be executed.

        Parameters:
        queryString - The SQL query statements to be executed.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • clientRequestToken

        StartQueryExecutionRequest.Builder clientRequestToken​(String clientRequestToken)

        A unique case-sensitive string used to ensure the request to create the query is idempotent (executes only once). If another StartQueryExecution request is received, the same response is returned and another query is not created. An error is returned if a parameter, such as QueryString, has changed. A call to StartQueryExecution that uses a previous client request token returns the same QueryExecutionId even if the requester doesn't have permission on the tables specified in QueryString.

        This token is listed as not required because Amazon Web Services SDKs (for example the Amazon Web Services SDK for Java) auto-generate the token for users. If you are not using the Amazon Web Services SDK or the Amazon Web Services CLI, you must provide this token or the action will fail.

        Parameters:
        clientRequestToken - A unique case-sensitive string used to ensure the request to create the query is idempotent (executes only once). If another StartQueryExecution request is received, the same response is returned and another query is not created. An error is returned if a parameter, such as QueryString, has changed. A call to StartQueryExecution that uses a previous client request token returns the same QueryExecutionId even if the requester doesn't have permission on the tables specified in QueryString.

        This token is listed as not required because Amazon Web Services SDKs (for example the Amazon Web Services SDK for Java) auto-generate the token for users. If you are not using the Amazon Web Services SDK or the Amazon Web Services CLI, you must provide this token or the action will fail.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • queryExecutionContext

        StartQueryExecutionRequest.Builder queryExecutionContext​(QueryExecutionContext queryExecutionContext)

        The database within which the query executes.

        Parameters:
        queryExecutionContext - The database within which the query executes.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • resultConfiguration

        StartQueryExecutionRequest.Builder resultConfiguration​(ResultConfiguration resultConfiguration)

        Specifies information about where and how to save the results of the query execution. If the query runs in a workgroup, then workgroup's settings may override query settings. This affects the query results location. The workgroup settings override is specified in EnforceWorkGroupConfiguration (true/false) in the WorkGroupConfiguration. See WorkGroupConfiguration$EnforceWorkGroupConfiguration.

        Parameters:
        resultConfiguration - Specifies information about where and how to save the results of the query execution. If the query runs in a workgroup, then workgroup's settings may override query settings. This affects the query results location. The workgroup settings override is specified in EnforceWorkGroupConfiguration (true/false) in the WorkGroupConfiguration. See WorkGroupConfiguration$EnforceWorkGroupConfiguration.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • workGroup

        StartQueryExecutionRequest.Builder workGroup​(String workGroup)

        The name of the workgroup in which the query is being started.

        Parameters:
        workGroup - The name of the workgroup in which the query is being started.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • executionParameters

        StartQueryExecutionRequest.Builder executionParameters​(Collection<String> executionParameters)

        A list of values for the parameters in a query. The values are applied sequentially to the parameters in the query in the order in which the parameters occur.

        Parameters:
        executionParameters - A list of values for the parameters in a query. The values are applied sequentially to the parameters in the query in the order in which the parameters occur.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • executionParameters

        StartQueryExecutionRequest.Builder executionParameters​(String... executionParameters)

        A list of values for the parameters in a query. The values are applied sequentially to the parameters in the query in the order in which the parameters occur.

        Parameters:
        executionParameters - A list of values for the parameters in a query. The values are applied sequentially to the parameters in the query in the order in which the parameters occur.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • resultReuseConfiguration

        StartQueryExecutionRequest.Builder resultReuseConfiguration​(ResultReuseConfiguration resultReuseConfiguration)

        Specifies the query result reuse behavior for the query.

        Parameters:
        resultReuseConfiguration - Specifies the query result reuse behavior for the query.
        Returns:
        Returns a reference to this object so that method calls can be chained together.