Class GetStatementResultV2Response
- java.lang.Object
-
- software.amazon.awssdk.core.SdkResponse
-
- software.amazon.awssdk.awscore.AwsResponse
-
- software.amazon.awssdk.services.redshiftdata.model.RedshiftDataResponse
-
- software.amazon.awssdk.services.redshiftdata.model.GetStatementResultV2Response
-
- All Implemented Interfaces:
SdkPojo,ToCopyableBuilder<GetStatementResultV2Response.Builder,GetStatementResultV2Response>
@Generated("software.amazon.awssdk:codegen") public final class GetStatementResultV2Response extends RedshiftDataResponse implements ToCopyableBuilder<GetStatementResultV2Response.Builder,GetStatementResultV2Response>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceGetStatementResultV2Response.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static GetStatementResultV2Response.Builderbuilder()List<ColumnMetadata>columnMetadata()The properties (metadata) of a column.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<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.inthashCode()booleanhasRecords()For responses, this returns true if the service returned a value for the Records property.StringnextToken()A value that indicates the starting point for the next set of response records in a subsequent request.List<QueryRecords>records()The results of the SQL statement in CSV format.ResultFormatStringresultFormat()The data format of the result of the SQL statement.StringresultFormatAsString()The data format of the result of the SQL statement.Map<String,SdkField<?>>sdkFieldNameToField()List<SdkField<?>>sdkFields()static Class<? extends GetStatementResultV2Response.Builder>serializableBuilderClass()GetStatementResultV2Response.BuildertoBuilder()StringtoString()Returns a string representation of this object.LongtotalNumRows()The total number of rows in the result set returned from a query.-
Methods inherited from class software.amazon.awssdk.services.redshiftdata.model.RedshiftDataResponse
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
-
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()
The properties (metadata) of a column.
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:
- The properties (metadata) of a column.
-
nextToken
public final String nextToken()
A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned NextToken value in the next NextToken parameter and retrying the command. If the NextToken field is empty, all response records have been retrieved for the request.
- Returns:
- A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned NextToken value in the next NextToken parameter and retrying the command. If the NextToken field is empty, all response records have been retrieved for the request.
-
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<QueryRecords> records()
The results of the SQL statement in CSV format.
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 results of the SQL statement in CSV format.
-
resultFormat
public final ResultFormatString resultFormat()
The data format of the result of the SQL statement.
If the service returns an enum value that is not available in the current SDK version,
resultFormatwill returnResultFormatString.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromresultFormatAsString().- Returns:
- The data format of the result of the SQL statement.
- See Also:
ResultFormatString
-
resultFormatAsString
public final String resultFormatAsString()
The data format of the result of the SQL statement.
If the service returns an enum value that is not available in the current SDK version,
resultFormatwill returnResultFormatString.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromresultFormatAsString().- Returns:
- The data format of the result of the SQL statement.
- See Also:
ResultFormatString
-
totalNumRows
public final Long totalNumRows()
The total number of rows in the result set returned from a query. You can use this number to estimate the number of calls to the
GetStatementResultV2operation needed to page through the results.- Returns:
- The total number of rows in the result set returned from a query. You can use this number to estimate the
number of calls to the
GetStatementResultV2operation needed to page through the results.
-
toBuilder
public GetStatementResultV2Response.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<GetStatementResultV2Response.Builder,GetStatementResultV2Response>- Specified by:
toBuilderin classAwsResponse
-
builder
public static GetStatementResultV2Response.Builder builder()
-
serializableBuilderClass
public static Class<? extends GetStatementResultV2Response.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
-
sdkFieldNameToField
public final Map<String,SdkField<?>> sdkFieldNameToField()
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo
-
-