com.amazonaws.services.athena.model

Class StartQueryExecutionRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.athena.model.StartQueryExecutionRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class StartQueryExecutionRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
StartQueryExecutionRequest()

Method Summary

Modifier and Type	Method and Description
StartQueryExecutionRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getClientRequestToken() A unique case-sensitive string used to ensure the request to create the query is idempotent (executes only once).
List<String>	getExecutionParameters() A list of values for the parameters in a query.
QueryExecutionContext	getQueryExecutionContext() The database within which the query executes.
String	getQueryString() The SQL query statements to be executed.
ResultConfiguration	getResultConfiguration() Specifies information about where and how to save the results of the query execution.
ResultReuseConfiguration	getResultReuseConfiguration() Specifies the query result reuse behavior for the query.
String	getWorkGroup() The name of the workgroup in which the query is being started.
int	hashCode()
void	setClientRequestToken(String clientRequestToken) A unique case-sensitive string used to ensure the request to create the query is idempotent (executes only once).
void	setExecutionParameters(Collection<String> executionParameters) A list of values for the parameters in a query.
void	setQueryExecutionContext(QueryExecutionContext queryExecutionContext) The database within which the query executes.
void	setQueryString(String queryString) The SQL query statements to be executed.
void	setResultConfiguration(ResultConfiguration resultConfiguration) Specifies information about where and how to save the results of the query execution.
void	setResultReuseConfiguration(ResultReuseConfiguration resultReuseConfiguration) Specifies the query result reuse behavior for the query.
void	setWorkGroup(String workGroup) The name of the workgroup in which the query is being started.
String	toString() Returns a string representation of this object.
StartQueryExecutionRequest	withClientRequestToken(String clientRequestToken) A unique case-sensitive string used to ensure the request to create the query is idempotent (executes only once).
StartQueryExecutionRequest	withExecutionParameters(Collection<String> executionParameters) A list of values for the parameters in a query.
StartQueryExecutionRequest	withExecutionParameters(String... executionParameters) A list of values for the parameters in a query.
StartQueryExecutionRequest	withQueryExecutionContext(QueryExecutionContext queryExecutionContext) The database within which the query executes.
StartQueryExecutionRequest	withQueryString(String queryString) The SQL query statements to be executed.
StartQueryExecutionRequest	withResultConfiguration(ResultConfiguration resultConfiguration) Specifies information about where and how to save the results of the query execution.
StartQueryExecutionRequest	withResultReuseConfiguration(ResultReuseConfiguration resultReuseConfiguration) Specifies the query result reuse behavior for the query.
StartQueryExecutionRequest	withWorkGroup(String workGroup) The name of the workgroup in which the query is being started.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

StartQueryExecutionRequest

public StartQueryExecutionRequest()

Method Detail

setQueryString

public void setQueryString(String queryString)

The SQL query statements to be executed.

Parameters:

queryString - The SQL query statements to be executed.

getQueryString

public String getQueryString()

The SQL query statements to be executed.

Returns:

The SQL query statements to be executed.

withQueryString

public StartQueryExecutionRequest withQueryString(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.

setClientRequestToken

public void setClientRequestToken(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.

getClientRequestToken

public String getClientRequestToken()

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:

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.

withClientRequestToken

public StartQueryExecutionRequest withClientRequestToken(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.

setQueryExecutionContext

public void setQueryExecutionContext(QueryExecutionContext queryExecutionContext)

The database within which the query executes.

Parameters:

queryExecutionContext - The database within which the query executes.

getQueryExecutionContext

public QueryExecutionContext getQueryExecutionContext()

The database within which the query executes.

Returns:

The database within which the query executes.

withQueryExecutionContext

public StartQueryExecutionRequest withQueryExecutionContext(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.

setResultConfiguration

public void setResultConfiguration(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.

getResultConfiguration

public ResultConfiguration getResultConfiguration()

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:

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.

withResultConfiguration

public StartQueryExecutionRequest withResultConfiguration(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.

setWorkGroup

public void setWorkGroup(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.

getWorkGroup

public String getWorkGroup()

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

Returns:

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

withWorkGroup

public StartQueryExecutionRequest withWorkGroup(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.

getExecutionParameters

public List<String> getExecutionParameters()

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:

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.

setExecutionParameters

public void setExecutionParameters(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.

withExecutionParameters

public StartQueryExecutionRequest withExecutionParameters(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.

NOTE: This method appends the values to the existing list (if any). Use setExecutionParameters(java.util.Collection) or withExecutionParameters(java.util.Collection) if you want to override the existing values.

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.

withExecutionParameters

public StartQueryExecutionRequest withExecutionParameters(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.

setResultReuseConfiguration

public void setResultReuseConfiguration(ResultReuseConfiguration resultReuseConfiguration)

Specifies the query result reuse behavior for the query.

Parameters:

resultReuseConfiguration - Specifies the query result reuse behavior for the query.

getResultReuseConfiguration

public ResultReuseConfiguration getResultReuseConfiguration()

Specifies the query result reuse behavior for the query.

Returns:

Specifies the query result reuse behavior for the query.

withResultReuseConfiguration

public StartQueryExecutionRequest withResultReuseConfiguration(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.

toString

public String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public StartQueryExecutionRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()