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("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 Description static interfaceExecuteStatementResponse.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static ExecuteStatementResponse.Builderbuilder()List<ColumnMetadata>columnMetadata()Metadata for the columns included in the results.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)StringformattedRecords()A string value that represents the result set of aSELECTstatement in JSON format.List<Field>generatedFields()Values for fields generated during a DML request.<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)booleanhasColumnMetadata()For responses, this returns true if the service returned a value for the ColumnMetadata property.booleanhasGeneratedFields()For responses, this returns true if the service returned a value for the GeneratedFields property.inthashCode()booleanhasRecords()For responses, this returns true if the service returned a value for the Records property.LongnumberOfRecordsUpdated()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.BuildertoBuilder()StringtoString()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 theisEmpty()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
formatRecordsAsparameter is set toJSON.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
formatRecordsAsparameter is set toJSON.
-
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 theisEmpty()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
formatRecordsAsparameter is set toJSON.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
formatRecordsAsparameter is set toJSON.
-
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 theisEmpty()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.
The
generatedFieldsdata isn't supported by Aurora PostgreSQL. To get the values of generated fields, use theRETURNINGclause. For more information, see Returning Data From Modified Rows in the PostgreSQL documentation.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.
The
generatedFieldsdata isn't supported by Aurora PostgreSQL. To get the values of generated fields, use theRETURNINGclause. For more information, see Returning Data From Modified Rows in the PostgreSQL documentation.
-
formattedRecords
public final String formattedRecords()
A string value that represents the result set of a
SELECTstatement in JSON format. This value is only present when theformatRecordsAsparameter is set toJSON.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
SELECTstatement in JSON format. This value is only present when theformatRecordsAsparameter is set toJSON.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:
toBuilderin interfaceToCopyableBuilder<ExecuteStatementResponse.Builder,ExecuteStatementResponse>- Specified by:
toBuilderin classAwsResponse
-
builder
public static ExecuteStatementResponse.Builder builder()
-
serializableBuilderClass
public static Class<? extends ExecuteStatementResponse.Builder> serializableBuilderClass()
-
hashCode
public final int hashCode()
- Overrides:
hashCodein classAwsResponse
-
equals
public final boolean equals(Object obj)
- Overrides:
equalsin classAwsResponse
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
getValueForField
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
- Overrides:
getValueForFieldin classSdkResponse
-
-