Package software.amazon.awssdk.services.timestreamquery.model

Class QueryResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.timestreamquery.model.TimestreamQueryResponse

software.amazon.awssdk.services.timestreamquery.model.QueryResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<QueryResponse.Builder,QueryResponse>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	QueryResponse.Builder

Method Summary

Modifier and Type	Method	Description
static QueryResponse.Builder	builder()
List<ColumnInfo>	columnInfo()	The column data types of the returned result set.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasColumnInfo()	For responses, this returns true if the service returned a value for the ColumnInfo property.
int	hashCode()
boolean	hasRows()	For responses, this returns true if the service returned a value for the Rows property.
String	nextToken()	A pagination token that can be used again on a Query call to get the next set of results.
String	queryId()	A unique ID for the given query.
QueryStatus	queryStatus()	Information about the status of the query, including progress and bytes scanned.
List<Row>	rows()	The result set rows returned by the query.
List<SdkField<?>>	sdkFields()
static Class<? extends QueryResponse.Builder>	serializableBuilderClass()
QueryResponse.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.services.timestreamquery.model.TimestreamQueryResponse

responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse

sdkHttpResponse

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

queryId

public final String queryId()

A unique ID for the given query.

Returns:

A unique ID for the given query.

nextToken

public final String nextToken()

A pagination token that can be used again on a Query call to get the next set of results.

Returns:

A pagination token that can be used again on a Query call to get the next set of results.

hasRows

public final boolean hasRows()

For responses, this returns true if the service returned a value for the Rows 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.

rows

public final List<Row> rows()

The result set rows returned by the query.

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 hasRows() method.

Returns:

The result set rows returned by the query.

hasColumnInfo

public final boolean hasColumnInfo()

For responses, this returns true if the service returned a value for the ColumnInfo 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.

columnInfo

public final List<ColumnInfo> columnInfo()

The column data types of the returned result set.

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 hasColumnInfo() method.

Returns:

The column data types of the returned result set.

queryStatus

public final QueryStatus queryStatus()

Information about the status of the query, including progress and bytes scanned.

Returns:

Information about the status of the query, including progress and bytes scanned.

toBuilder

public QueryResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<QueryResponse.Builder,QueryResponse>

Specified by:

toBuilder in class AwsResponse

builder

public static QueryResponse.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsResponse

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsResponse

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 SdkResponse

sdkFields

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

Specified by:

sdkFields in interface SdkPojo