Class SubStatementData
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<SubStatementData.Builder,
SubStatementData>
Information about an SQL statement.
- See Also:
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionstatic SubStatementData.Builder
builder()
final Instant
The date and time (UTC) the statement was created.final Long
duration()
The amount of time in nanoseconds that the statement ran.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final String
error()
The error message from the cluster if the SQL statement encountered an error while running.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final Boolean
A value that indicates whether the statement has a result set.final String
id()
The identifier of the SQL statement.final String
The SQL statement text.final Long
The SQL statement identifier.final Long
Either the number of rows returned from the SQL statement or the number of rows affected.final Long
The size in bytes of the returned results.static Class
<? extends SubStatementData.Builder> final StatementStatusString
status()
The status of the SQL statement.final String
The status of the SQL statement.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final Instant
The date and time (UTC) that the statement metadata was last updated.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
createdAt
The date and time (UTC) the statement was created.
- Returns:
- The date and time (UTC) the statement was created.
-
duration
The amount of time in nanoseconds that the statement ran.
- Returns:
- The amount of time in nanoseconds that the statement ran.
-
error
The error message from the cluster if the SQL statement encountered an error while running.
- Returns:
- The error message from the cluster if the SQL statement encountered an error while running.
-
hasResultSet
A value that indicates whether the statement has a result set. The result set can be empty. The value is true for an empty result set.
- Returns:
- A value that indicates whether the statement has a result set. The result set can be empty. The value is true for an empty result set.
-
id
The identifier of the SQL statement. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API. A suffix indicates the number of the SQL statement. For example,
d9b6c0c9-0747-4bf4-b142-e8883122f766:2
has a suffix of:2
that indicates the second SQL statement of a batch query.- Returns:
- The identifier of the SQL statement. This value is a universally unique identifier (UUID) generated by
Amazon Redshift Data API. A suffix indicates the number of the SQL statement. For example,
d9b6c0c9-0747-4bf4-b142-e8883122f766:2
has a suffix of:2
that indicates the second SQL statement of a batch query.
-
queryString
The SQL statement text.
- Returns:
- The SQL statement text.
-
redshiftQueryId
The SQL statement identifier. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API.
- Returns:
- The SQL statement identifier. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API.
-
resultRows
Either the number of rows returned from the SQL statement or the number of rows affected. If result size is greater than zero, the result rows can be the number of rows affected by SQL statements such as INSERT, UPDATE, DELETE, COPY, and others. A
-1
indicates the value is null.- Returns:
- Either the number of rows returned from the SQL statement or the number of rows affected. If result size
is greater than zero, the result rows can be the number of rows affected by SQL statements such as
INSERT, UPDATE, DELETE, COPY, and others. A
-1
indicates the value is null.
-
resultSize
The size in bytes of the returned results. A
-1
indicates the value is null.- Returns:
- The size in bytes of the returned results. A
-1
indicates the value is null.
-
status
The status of the SQL statement. An example is the that the SQL statement finished.
If the service returns an enum value that is not available in the current SDK version,
status
will returnStatementStatusString.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- Returns:
- The status of the SQL statement. An example is the that the SQL statement finished.
- See Also:
-
statusAsString
The status of the SQL statement. An example is the that the SQL statement finished.
If the service returns an enum value that is not available in the current SDK version,
status
will returnStatementStatusString.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- Returns:
- The status of the SQL statement. An example is the that the SQL statement finished.
- See Also:
-
updatedAt
The date and time (UTC) that the statement metadata was last updated.
- Returns:
- The date and time (UTC) that the statement metadata was last updated.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<SubStatementData.Builder,
SubStatementData> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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
-
sdkFields
-