Package software.amazon.awssdk.services.redshiftdata.model

Interface DescribeStatementResponse.Builder

All Superinterfaces:
AwsResponse.Builder, Buildable, CopyableBuilder<DescribeStatementResponse.Builder,DescribeStatementResponse>, RedshiftDataResponse.Builder, SdkBuilder<DescribeStatementResponse.Builder,DescribeStatementResponse>, SdkPojo, SdkResponse.Builder
Enclosing class:
DescribeStatementResponse
public static interface DescribeStatementResponse.Builder extends RedshiftDataResponse.Builder, SdkPojo, CopyableBuilder<DescribeStatementResponse.Builder,DescribeStatementResponse>

  • Method Details

    • clusterIdentifier

      DescribeStatementResponse.Builder clusterIdentifier(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.

    • createdAt

      DescribeStatementResponse.Builder createdAt(Instant 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.

    • database

      DescribeStatementResponse.Builder database(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.

    • dbUser

      DescribeStatementResponse.Builder dbUser(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.

    • duration

      DescribeStatementResponse.Builder duration(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.

    • error

      DescribeStatementResponse.Builder error(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.

    • hasResultSet

      DescribeStatementResponse.Builder hasResultSet(Boolean 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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • id

      DescribeStatementResponse.Builder id(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.

    • queryParameters

      DescribeStatementResponse.Builder queryParameters(Collection<SqlParameter> queryParameters)

      The parameters for the SQL statement.

      Parameters:
      queryParameters - The parameters for the SQL statement.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • queryParameters

      DescribeStatementResponse.Builder queryParameters(SqlParameter... queryParameters)

      The parameters for the SQL statement.

      Parameters:
      queryParameters - The parameters for the SQL statement.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • queryParameters

      DescribeStatementResponse.Builder queryParameters(Consumer<SqlParameter.Builder>... queryParameters)

      The parameters for the SQL statement.

      This is a convenience method that creates an instance of the SqlParameter.Builder avoiding the need to create one manually via SqlParameter.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to queryParameters(List<SqlParameter>).

      Parameters:
      queryParameters - a consumer that will call methods on SqlParameter.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • queryString

      DescribeStatementResponse.Builder queryString(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.

    • redshiftPid

      DescribeStatementResponse.Builder redshiftPid(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.

    • redshiftQueryId

      DescribeStatementResponse.Builder redshiftQueryId(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.

    • resultRows

      DescribeStatementResponse.Builder resultRows(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. A -1 indicates the value is null.

      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. A -1 indicates the value is null.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • resultSize

      DescribeStatementResponse.Builder resultSize(Long resultSize)

      The size in bytes of the returned results. A -1 indicates the value is null.

      Parameters:
      resultSize - The size in bytes of the returned results. A -1 indicates the value is null.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • secretArn

      DescribeStatementResponse.Builder secretArn(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.

    • status

      DescribeStatementResponse.Builder status(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:

    • status

      DescribeStatementResponse.Builder status(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:

    • subStatements

      DescribeStatementResponse.Builder subStatements(Collection<SubStatementData> subStatements)

      The SQL statements from a multiple statement run.

      Parameters:
      subStatements - The SQL statements from a multiple statement run.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • subStatements

      DescribeStatementResponse.Builder subStatements(SubStatementData... subStatements)

      The SQL statements from a multiple statement run.

      Parameters:
      subStatements - The SQL statements from a multiple statement run.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • subStatements

      DescribeStatementResponse.Builder subStatements(Consumer<SubStatementData.Builder>... subStatements)

      The SQL statements from a multiple statement run.

      This is a convenience method that creates an instance of the SubStatementData.Builder avoiding the need to create one manually via SubStatementData.builder() .

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to subStatements(List<SubStatementData>).

      Parameters:
      subStatements - a consumer that will call methods on SubStatementData.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • updatedAt

      DescribeStatementResponse.Builder updatedAt(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.

      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.

    • workgroupName

      DescribeStatementResponse.Builder workgroupName(String workgroupName)

      The serverless workgroup name or Amazon Resource Name (ARN).

      Parameters:
      workgroupName - The serverless workgroup name or Amazon Resource Name (ARN).
      Returns:
      Returns a reference to this object so that method calls can be chained together.