Class ListTablesRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<ListTablesRequest.Builder,
ListTablesRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic ListTablesRequest.Builder
builder()
final String
The cluster identifier.final String
A database name.final String
database()
The name of the database that contains the tables to list.final String
dbUser()
The database user name.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final int
hashCode()
final Integer
The maximum number of tables to return in the response.final String
A value that indicates the starting point for the next set of response records in a subsequent request.final String
A pattern to filter results by schema name.final String
The name or ARN of the secret that enables access to the database.static Class
<? extends ListTablesRequest.Builder> final String
A pattern to filter results by table name.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final String
The serverless workgroup name or Amazon Resource Name (ARN).Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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
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
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:
- 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.
-
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
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:
- 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.
-
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
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.- 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
SchemaPattern
is not specified, then all tables that matchTablePattern
are returned. If neitherSchemaPattern
orTablePattern
are specified, then all tables are returned.
-
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
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.- 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
TablePattern
is not specified, then all tables that matchSchemaPattern
are returned. If neitherSchemaPattern
orTablePattern
are specified, then all tables are returned.
-
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
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<ListTablesRequest.Builder,
ListTablesRequest> - Specified by:
toBuilder
in classRedshiftDataRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-