DescribeStatementResult (AWS SDK for Java

java.lang.Object
- com.amazonaws.AmazonWebServiceResult<ResponseMetadata>
- - com.amazonaws.services.redshiftdataapi.model.DescribeStatementResult

All Implemented Interfaces:: Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class DescribeStatementResult
extends AmazonWebServiceResult<ResponseMetadata>
implements Serializable, Cloneable

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

DescribeStatementResult()

Constructors
Constructor and Description
`DescribeStatementResult()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`DescribeStatementResult`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getClusterIdentifier()` The cluster identifier.
`Date`	`getCreatedAt()` The date and time (UTC) when the SQL statement was submitted to run.
`String`	`getDatabase()` The name of the database.
`String`	`getDbUser()` The database user name.
`Long`	`getDuration()` The amount of time in nanoseconds that the statement ran.
`String`	`getError()` The error message from the cluster if the SQL statement encountered an error while running.
`Boolean`	`getHasResultSet()` A value that indicates whether the statement has a result set.
`String`	`getId()` The identifier of the SQL statement described.
`String`	`getQueryString()` The SQL statement text.
`Long`	`getRedshiftPid()` The process identifier from Amazon Redshift.
`Long`	`getRedshiftQueryId()` The identifier of the query generated by Amazon Redshift.
`Long`	`getResultRows()` Either the number of rows returned from the SQL statement or the number of rows affected.
`Long`	`getResultSize()` The size in bytes of the returned results.
`String`	`getSecretArn()` The name or Amazon Resource Name (ARN) of the secret that enables access to the database.
`String`	`getStatus()` The status of the SQL statement being described.
`Date`	`getUpdatedAt()` The date and time (UTC) that the metadata for the SQL statement was last updated.
`int`	`hashCode()`
`Boolean`	`isHasResultSet()` A value that indicates whether the statement has a result set.
`void`	`setClusterIdentifier(String clusterIdentifier)` The cluster identifier.
`void`	`setCreatedAt(Date createdAt)` The date and time (UTC) when the SQL statement was submitted to run.
`void`	`setDatabase(String database)` The name of the database.
`void`	`setDbUser(String dbUser)` The database user name.
`void`	`setDuration(Long duration)` The amount of time in nanoseconds that the statement ran.
`void`	`setError(String error)` The error message from the cluster if the SQL statement encountered an error while running.
`void`	`setHasResultSet(Boolean hasResultSet)` A value that indicates whether the statement has a result set.
`void`	`setId(String id)` The identifier of the SQL statement described.
`void`	`setQueryString(String queryString)` The SQL statement text.
`void`	`setRedshiftPid(Long redshiftPid)` The process identifier from Amazon Redshift.
`void`	`setRedshiftQueryId(Long redshiftQueryId)` The identifier of the query generated by Amazon Redshift.
`void`	`setResultRows(Long resultRows)` Either the number of rows returned from the SQL statement or the number of rows affected.
`void`	`setResultSize(Long resultSize)` The size in bytes of the returned results.
`void`	`setSecretArn(String secretArn)` The name or Amazon Resource Name (ARN) of the secret that enables access to the database.
`void`	`setStatus(String status)` The status of the SQL statement being described.
`void`	`setUpdatedAt(Date updatedAt)` The date and time (UTC) that the metadata for the SQL statement was last updated.
`String`	`toString()` Returns a string representation of this object.
`DescribeStatementResult`	`withClusterIdentifier(String clusterIdentifier)` The cluster identifier.
`DescribeStatementResult`	`withCreatedAt(Date createdAt)` The date and time (UTC) when the SQL statement was submitted to run.
`DescribeStatementResult`	`withDatabase(String database)` The name of the database.
`DescribeStatementResult`	`withDbUser(String dbUser)` The database user name.
`DescribeStatementResult`	`withDuration(Long duration)` The amount of time in nanoseconds that the statement ran.
`DescribeStatementResult`	`withError(String error)` The error message from the cluster if the SQL statement encountered an error while running.
`DescribeStatementResult`	`withHasResultSet(Boolean hasResultSet)` A value that indicates whether the statement has a result set.
`DescribeStatementResult`	`withId(String id)` The identifier of the SQL statement described.
`DescribeStatementResult`	`withQueryString(String queryString)` The SQL statement text.
`DescribeStatementResult`	`withRedshiftPid(Long redshiftPid)` The process identifier from Amazon Redshift.
`DescribeStatementResult`	`withRedshiftQueryId(Long redshiftQueryId)` The identifier of the query generated by Amazon Redshift.
`DescribeStatementResult`	`withResultRows(Long resultRows)` Either the number of rows returned from the SQL statement or the number of rows affected.
`DescribeStatementResult`	`withResultSize(Long resultSize)` The size in bytes of the returned results.
`DescribeStatementResult`	`withSecretArn(String secretArn)` The name or Amazon Resource Name (ARN) of the secret that enables access to the database.
`DescribeStatementResult`	`withStatus(StatusString status)` The status of the SQL statement being described.
`DescribeStatementResult`	`withStatus(String status)` The status of the SQL statement being described.
`DescribeStatementResult`	`withUpdatedAt(Date updatedAt)` The date and time (UTC) that the metadata for the SQL statement was last updated.

Methods inherited from class com.amazonaws.AmazonWebServiceResult
getSdkHttpMetadata, getSdkResponseMetadata, setSdkHttpMetadata, setSdkResponseMetadata

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - DescribeStatementResult
```
public DescribeStatementResult()
```
- Method Detail
  - setClusterIdentifier
```
public void setClusterIdentifier(String clusterIdentifier)
```
    The cluster identifier.
    
    Parameters:
    
    clusterIdentifier - The cluster identifier.
  - getClusterIdentifier
```
public String getClusterIdentifier()
```
    The cluster identifier.
    
    Returns:
    
    The cluster identifier.
  - withClusterIdentifier
```
public DescribeStatementResult withClusterIdentifier(String clusterIdentifier)
```
    The cluster identifier.
    
    Parameters:
    
    clusterIdentifier - The cluster identifier.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCreatedAt
```
public void setCreatedAt(Date createdAt)
```
    The date and time (UTC) when the SQL statement was submitted to run.
    
    Parameters:
    
    createdAt - The date and time (UTC) when the SQL statement was submitted to run.
  - getCreatedAt
```
public Date getCreatedAt()
```
    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.
  - withCreatedAt
```
public DescribeStatementResult withCreatedAt(Date createdAt)
```
    The date and time (UTC) when the SQL statement was submitted to run.
    
    Parameters:
    
    createdAt - The date and time (UTC) when the SQL statement was submitted to run.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDatabase
```
public void setDatabase(String database)
```
    The name of the database.
    
    Parameters:
    
    database - The name of the database.
  - getDatabase
```
public String getDatabase()
```
    The name of the database.
    
    Returns:
    
    The name of the database.
  - withDatabase
```
public DescribeStatementResult withDatabase(String database)
```
    The name of the database.
    
    Parameters:
    
    database - The name of the database.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDbUser
```
public void setDbUser(String dbUser)
```
    The database user name.
    
    Parameters:
    
    dbUser - The database user name.
  - getDbUser
```
public String getDbUser()
```
    The database user name.
    
    Returns:
    
    The database user name.
  - withDbUser
```
public DescribeStatementResult withDbUser(String dbUser)
```
    The database user name.
    
    Parameters:
    
    dbUser - The database user name.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDuration
```
public void setDuration(Long duration)
```
    The amount of time in nanoseconds that the statement ran.
    
    Parameters:
    
    duration - The amount of time in nanoseconds that the statement ran.
  - getDuration
```
public Long getDuration()
```
    The amount of time in nanoseconds that the statement ran.
    
    Returns:
    
    The amount of time in nanoseconds that the statement ran.
  - withDuration
```
public DescribeStatementResult withDuration(Long duration)
```
    The amount of time in nanoseconds that the statement ran.
    
    Parameters:
    
    duration - The amount of time in nanoseconds that the statement ran.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setError
```
public void setError(String error)
```
    The error message from the cluster if the SQL statement encountered an error while running.
    
    Parameters:
    
    error - The error message from the cluster if the SQL statement encountered an error while running.
  - getError
```
public String getError()
```
    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.
  - withError
```
public DescribeStatementResult withError(String error)
```
    The error message from the cluster if the SQL statement encountered an error while running.
    
    Parameters:
    
    error - The error message from the cluster if the SQL statement encountered an error while running.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setHasResultSet
```
public void setHasResultSet(Boolean hasResultSet)
```
    A value that indicates whether the statement has a result set. The result set can be empty.
    
    Parameters:
    
    hasResultSet - A value that indicates whether the statement has a result set. The result set can be empty.
  - getHasResultSet
```
public Boolean getHasResultSet()
```
    A value that indicates whether the statement has a result set. The result set can be empty.
    
    Returns:
    
    A value that indicates whether the statement has a result set. The result set can be empty.
  - withHasResultSet
```
public DescribeStatementResult withHasResultSet(Boolean hasResultSet)
```
    A value that indicates whether the statement has a result set. The result set can be empty.
    
    Parameters:
    
    hasResultSet - A value that indicates whether the statement has a result set. The result set can be empty.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isHasResultSet
```
public Boolean isHasResultSet()
```
    A value that indicates whether the statement has a result set. The result set can be empty.
    
    Returns:
    
    A value that indicates whether the statement has a result set. The result set can be empty.
  - setId
```
public void setId(String id)
```
    The identifier of the SQL statement described. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API.
    
    Parameters:
    
    id - The identifier of the SQL statement described. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API.
  - getId
```
public String getId()
```
    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.
  - withId
```
public DescribeStatementResult withId(String id)
```
    The identifier of the SQL statement described. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API.
    
    Parameters:
    
    id - The identifier of the SQL statement described. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setQueryString
```
public void setQueryString(String queryString)
```
    The SQL statement text.
    
    Parameters:
    
    queryString - The SQL statement text.
  - getQueryString
```
public String getQueryString()
```
    The SQL statement text.
    
    Returns:
    
    The SQL statement text.
  - withQueryString
```
public DescribeStatementResult withQueryString(String queryString)
```
    The SQL statement text.
    
    Parameters:
    
    queryString - The SQL statement text.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setRedshiftPid
```
public void setRedshiftPid(Long redshiftPid)
```
    The process identifier from Amazon Redshift.
    
    Parameters:
    
    redshiftPid - The process identifier from Amazon Redshift.
  - getRedshiftPid
```
public Long getRedshiftPid()
```
    The process identifier from Amazon Redshift.
    
    Returns:
    
    The process identifier from Amazon Redshift.
  - withRedshiftPid
```
public DescribeStatementResult withRedshiftPid(Long redshiftPid)
```
    The process identifier from Amazon Redshift.
    
    Parameters:
    
    redshiftPid - The process identifier from Amazon Redshift.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setRedshiftQueryId
```
public void setRedshiftQueryId(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.
    
    Parameters:
    
    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.
  - getRedshiftQueryId
```
public Long getRedshiftQueryId()
```
    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.
  - withRedshiftQueryId
```
public DescribeStatementResult withRedshiftQueryId(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setResultRows
```
public void setResultRows(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.
    
    Parameters:
    
    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.
  - getResultRows
```
public Long getResultRows()
```
    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.
  - withResultRows
```
public DescribeStatementResult withResultRows(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setResultSize
```
public void setResultSize(Long resultSize)
```
    The size in bytes of the returned results.
    
    Parameters:
    
    resultSize - The size in bytes of the returned results.
  - getResultSize
```
public Long getResultSize()
```
    The size in bytes of the returned results.
    
    Returns:
    
    The size in bytes of the returned results.
  - withResultSize
```
public DescribeStatementResult withResultSize(Long resultSize)
```
    The size in bytes of the returned results.
    
    Parameters:
    
    resultSize - The size in bytes of the returned results.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSecretArn
```
public void setSecretArn(String secretArn)
```
    The name or Amazon Resource Name (ARN) of the secret that enables access to the database.
    
    Parameters:
    
    secretArn - The name or Amazon Resource Name (ARN) of the secret that enables access to the database.
  - getSecretArn
```
public String getSecretArn()
```
    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.
  - withSecretArn
```
public DescribeStatementResult withSecretArn(String secretArn)
```
    The name or Amazon Resource Name (ARN) of the secret that enables access to the database.
    
    Parameters:
    
    secretArn - The name or Amazon Resource Name (ARN) of the secret that enables access to the database.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setStatus
```
public void setStatus(String 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.
    Parameters:
    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.
    See Also:
    
    StatusString
  - getStatus
```
public String getStatus()
```
    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.
    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
  - withStatus
```
public DescribeStatementResult withStatus(String 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.
    Parameters:
    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.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    StatusString
  - withStatus
```
public DescribeStatementResult withStatus(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.
    Parameters:
    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.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    StatusString
  - setUpdatedAt
```
public void setUpdatedAt(Date 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.
    
    Parameters:
    
    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.
  - getUpdatedAt
```
public Date getUpdatedAt()
```
    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.
  - withUpdatedAt
```
public DescribeStatementResult withUpdatedAt(Date 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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public DescribeStatementResult clone()
```
    Overrides:
    
    clone in class Object

Did this page help you?

Class DescribeStatementResult

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceResult

Methods inherited from class java.lang.Object

Constructor Detail

DescribeStatementResult

Method Detail

setClusterIdentifier

getClusterIdentifier

withClusterIdentifier

setCreatedAt

getCreatedAt

withCreatedAt

setDatabase

getDatabase

withDatabase

setDbUser

getDbUser

withDbUser

setDuration

getDuration

withDuration

setError

getError

withError

setHasResultSet

getHasResultSet

withHasResultSet

isHasResultSet

setId

getId

withId

setQueryString

getQueryString

withQueryString

setRedshiftPid

getRedshiftPid

withRedshiftPid

setRedshiftQueryId

getRedshiftQueryId

withRedshiftQueryId

setResultRows

getResultRows

withResultRows

setResultSize

getResultSize

withResultSize

setSecretArn

getSecretArn

withSecretArn

setStatus

getStatus

withStatus

withStatus

setUpdatedAt

getUpdatedAt

withUpdatedAt

toString

equals

hashCode

clone