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

Interface DescribeTableRequest.Builder

    • Method Detail

      • clusterIdentifier

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

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

        DescribeTableRequest.Builder database​(String database)

        The name of the database that contains the tables to be described. 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 be described. 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

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

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

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

      • schema

        DescribeTableRequest.Builder schema​(String schema)

        The schema that contains the table. If no schema is specified, then matching tables for all schemas are returned.

        Parameters:
        schema - The schema that contains the table. If no schema is specified, then matching tables for all schemas are returned.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • secretArn

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

      • table

        DescribeTableRequest.Builder table​(String table)

        The table name. If no table is specified, then all tables for all matching schemas are returned. If no table and no schema is specified, then all tables for all schemas in the database are returned

        Parameters:
        table - The table name. If no table is specified, then all tables for all matching schemas are returned. If no table and no schema is specified, then all tables for all schemas in the database are returned
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • workgroupName

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