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

Class GetQueryResultsRequest

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.GetQueryResultsRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<GetQueryResultsRequest.Builder,GetQueryResultsRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	GetQueryResultsRequest.Builder

Method Summary

Modifier and Type	Method	Description
static GetQueryResultsRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Integer	maxResults()	The maximum number of results (rows) to return in this request.
String	nextToken()	A token generated by the Athena service that specifies where to continue pagination if a previous request was truncated.
String	queryExecutionId()	The unique ID of the query execution.
QueryResultType	queryResultType()	When you set this to DATA_ROWS or empty, GetQueryResults returns the query results in rows.
String	queryResultTypeAsString()	When you set this to DATA_ROWS or empty, GetQueryResults returns the query results in rows.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends GetQueryResultsRequest.Builder>	serializableBuilderClass()
GetQueryResultsRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

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

queryExecutionId

public final String queryExecutionId()

The unique ID of the query execution.

Returns:

The unique ID of the query execution.

nextToken

public final String nextToken()

A token generated by the Athena service that specifies where to continue pagination if a previous request was truncated. To obtain the next set of pages, pass in the NextToken from the response object of the previous page call.

Returns:

A token generated by the Athena service that specifies where to continue pagination if a previous request was truncated. To obtain the next set of pages, pass in the NextToken from the response object of the previous page call.

maxResults

public final Integer maxResults()

The maximum number of results (rows) to return in this request.

Returns:

The maximum number of results (rows) to return in this request.

queryResultType

public final QueryResultType queryResultType()

When you set this to DATA_ROWS or empty, GetQueryResults returns the query results in rows. If set to DATA_MANIFEST, it returns the manifest file in rows. Only the query types CREATE TABLE AS SELECT, UNLOAD, and INSERT can generate a manifest file. If you use DATA_MANIFEST for other query types, the query will fail.

If the service returns an enum value that is not available in the current SDK version, queryResultType will return QueryResultType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from queryResultTypeAsString().

Returns:

When you set this to DATA_ROWS or empty, GetQueryResults returns the query results in rows. If set to DATA_MANIFEST, it returns the manifest file in rows. Only the query types CREATE TABLE AS SELECT, UNLOAD, and INSERT can generate a manifest file. If you use DATA_MANIFEST for other query types, the query will fail.

See Also:

QueryResultType

queryResultTypeAsString

public final String queryResultTypeAsString()

When you set this to DATA_ROWS or empty, GetQueryResults returns the query results in rows. If set to DATA_MANIFEST, it returns the manifest file in rows. Only the query types CREATE TABLE AS SELECT, UNLOAD, and INSERT can generate a manifest file. If you use DATA_MANIFEST for other query types, the query will fail.

If the service returns an enum value that is not available in the current SDK version, queryResultType will return QueryResultType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from queryResultTypeAsString().

Returns:

When you set this to DATA_ROWS or empty, GetQueryResults returns the query results in rows. If set to DATA_MANIFEST, it returns the manifest file in rows. Only the query types CREATE TABLE AS SELECT, UNLOAD, and INSERT can generate a manifest file. If you use DATA_MANIFEST for other query types, the query will fail.

See Also:

QueryResultType

toBuilder

public GetQueryResultsRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<GetQueryResultsRequest.Builder,GetQueryResultsRequest>

Specified by:

toBuilder in class AthenaRequest

builder

public static GetQueryResultsRequest.Builder builder()

serializableBuilderClass

public static Class<? extends GetQueryResultsRequest.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

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo