Interface SessionData.Builder

All Superinterfaces:
Buildable, CopyableBuilder<SessionData.Builder,SessionData>, SdkBuilder<SessionData.Builder,SessionData>, SdkPojo
Enclosing class:
SessionData
@Mutable @NotThreadSafe public static interface SessionData.Builder extends SdkPojo, CopyableBuilder<SessionData.Builder,SessionData>

  • Method Details

    • sessionId

      SessionData.Builder sessionId(String sessionId)

      The session identifier. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API.

      Parameters:
      sessionId - The session identifier. 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.

    • status

      SessionData.Builder status(String status)

      The status of the session. Status values are defined as follows:

      • AVAILABLE – The session is open and ready to run a SQL statement.

      • BUSY – The session is currently running a SQL statement.

      • CLOSED – The session is closed and can no longer run SQL statements.

      Parameters:
      status - The status of the session. Status values are defined as follows:

      • AVAILABLE – The session is open and ready to run a SQL statement.

      • BUSY – The session is currently running a SQL statement.

      • CLOSED – The session is closed and can no longer run SQL statements.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • status

      SessionData.Builder status(SessionStatusString status)

      The status of the session. Status values are defined as follows:

      • AVAILABLE – The session is open and ready to run a SQL statement.

      • BUSY – The session is currently running a SQL statement.

      • CLOSED – The session is closed and can no longer run SQL statements.

      Parameters:
      status - The status of the session. Status values are defined as follows:

      • AVAILABLE – The session is open and ready to run a SQL statement.

      • BUSY – The session is currently running a SQL statement.

      • CLOSED – The session is closed and can no longer run SQL statements.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • createdAt

      SessionData.Builder createdAt(Instant createdAt)

      The date and time (UTC) when the session was created.

      Parameters:
      createdAt - The date and time (UTC) when the session was created.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • updatedAt

      SessionData.Builder updatedAt(Instant updatedAt)

      The date and time (UTC) that the session metadata was last updated. An example is the time the status last changed.

      Parameters:
      updatedAt - The date and time (UTC) that the session metadata 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.

    • database

      SessionData.Builder database(String database)

      The name of the database that the session is connected to.

      Parameters:
      database - The name of the database that the session is connected to.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • dbUser

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

    • clusterIdentifier

      SessionData.Builder clusterIdentifier(String clusterIdentifier)

      The cluster identifier. This element is not returned when connecting to a serverless workgroup.

      Parameters:
      clusterIdentifier - The cluster identifier. This element is not returned when connecting to a serverless workgroup.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • workgroupName

      SessionData.Builder workgroupName(String workgroupName)

      The serverless workgroup name or Amazon Resource Name (ARN). This element is not returned when connecting to a provisioned cluster.

      Parameters:
      workgroupName - The serverless workgroup name or Amazon Resource Name (ARN). This element is not returned when connecting to a provisioned cluster.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • sessionAliveSeconds

      SessionData.Builder sessionAliveSeconds(Integer sessionAliveSeconds)

      The number of seconds that the session is kept alive after a query finishes.

      Parameters:
      sessionAliveSeconds - The number of seconds that the session is kept alive after a query finishes.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • sessionTtl

      SessionData.Builder sessionTtl(Instant sessionTtl)

      The date and time (UTC) when the session is set to expire and be closed.

      Parameters:
      sessionTtl - The date and time (UTC) when the session is set to expire and be closed.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • currentStatementId

      SessionData.Builder currentStatementId(String currentStatementId)

      The identifier of the SQL statement currently running in the session. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API. This element is returned only when the session status is BUSY.

      Parameters:
      currentStatementId - The identifier of the SQL statement currently running in the session. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API. This element is returned only when the session status is BUSY.
      Returns:
      Returns a reference to this object so that method calls can be chained together.