software.amazon.awssdk.services.rdsdata.model

Interface ExecuteStatementResponse.Builder

All Superinterfaces:

AwsResponse.Builder, Buildable, CopyableBuilder<ExecuteStatementResponse.Builder,ExecuteStatementResponse>, RdsDataResponse.Builder, SdkBuilder<ExecuteStatementResponse.Builder,ExecuteStatementResponse>, SdkPojo, SdkResponse.Builder

Enclosing class:

ExecuteStatementResponse

public static interface ExecuteStatementResponse.Builder
extends RdsDataResponse.Builder, SdkPojo, CopyableBuilder<ExecuteStatementResponse.Builder,ExecuteStatementResponse>

Method Summary

Modifier and Type	Method and Description
ExecuteStatementResponse.Builder	columnMetadata(Collection<ColumnMetadata> columnMetadata) Metadata for the columns included in the results.
ExecuteStatementResponse.Builder	columnMetadata(ColumnMetadata... columnMetadata) Metadata for the columns included in the results.
ExecuteStatementResponse.Builder	columnMetadata(Consumer<ColumnMetadata.Builder>... columnMetadata) Metadata for the columns included in the results.
ExecuteStatementResponse.Builder	formattedRecords(String formattedRecords) A string value that represents the result set of a SELECT statement in JSON format.
ExecuteStatementResponse.Builder	generatedFields(Collection<Field> generatedFields) Values for fields generated during a DML request.
ExecuteStatementResponse.Builder	generatedFields(Consumer<Field.Builder>... generatedFields) Values for fields generated during a DML request.
ExecuteStatementResponse.Builder	generatedFields(Field... generatedFields) Values for fields generated during a DML request.
ExecuteStatementResponse.Builder	numberOfRecordsUpdated(Long numberOfRecordsUpdated) The number of records updated by the request.
ExecuteStatementResponse.Builder	records(Collection<? extends Collection<Field>> records) The records returned by the SQL statement.
ExecuteStatementResponse.Builder	records(Collection<Field>... records) The records returned by the SQL statement.

Methods inherited from interface software.amazon.awssdk.services.rdsdata.model.RdsDataResponse.Builder

build, responseMetadata, responseMetadata

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

sdkHttpResponse, sdkHttpResponse

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

equalsBySdkFields, sdkFields

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

copy

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

applyMutation, build

Method Detail

records

ExecuteStatementResponse.Builder records(Collection<? extends Collection<Field>> records)

The records returned by the SQL statement. This field is blank if the formatRecordsAs parameter is set to JSON.

Parameters:

records - The records returned by the SQL statement. This field is blank if the formatRecordsAs parameter is set to JSON.

Returns:

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

records

ExecuteStatementResponse.Builder records(Collection<Field>... records)

The records returned by the SQL statement. This field is blank if the formatRecordsAs parameter is set to JSON.

Parameters:

records - The records returned by the SQL statement. This field is blank if the formatRecordsAs parameter is set to JSON.

Returns:

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

columnMetadata

ExecuteStatementResponse.Builder columnMetadata(Collection<ColumnMetadata> columnMetadata)

Metadata for the columns included in the results. This field is blank if the formatRecordsAs parameter is set to JSON.

Parameters:

columnMetadata - Metadata for the columns included in the results. This field is blank if the formatRecordsAs parameter is set to JSON.

Returns:

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

columnMetadata

ExecuteStatementResponse.Builder columnMetadata(ColumnMetadata... columnMetadata)

Metadata for the columns included in the results. This field is blank if the formatRecordsAs parameter is set to JSON.

Parameters:

columnMetadata - Metadata for the columns included in the results. This field is blank if the formatRecordsAs parameter is set to JSON.

Returns:

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

columnMetadata

ExecuteStatementResponse.Builder columnMetadata(Consumer<ColumnMetadata.Builder>... columnMetadata)

Metadata for the columns included in the results. This field is blank if the formatRecordsAs parameter is set to JSON.

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

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #columnMetadata(List).

Parameters:

columnMetadata - a consumer that will call methods on ColumnMetadata.Builder

Returns:

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

See Also:

#columnMetadata(java.util.Collection)

numberOfRecordsUpdated

ExecuteStatementResponse.Builder numberOfRecordsUpdated(Long numberOfRecordsUpdated)

The number of records updated by the request.

Parameters:

numberOfRecordsUpdated - The number of records updated by the request.

Returns:

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

generatedFields

ExecuteStatementResponse.Builder generatedFields(Collection<Field> generatedFields)

Values for fields generated during a DML request.

  <note> <p>The <code>generatedFields</code> data isn't supported by Aurora PostgreSQL. To get the values of generated fields, use the <code>RETURNING</code> clause. For more information, see <a href="https://www.postgresql.org/docs/10/dml-returning.html">Returning Data From Modified Rows</a> in the PostgreSQL documentation.</p> </note> 
 

Parameters:

generatedFields - Values for fields generated during a DML request.

  <note> <p>The <code>generatedFields</code> data isn't supported by Aurora PostgreSQL. To get the values of generated fields, use the <code>RETURNING</code> clause. For more information, see <a href="https://www.postgresql.org/docs/10/dml-returning.html">Returning Data From Modified Rows</a> in the PostgreSQL documentation.</p> </note> 

Returns:

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

generatedFields

ExecuteStatementResponse.Builder generatedFields(Field... generatedFields)

Values for fields generated during a DML request.

  <note> <p>The <code>generatedFields</code> data isn't supported by Aurora PostgreSQL. To get the values of generated fields, use the <code>RETURNING</code> clause. For more information, see <a href="https://www.postgresql.org/docs/10/dml-returning.html">Returning Data From Modified Rows</a> in the PostgreSQL documentation.</p> </note> 
 

Parameters:

generatedFields - Values for fields generated during a DML request.

  <note> <p>The <code>generatedFields</code> data isn't supported by Aurora PostgreSQL. To get the values of generated fields, use the <code>RETURNING</code> clause. For more information, see <a href="https://www.postgresql.org/docs/10/dml-returning.html">Returning Data From Modified Rows</a> in the PostgreSQL documentation.</p> </note> 

Returns:

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

generatedFields

ExecuteStatementResponse.Builder generatedFields(Consumer<Field.Builder>... generatedFields)

Values for fields generated during a DML request.

  <note> <p>The <code>generatedFields</code> data isn't supported by Aurora PostgreSQL. To get the values of generated fields, use the <code>RETURNING</code> clause. For more information, see <a href="https://www.postgresql.org/docs/10/dml-returning.html">Returning Data From Modified Rows</a> in the PostgreSQL documentation.</p> </note> 
 

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

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #generatedFields(List).

Parameters:

generatedFields - a consumer that will call methods on Field.Builder

Returns:

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

See Also:

#generatedFields(java.util.Collection)

formattedRecords

ExecuteStatementResponse.Builder formattedRecords(String formattedRecords)

A string value that represents the result set of a SELECT statement in JSON format. This value is only present when the formatRecordsAs parameter is set to JSON.

The size limit for this field is currently 10 MB. If the JSON-formatted string representing the result set requires more than 10 MB, the call returns an error.

Parameters:

formattedRecords - A string value that represents the result set of a SELECT statement in JSON format. This value is only present when the formatRecordsAs parameter is set to JSON.

The size limit for this field is currently 10 MB. If the JSON-formatted string representing the result set requires more than 10 MB, the call returns an error.

Returns:

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