Interface ListSessionsRequest.Builder

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

  • Method Details

    • nextToken

      ListSessionsRequest.Builder nextToken(String nextToken)

      A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned NextToken value in the next NextToken parameter and retrying the command. If the NextToken field is empty, all response records have been retrieved for the request.

      Parameters:
      nextToken - A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned NextToken value in the next NextToken parameter and retrying the command. If the NextToken field is empty, all response records have been retrieved for the request.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • maxResults

      ListSessionsRequest.Builder maxResults(Integer maxResults)

      The maximum number of sessions to return in the response. If more sessions exist than fit in one response, the operation returns NextToken to paginate the results.

      Parameters:
      maxResults - The maximum number of sessions to return in the response. If more sessions exist than fit in one response, the operation returns NextToken to paginate the results.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • sessionId

      ListSessionsRequest.Builder sessionId(String sessionId)

      The identifier of a specific session to return metadata for. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API. When you provide SessionId, you can't specify Status, ClusterIdentifier, WorkgroupName, or Database.

      Parameters:
      sessionId - The identifier of a specific session to return metadata for. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API. When you provide SessionId, you can't specify Status, ClusterIdentifier, WorkgroupName, or Database.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • status

      ListSessionsRequest.Builder status(String status)

      The status of the sessions to list. If no status is specified, sessions with a status of AVAILABLE or BUSY are returned. 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 sessions to list. If no status is specified, sessions with a status of AVAILABLE or BUSY are returned. 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

      ListSessionsRequest.Builder status(SessionStatusString status)

      The status of the sessions to list. If no status is specified, sessions with a status of AVAILABLE or BUSY are returned. 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 sessions to list. If no status is specified, sessions with a status of AVAILABLE or BUSY are returned. 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:

    • roleLevel

      ListSessionsRequest.Builder roleLevel(Boolean roleLevel)

      Specifies whether to return all sessions created by the caller's IAM role, including sessions from previous IAM sessions. If false, only sessions created in the current IAM session are returned. The default is true.

      Parameters:
      roleLevel - Specifies whether to return all sessions created by the caller's IAM role, including sessions from previous IAM sessions. If false, only sessions created in the current IAM session are returned. The default is true.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • clusterIdentifier

      ListSessionsRequest.Builder clusterIdentifier(String clusterIdentifier)

      The cluster identifier. Only sessions on this cluster are returned. When providing ClusterIdentifier, then WorkgroupName can't be specified.

      Parameters:
      clusterIdentifier - The cluster identifier. Only sessions on this cluster are returned. When providing ClusterIdentifier, then WorkgroupName can't be specified.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • workgroupName

      ListSessionsRequest.Builder workgroupName(String workgroupName)

      The serverless workgroup name or Amazon Resource Name (ARN). Only sessions on this workgroup are returned. When providing WorkgroupName, then ClusterIdentifier can't be specified.

      Parameters:
      workgroupName - The serverless workgroup name or Amazon Resource Name (ARN). Only sessions on this workgroup are returned. When providing WorkgroupName, then ClusterIdentifier can't be specified.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • database

      ListSessionsRequest.Builder database(String database)

      The name of the database. Only sessions connected to this database are returned.

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

    • overrideConfiguration

      ListSessionsRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      ListSessionsRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.