software.amazon.awssdk.services.redshiftdata.model

Class DescribeStatementResponse

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.DescribeStatementResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DescribeStatementResponse.Builder,DescribeStatementResponse>

@Generated(value="software.amazon.awssdk:codegen")
public final class DescribeStatementResponse
extends RedshiftDataResponse
implements ToCopyableBuilder<DescribeStatementResponse.Builder,DescribeStatementResponse>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DescribeStatementResponse.Builder

Method Summary

Modifier and Type	Method and Description
static DescribeStatementResponse.Builder	builder()
String	clusterIdentifier() The cluster identifier.
Instant	createdAt() The date and time (UTC) when the SQL statement was submitted to run.
String	database() The name of the database.
String	dbUser() The database user name.
Long	duration() The amount of time in nanoseconds that the statement ran.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	error() The error message from the cluster if the SQL statement encountered an error while running.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	id() The identifier of the SQL statement described.
String	queryString() The SQL statement text.
Long	redshiftPid() The process identifier from Amazon Redshift.
Long	redshiftQueryId() The identifier of the query generated by Amazon Redshift.
Long	resultRows() Either the number of rows returned from the SQL statement or the number of rows affected.
Long	resultSize() The size in bytes of the returned results.
List<SdkField<?>>	sdkFields()
String	secretArn() The name or Amazon Resource Name (ARN) of the secret that enables access to the database.
static Class<? extends DescribeStatementResponse.Builder>	serializableBuilderClass()
StatusString	status() The status of the SQL statement being described.
String	statusAsString() The status of the SQL statement being described.
DescribeStatementResponse.Builder	toBuilder()
String	toString() Returns a string representation of this object.
Instant	updatedAt() The date and time (UTC) that the metadata for the SQL statement was last updated.

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

clusterIdentifier

public final String clusterIdentifier()

The cluster identifier.

Returns:

The cluster identifier.

createdAt

public final Instant 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

public final String database()

The name of the database.

Returns:

The name of the database.

dbUser

public final String dbUser()

The database user name.

Returns:

The database user name.

duration

public final Long duration()

The amount of time in nanoseconds that the statement ran.

Returns:

The amount of time in nanoseconds that the statement ran.

error

public final String 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.

id

public final String 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.

queryString

public final String queryString()

The SQL statement text.

Returns:

The SQL statement text.

redshiftPid

public final Long redshiftPid()

The process identifier from Amazon Redshift.

Returns:

The process identifier from Amazon Redshift.

redshiftQueryId

public final Long redshiftQueryId()

The identifier of the query generated by Amazon Redshift. These identifiers are also available in the query column of the STL_QUERY system view.

Returns:

The identifier of the query generated by Amazon Redshift. These identifiers are also available in the query column of the STL_QUERY system view.

resultRows

public final Long 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.

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.

resultSize

public final Long resultSize()

The size in bytes of the returned results.

Returns:

The size in bytes of the returned results.

secretArn

public final String 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

public final StatusString 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 return StatusString.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

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:

StatusString

statusAsString

public final String 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 return StatusString.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

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:

StatusString

updatedAt

public final Instant 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.

toBuilder

public DescribeStatementResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DescribeStatementResponse.Builder,DescribeStatementResponse>

Overrides:

toBuilder in class AwsResponse

builder

public static DescribeStatementResponse.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsResponse

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsResponse

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)

Overrides:

getValueForField in class SdkResponse

sdkFields

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

Specified by:

sdkFields in interface SdkPojo