Class DescribeStatementResponse
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<DescribeStatementResponse.Builder,
DescribeStatementResponse>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final String
The cluster identifier.final Instant
The date and time (UTC) when the SQL statement was submitted to run.final String
database()
The name of the database.final String
dbUser()
The database user name.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) Used to retrieve the value of a field from any class that extendsSdkResponse
.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the QueryParameters property.final Boolean
A value that indicates whether the statement has a result set.final boolean
For responses, this returns true if the service returned a value for the SubStatements property.final String
id()
The identifier of the SQL statement described.final List
<SqlParameter> The parameters for the SQL statement.final String
The SQL statement text.final Long
The process identifier from Amazon Redshift.final Long
The identifier of the query generated by Amazon Redshift.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.final String
The name or Amazon Resource Name (ARN) of the secret that enables access to the database.static Class
<? extends DescribeStatementResponse.Builder> final StatusString
status()
The status of the SQL statement being described.final String
The status of the SQL statement being described.final List
<SubStatementData> The SQL statements from a multiple statement run.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 metadata for the SQL statement was last updated.final String
The serverless workgroup name or Amazon Resource Name (ARN).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 interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
clusterIdentifier
The cluster identifier.
- Returns:
- The cluster identifier.
-
createdAt
The date and time (UTC) when the SQL statement was submitted to run.
- Returns:
- The date and time (UTC) when the SQL statement was submitted to run.
-
database
The name of the database.
- Returns:
- The name of the database.
-
dbUser
The database user name.
- Returns:
- The database user name.
-
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. The value is true if any substatement returns a 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. The value is true if any substatement returns a result set.
-
id
The identifier of the SQL statement described. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API.
- Returns:
- The identifier of the SQL statement described. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API.
-
hasQueryParameters
public final boolean hasQueryParameters()For responses, this returns true if the service returned a value for the QueryParameters 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. -
queryParameters
The parameters for the SQL statement.
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
hasQueryParameters()
method.- Returns:
- The parameters for the SQL statement.
-
queryString
The SQL statement text.
- Returns:
- The SQL statement text.
-
redshiftPid
The process identifier from Amazon Redshift.
- Returns:
- The process identifier from Amazon Redshift.
-
redshiftQueryId
The identifier of the query generated by Amazon Redshift. These identifiers are also available in the
query
column of theSTL_QUERY
system view.- Returns:
- The identifier of the query generated by Amazon Redshift. These identifiers are also available in the
query
column of theSTL_QUERY
system view.
-
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.
-
secretArn
The name or Amazon Resource Name (ARN) of the secret that enables access to the database.
- Returns:
- The name or Amazon Resource Name (ARN) of the secret that enables access to the database.
-
status
The status of the SQL statement being described. Status values are defined as follows:
-
ABORTED - The query run was stopped by the user.
-
ALL - A status value that includes all query statuses. This value can be used to filter results.
-
FAILED - The query run failed.
-
FINISHED - The query has finished running.
-
PICKED - The query has been chosen to be run.
-
STARTED - The query run has started.
-
SUBMITTED - The query was submitted, but not yet processed.
If the service returns an enum value that is not available in the current SDK version,
status
will returnStatusString.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- Returns:
- The status of the SQL statement being described. Status values are defined as follows:
-
ABORTED - The query run was stopped by the user.
-
ALL - A status value that includes all query statuses. This value can be used to filter results.
-
FAILED - The query run failed.
-
FINISHED - The query has finished running.
-
PICKED - The query has been chosen to be run.
-
STARTED - The query run has started.
-
SUBMITTED - The query was submitted, but not yet processed.
-
- See Also:
-
-
statusAsString
The status of the SQL statement being described. Status values are defined as follows:
-
ABORTED - The query run was stopped by the user.
-
ALL - A status value that includes all query statuses. This value can be used to filter results.
-
FAILED - The query run failed.
-
FINISHED - The query has finished running.
-
PICKED - The query has been chosen to be run.
-
STARTED - The query run has started.
-
SUBMITTED - The query was submitted, but not yet processed.
If the service returns an enum value that is not available in the current SDK version,
status
will returnStatusString.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- Returns:
- The status of the SQL statement being described. Status values are defined as follows:
-
ABORTED - The query run was stopped by the user.
-
ALL - A status value that includes all query statuses. This value can be used to filter results.
-
FAILED - The query run failed.
-
FINISHED - The query has finished running.
-
PICKED - The query has been chosen to be run.
-
STARTED - The query run has started.
-
SUBMITTED - The query was submitted, but not yet processed.
-
- See Also:
-
-
hasSubStatements
public final boolean hasSubStatements()For responses, this returns true if the service returned a value for the SubStatements 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. -
subStatements
The SQL statements from a multiple statement run.
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
hasSubStatements()
method.- Returns:
- The SQL statements from a multiple statement run.
-
updatedAt
The date and time (UTC) that the metadata for the SQL statement was last updated. An example is the time the status last changed.
- Returns:
- The date and time (UTC) that the metadata for the SQL statement was last updated. An example is the time the status last changed.
-
workgroupName
The serverless workgroup name or Amazon Resource Name (ARN).
- Returns:
- The serverless workgroup name or Amazon Resource Name (ARN).
-
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<DescribeStatementResponse.Builder,
DescribeStatementResponse> - Specified by:
toBuilder
in classAwsResponse
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsResponse
-
equals
- Overrides:
equals
in classAwsResponse
-
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
Description copied from class:SdkResponse
Used to retrieve the value of a field from any class that extendsSdkResponse
. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, theSdkResponse.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkResponse
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-