Interface QueryResponse.Builder

All Superinterfaces:

AwsResponse.Builder, Buildable, CopyableBuilder<QueryResponse.Builder,QueryResponse>, SdkBuilder<QueryResponse.Builder,QueryResponse>, SdkPojo, SdkResponse.Builder, TimestreamQueryResponse.Builder

Enclosing class:

QueryResponse

@Mutable
@NotThreadSafe
public static interface QueryResponse.Builder
extends TimestreamQueryResponse.Builder, SdkPojo, CopyableBuilder<QueryResponse.Builder,QueryResponse>

Method Summary

Modifier and Type	Method	Description
QueryResponse.Builder	columnInfo(Collection<ColumnInfo> columnInfo)	The column data types of the returned result set.
QueryResponse.Builder	columnInfo(Consumer<ColumnInfo.Builder>... columnInfo)	The column data types of the returned result set.
QueryResponse.Builder	columnInfo(ColumnInfo... columnInfo)	The column data types of the returned result set.
QueryResponse.Builder	nextToken(String nextToken)	A pagination token that can be used again on a Query call to get the next set of results.
QueryResponse.Builder	queryId(String queryId)	A unique ID for the given query.
default QueryResponse.Builder	queryInsightsResponse(Consumer<QueryInsightsResponse.Builder> queryInsightsResponse)	Encapsulates QueryInsights containing insights and metrics related to the query that you executed.
QueryResponse.Builder	queryInsightsResponse(QueryInsightsResponse queryInsightsResponse)	Encapsulates QueryInsights containing insights and metrics related to the query that you executed.
default QueryResponse.Builder	queryStatus(Consumer<QueryStatus.Builder> queryStatus)	Information about the status of the query, including progress and bytes scanned.
QueryResponse.Builder	queryStatus(QueryStatus queryStatus)	Information about the status of the query, including progress and bytes scanned.
QueryResponse.Builder	rows(Collection<Row> rows)	The result set rows returned by the query.
QueryResponse.Builder	rows(Consumer<Row.Builder>... rows)	The result set rows returned by the query.
QueryResponse.Builder	rows(Row... rows)	The result set rows returned by the query.

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

copy

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

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFieldNameToField, sdkFields

Methods inherited from interface software.amazon.awssdk.core.SdkResponse.Builder

sdkHttpResponse, sdkHttpResponse

Methods inherited from interface software.amazon.awssdk.services.timestreamquery.model.TimestreamQueryResponse.Builder

build, responseMetadata, responseMetadata

Method Details

queryId

QueryResponse.Builder queryId(String queryId)

A unique ID for the given query.

Parameters:

queryId - A unique ID for the given query.

Returns:

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

nextToken

QueryResponse.Builder nextToken(String nextToken)

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

Parameters:

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

Returns:

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

rows

QueryResponse.Builder rows(Collection<Row> rows)

The result set rows returned by the query.

Parameters:

rows - The result set rows returned by the query.

Returns:

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

rows

QueryResponse.Builder rows(Row... rows)

The result set rows returned by the query.

Parameters:

rows - The result set rows returned by the query.

Returns:

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

rows

QueryResponse.Builder rows(Consumer<Row.Builder>... rows)

The result set rows returned by the query.

This is a convenience method that creates an instance of the Row.Builder avoiding the need to create one manually via Row.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to rows(List<Row>).

Parameters:

rows - a consumer that will call methods on Row.Builder

Returns:

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

See Also:

• rows(java.util.Collection<Row>)

columnInfo

QueryResponse.Builder columnInfo(Collection<ColumnInfo> columnInfo)

The column data types of the returned result set.

Parameters:

columnInfo - The column data types of the returned result set.

Returns:

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

columnInfo

QueryResponse.Builder columnInfo(ColumnInfo... columnInfo)

The column data types of the returned result set.

Parameters:

columnInfo - The column data types of the returned result set.

Returns:

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

columnInfo

QueryResponse.Builder columnInfo(Consumer<ColumnInfo.Builder>... columnInfo)

The column data types of the returned result set.

This is a convenience method that creates an instance of the ColumnInfo.Builder avoiding the need to create one manually via ColumnInfo.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to columnInfo(List<ColumnInfo>).

Parameters:

columnInfo - a consumer that will call methods on ColumnInfo.Builder

Returns:

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

See Also:

• columnInfo(java.util.Collection<ColumnInfo>)

queryStatus

QueryResponse.Builder queryStatus(QueryStatus queryStatus)

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

Parameters:

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

Returns:

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

queryStatus

default QueryResponse.Builder queryStatus(Consumer<QueryStatus.Builder> queryStatus)

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

This is a convenience method that creates an instance of the QueryStatus.Builder avoiding the need to create one manually via QueryStatus.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to queryStatus(QueryStatus).

Parameters:

queryStatus - a consumer that will call methods on QueryStatus.Builder

Returns:

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

See Also:

• queryStatus(QueryStatus)

queryInsightsResponse

QueryResponse.Builder queryInsightsResponse(QueryInsightsResponse queryInsightsResponse)

Encapsulates QueryInsights containing insights and metrics related to the query that you executed.

Parameters:

queryInsightsResponse - Encapsulates QueryInsights containing insights and metrics related to the query that you executed.

Returns:

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

queryInsightsResponse

default QueryResponse.Builder queryInsightsResponse(Consumer<QueryInsightsResponse.Builder> queryInsightsResponse)

Encapsulates QueryInsights containing insights and metrics related to the query that you executed.

This is a convenience method that creates an instance of the QueryInsightsResponse.Builder avoiding the need to create one manually via QueryInsightsResponse.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to queryInsightsResponse(QueryInsightsResponse).

Parameters:

queryInsightsResponse - a consumer that will call methods on QueryInsightsResponse.Builder

Returns:

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

See Also:

• queryInsightsResponse(QueryInsightsResponse)