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

Interface ListTablesRequest.Builder

    • Method Detail

      • clusterIdentifier

        ListTablesRequest.Builder clusterIdentifier​(String clusterIdentifier)

        The cluster identifier. This parameter is required when connecting to a cluster and authenticating using either Secrets Manager or temporary credentials.

        Parameters:
        clusterIdentifier - The cluster identifier. This parameter is required when connecting to a cluster and authenticating using either Secrets Manager or temporary credentials.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • connectedDatabase

        ListTablesRequest.Builder connectedDatabase​(String connectedDatabase)

        A database name. The connected database is specified when you connect with your authentication credentials.

        Parameters:
        connectedDatabase - A database name. The connected database is specified when you connect with your authentication credentials.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • database

        ListTablesRequest.Builder database​(String database)

        The name of the database that contains the tables to list. If ConnectedDatabase is not specified, this is also the database to connect to with your authentication credentials.

        Parameters:
        database - The name of the database that contains the tables to list. If ConnectedDatabase is not specified, this is also the database to connect to with your authentication credentials.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • dbUser

        ListTablesRequest.Builder dbUser​(String dbUser)

        The database user name. This parameter is required when connecting to a cluster as a database user and authenticating using temporary credentials.

        Parameters:
        dbUser - The database user name. This parameter is required when connecting to a cluster as a database user and authenticating using temporary credentials.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • maxResults

        ListTablesRequest.Builder maxResults​(Integer maxResults)

        The maximum number of tables to return in the response. If more tables exist than fit in one response, then NextToken is returned to page through the results.

        Parameters:
        maxResults - The maximum number of tables to return in the response. If more tables exist than fit in one response, then NextToken is returned to page through the results.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • nextToken

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

      • schemaPattern

        ListTablesRequest.Builder schemaPattern​(String schemaPattern)

        A pattern to filter results by schema name. Within a schema pattern, "%" means match any substring of 0 or more characters and "_" means match any one character. Only schema name entries matching the search pattern are returned. If SchemaPattern is not specified, then all tables that match TablePattern are returned. If neither SchemaPattern or TablePattern are specified, then all tables are returned.

        Parameters:
        schemaPattern - A pattern to filter results by schema name. Within a schema pattern, "%" means match any substring of 0 or more characters and "_" means match any one character. Only schema name entries matching the search pattern are returned. If SchemaPattern is not specified, then all tables that match TablePattern are returned. If neither SchemaPattern or TablePattern are specified, then all tables are returned.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • secretArn

        ListTablesRequest.Builder secretArn​(String secretArn)

        The name or ARN of the secret that enables access to the database. This parameter is required when authenticating using Secrets Manager.

        Parameters:
        secretArn - The name or ARN of the secret that enables access to the database. This parameter is required when authenticating using Secrets Manager.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • tablePattern

        ListTablesRequest.Builder tablePattern​(String tablePattern)

        A pattern to filter results by table name. Within a table pattern, "%" means match any substring of 0 or more characters and "_" means match any one character. Only table name entries matching the search pattern are returned. If TablePattern is not specified, then all tables that match SchemaPatternare returned. If neither SchemaPattern or TablePattern are specified, then all tables are returned.

        Parameters:
        tablePattern - A pattern to filter results by table name. Within a table pattern, "%" means match any substring of 0 or more characters and "_" means match any one character. Only table name entries matching the search pattern are returned. If TablePattern is not specified, then all tables that match SchemaPatternare returned. If neither SchemaPattern or TablePattern are specified, then all tables are returned.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • workgroupName

        ListTablesRequest.Builder workgroupName​(String workgroupName)

        The serverless workgroup name or Amazon Resource Name (ARN). This parameter is required when connecting to a serverless workgroup and authenticating using either Secrets Manager or temporary credentials.

        Parameters:
        workgroupName - The serverless workgroup name or Amazon Resource Name (ARN). This parameter is required when connecting to a serverless workgroup and authenticating using either Secrets Manager or temporary credentials.
        Returns:
        Returns a reference to this object so that method calls can be chained together.