Class ListTablesRequest
- java.lang.Object
-
- software.amazon.awssdk.core.SdkRequest
-
- software.amazon.awssdk.awscore.AwsRequest
-
- software.amazon.awssdk.services.redshiftdata.model.RedshiftDataRequest
-
- software.amazon.awssdk.services.redshiftdata.model.ListTablesRequest
-
- All Implemented Interfaces:
SdkPojo,ToCopyableBuilder<ListTablesRequest.Builder,ListTablesRequest>
@Generated("software.amazon.awssdk:codegen") public final class ListTablesRequest extends RedshiftDataRequest implements ToCopyableBuilder<ListTablesRequest.Builder,ListTablesRequest>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceListTablesRequest.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static ListTablesRequest.Builderbuilder()StringclusterIdentifier()The cluster identifier.StringconnectedDatabase()A database name.Stringdatabase()The name of the database that contains the tables to list.StringdbUser()The database user name.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()IntegermaxResults()The maximum number of tables to return in the response.StringnextToken()A value that indicates the starting point for the next set of response records in a subsequent request.StringschemaPattern()A pattern to filter results by schema name.Map<String,SdkField<?>>sdkFieldNameToField()List<SdkField<?>>sdkFields()StringsecretArn()The name or ARN of the secret that enables access to the database.static Class<? extends ListTablesRequest.Builder>serializableBuilderClass()StringtablePattern()A pattern to filter results by table name.ListTablesRequest.BuildertoBuilder()StringtoString()Returns a string representation of this object.StringworkgroupName()The serverless workgroup name or Amazon Resource Name (ARN).-
Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
clusterIdentifier
public final String clusterIdentifier()
The cluster identifier. This parameter is required when connecting to a cluster and authenticating using either Secrets Manager or temporary credentials.
- Returns:
- The cluster identifier. This parameter is required when connecting to a cluster and authenticating using either Secrets Manager or temporary credentials.
-
connectedDatabase
public final String connectedDatabase()
A database name. The connected database is specified when you connect with your authentication credentials.
- Returns:
- A database name. The connected database is specified when you connect with your authentication credentials.
-
database
public final String database()
The name of the database that contains the tables to list. If
ConnectedDatabaseis not specified, this is also the database to connect to with your authentication credentials.- Returns:
- The name of the database that contains the tables to list. If
ConnectedDatabaseis not specified, this is also the database to connect to with your authentication credentials.
-
dbUser
public final String dbUser()
The database user name. This parameter is required when connecting to a cluster as a database user and authenticating using temporary credentials.
- Returns:
- The database user name. This parameter is required when connecting to a cluster as a database user and authenticating using temporary credentials.
-
maxResults
public final Integer maxResults()
The maximum number of tables to return in the response. If more tables exist than fit in one response, then
NextTokenis returned to page through the results.- Returns:
- The maximum number of tables to return in the response. If more tables exist than fit in one response,
then
NextTokenis returned to page through the results.
-
nextToken
public final 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.
- Returns:
- 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.
-
schemaPattern
public final 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
SchemaPatternis not specified, then all tables that matchTablePatternare returned. If neitherSchemaPatternorTablePatternare specified, then all tables are returned.- Returns:
- 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
SchemaPatternis not specified, then all tables that matchTablePatternare returned. If neitherSchemaPatternorTablePatternare specified, then all tables are returned.
-
secretArn
public final String secretArn()
The name or ARN of the secret that enables access to the database. This parameter is required when authenticating using Secrets Manager.
- Returns:
- The name or ARN of the secret that enables access to the database. This parameter is required when authenticating using Secrets Manager.
-
tablePattern
public final 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
TablePatternis not specified, then all tables that matchSchemaPatternare returned. If neitherSchemaPatternorTablePatternare specified, then all tables are returned.- Returns:
- 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
TablePatternis not specified, then all tables that matchSchemaPatternare returned. If neitherSchemaPatternorTablePatternare specified, then all tables are returned.
-
workgroupName
public final 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.
- Returns:
- 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.
-
toBuilder
public ListTablesRequest.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<ListTablesRequest.Builder,ListTablesRequest>- Specified by:
toBuilderin classRedshiftDataRequest
-
builder
public static ListTablesRequest.Builder builder()
-
serializableBuilderClass
public static Class<? extends ListTablesRequest.Builder> serializableBuilderClass()
-
hashCode
public final int hashCode()
- Overrides:
hashCodein classAwsRequest
-
equals
public final boolean equals(Object obj)
- Overrides:
equalsin classAwsRequest
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
toString
public final String toString()
Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
-
getValueForField
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
- Overrides:
getValueForFieldin classSdkRequest
-
sdkFieldNameToField
public final Map<String,SdkField<?>> sdkFieldNameToField()
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo
-
-