software.amazon.awssdk.services.rdsdata.model

Class ExecuteStatementResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.rdsdata.model.RdsDataResponse

software.amazon.awssdk.services.rdsdata.model.ExecuteStatementResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<ExecuteStatementResponse.Builder,ExecuteStatementResponse>

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

The response elements represent the output of a request to run a SQL statement against a database.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ExecuteStatementResponse.Builder

Method Summary

Modifier and Type	Method and Description
static ExecuteStatementResponse.Builder	builder()
List<ColumnMetadata>	columnMetadata() Metadata for the columns included in the results.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	formattedRecords() A string value that represents the result set of a SELECT statement in JSON format.
List<Field>	generatedFields() Values for fields generated during a DML request.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasColumnMetadata() For responses, this returns true if the service returned a value for the ColumnMetadata property.
boolean	hasGeneratedFields() For responses, this returns true if the service returned a value for the GeneratedFields property.
int	hashCode()
boolean	hasRecords() For responses, this returns true if the service returned a value for the Records property.
Long	numberOfRecordsUpdated() The number of records updated by the request.
List<List<Field>>	records() The records returned by the SQL statement.
List<SdkField<?>>	sdkFields()
static Class<? extends ExecuteStatementResponse.Builder>	serializableBuilderClass()
ExecuteStatementResponse.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.services.rdsdata.model.RdsDataResponse

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

hasRecords

public final boolean hasRecords()

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

records

public final List<List<Field>> records()

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

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

Returns:

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

hasColumnMetadata

public final boolean hasColumnMetadata()

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

columnMetadata

public final List<ColumnMetadata> columnMetadata()

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

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

Returns:

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

numberOfRecordsUpdated

public final Long numberOfRecordsUpdated()

The number of records updated by the request.

Returns:

The number of records updated by the request.

hasGeneratedFields

public final boolean hasGeneratedFields()

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

generatedFields

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

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

Returns:

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> 

formattedRecords

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

Returns:

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.

toBuilder

public ExecuteStatementResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ExecuteStatementResponse.Builder,ExecuteStatementResponse>

Overrides:

toBuilder in class AwsResponse

builder

public static ExecuteStatementResponse.Builder builder()

serializableBuilderClass

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