software.amazon.awssdk.services.athena.model

Class StartQueryExecutionRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.athena.model.AthenaRequest

software.amazon.awssdk.services.athena.model.StartQueryExecutionRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<StartQueryExecutionRequest.Builder,StartQueryExecutionRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class StartQueryExecutionRequest
extends AthenaRequest
implements ToCopyableBuilder<StartQueryExecutionRequest.Builder,StartQueryExecutionRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	StartQueryExecutionRequest.Builder

Method Summary

Modifier and Type	Method and Description
static StartQueryExecutionRequest.Builder	builder()
String	clientRequestToken() A unique case-sensitive string used to ensure the request to create the query is idempotent (executes only once).
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
List<String>	executionParameters() A list of values for the parameters in a query.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasExecutionParameters() For responses, this returns true if the service returned a value for the ExecutionParameters property.
int	hashCode()
QueryExecutionContext	queryExecutionContext() The database within which the query executes.
String	queryString() The SQL query statements to be executed.
ResultConfiguration	resultConfiguration() Specifies information about where and how to save the results of the query execution.
ResultReuseConfiguration	resultReuseConfiguration() Specifies the query result reuse behavior for the query.
List<SdkField<?>>	sdkFields()
static Class<? extends StartQueryExecutionRequest.Builder>	serializableBuilderClass()
StartQueryExecutionRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.
String	workGroup() The name of the workgroup in which the query is being started.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

queryString

public final String queryString()

The SQL query statements to be executed.

Returns:

The SQL query statements to be executed.

clientRequestToken

public final 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. If a parameter has changed, for example, the QueryString, an error is returned.

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. If a parameter has changed, for example, the QueryString, an error is returned.

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.

queryExecutionContext

public final QueryExecutionContext queryExecutionContext()

The database within which the query executes.

Returns:

The database within which the query executes.

resultConfiguration

public final 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.

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.

workGroup

public final String workGroup()

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.

hasExecutionParameters

public final boolean hasExecutionParameters()

For responses, this returns true if the service returned a value for the ExecutionParameters property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

executionParameters

public final List<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.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasExecutionParameters() method.

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.

resultReuseConfiguration

public final ResultReuseConfiguration resultReuseConfiguration()

Specifies the query result reuse behavior for the query.

Returns:

Specifies the query result reuse behavior for the query.

toBuilder

public StartQueryExecutionRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<StartQueryExecutionRequest.Builder,StartQueryExecutionRequest>

Specified by:

toBuilder in class AthenaRequest

builder

public static StartQueryExecutionRequest.Builder builder()

serializableBuilderClass

public static Class<? extends StartQueryExecutionRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final 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

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo