software.amazon.awssdk.services.rdsdata.model

Class ResultFrame

java.lang.Object

software.amazon.awssdk.services.rdsdata.model.ResultFrame

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<ResultFrame.Builder,ResultFrame>

@Generated(value="software.amazon.awssdk:codegen")
public final class ResultFrame
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<ResultFrame.Builder,ResultFrame>

The result set returned by a SQL statement.

This data structure is only used with the deprecated ExecuteSql operation. Use the BatchExecuteStatement or ExecuteStatement operation instead.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ResultFrame.Builder

Method Summary

Modifier and Type	Method and Description
static ResultFrame.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasRecords() For responses, this returns true if the service returned a value for the Records property.
List<Record>	records() The records in the result set.
ResultSetMetadata	resultSetMetadata() The result-set metadata in the result set.
List<SdkField<?>>	sdkFields()
static Class<? extends ResultFrame.Builder>	serializableBuilderClass()
ResultFrame.Builder	toBuilder()
String	toString() Returns a string representation of this object.

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

resultSetMetadata

public final ResultSetMetadata resultSetMetadata()

The result-set metadata in the result set.

Returns:

The result-set metadata in the result set.

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<Record> records()

The records in the 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 hasRecords() method.

Returns:

The records in the result set.

toBuilder

public ResultFrame.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ResultFrame.Builder,ResultFrame>

builder

public static ResultFrame.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

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)

sdkFields

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

Specified by:

sdkFields in interface SdkPojo