software.amazon.awssdk.services.redshiftdata.model

Interface DescribeTableRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<DescribeTableRequest.Builder,DescribeTableRequest>, RedshiftDataRequest.Builder, SdkBuilder<DescribeTableRequest.Builder,DescribeTableRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

DescribeTableRequest

public static interface DescribeTableRequest.Builder
extends RedshiftDataRequest.Builder, SdkPojo, CopyableBuilder<DescribeTableRequest.Builder,DescribeTableRequest>

Method Summary

Modifier and Type	Method and Description
DescribeTableRequest.Builder	clusterIdentifier(String clusterIdentifier) The cluster identifier.
DescribeTableRequest.Builder	connectedDatabase(String connectedDatabase) A database name.
DescribeTableRequest.Builder	database(String database) The name of the database that contains the tables to be described.
DescribeTableRequest.Builder	dbUser(String dbUser) The database user name.
DescribeTableRequest.Builder	maxResults(Integer maxResults) The maximum number of tables to return in the response.
DescribeTableRequest.Builder	nextToken(String nextToken) A value that indicates the starting point for the next set of response records in a subsequent request.
DescribeTableRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
DescribeTableRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
DescribeTableRequest.Builder	schema(String schema) The schema that contains the table.
DescribeTableRequest.Builder	secretArn(String secretArn) The name or ARN of the secret that enables access to the database.
DescribeTableRequest.Builder	table(String table) The table name.
DescribeTableRequest.Builder	workgroupName(String workgroupName) The serverless workgroup name or Amazon Resource Name (ARN).

Methods inherited from interface software.amazon.awssdk.services.redshiftdata.model.RedshiftDataRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

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.

overrideConfiguration

DescribeTableRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

DescribeTableRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Specified by:

overrideConfiguration in interface AwsRequest.Builder