Interface ListTablesRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<ListTablesRequest.Builder,
,ListTablesRequest> RedshiftDataRequest.Builder
,SdkBuilder<ListTablesRequest.Builder,
,ListTablesRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
ListTablesRequest
-
Method Summary
Modifier and TypeMethodDescriptionclusterIdentifier
(String clusterIdentifier) The cluster identifier.connectedDatabase
(String connectedDatabase) A database name.The name of the database that contains the tables to list.The database user name.maxResults
(Integer maxResults) The maximum number of tables to return in the response.A value that indicates the starting point for the next set of response records in a subsequent request.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.schemaPattern
(String schemaPattern) A pattern to filter results by schema name.The name or ARN of the secret that enables access to the database.tablePattern
(String tablePattern) A pattern to filter results by table name.workgroupName
(String workgroupName) The serverless workgroup name or Amazon Resource Name (ARN).Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.services.redshiftdata.model.RedshiftDataRequest.Builder
build
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
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
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
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. IfConnectedDatabase
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
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
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, thenNextToken
is returned to page through the results.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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
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 matchTablePattern
are returned. If neitherSchemaPattern
orTablePattern
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. IfSchemaPattern
is not specified, then all tables that matchTablePattern
are returned. If neitherSchemaPattern
orTablePattern
are specified, then all tables are returned.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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
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 matchSchemaPattern
are returned. If neitherSchemaPattern
orTablePattern
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. IfTablePattern
is not specified, then all tables that matchSchemaPattern
are returned. If neitherSchemaPattern
orTablePattern
are specified, then all tables are returned.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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
ListTablesRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
overrideConfiguration
- The override configuration.- Returns:
- This object for method chaining.
-
overrideConfiguration
ListTablesRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-