software.amazon.awssdk.services.redshiftdata.model

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(value="software.amazon.awssdk:codegen")
public final class ListTablesRequest
extends RedshiftDataRequest
implements ToCopyableBuilder<ListTablesRequest.Builder,ListTablesRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ListTablesRequest.Builder

Method Summary

Modifier and Type	Method and Description
static ListTablesRequest.Builder	builder()
String	clusterIdentifier() The cluster identifier.
String	connectedDatabase() A database name.
String	database() The name of the database that contains the tables to list.
String	dbUser() The database user name.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Integer	maxResults() The maximum number of tables to return in the response.
String	nextToken() A value that indicates the starting point for the next set of response records in a subsequent request.
String	schemaPattern() A pattern to filter results by schema name.
List<SdkField<?>>	sdkFields()
String	secretArn() The name or ARN of the secret that enables access to the database.
static Class<? extends ListTablesRequest.Builder>	serializableBuilderClass()
String	tablePattern() A pattern to filter results by table name.
ListTablesRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.

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

public final String dbUser()

The database user name. This parameter is required when connecting to a cluster and authenticating using temporary credentials.

Returns:

The database user name. This parameter is required when connecting to a cluster 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 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

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 SchemaPattern is not specified, then all tables that match TablePattern are returned. If neither SchemaPattern or TablePattern 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 match TablePattern are returned. If neither SchemaPattern or TablePattern are 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 TablePattern is not specified, then all tables that match SchemaPatternare returned. If neither SchemaPattern or TablePattern 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 match SchemaPatternare returned. If neither SchemaPattern or TablePattern are specified, then all tables are returned.

toBuilder

public ListTablesRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ListTablesRequest.Builder,ListTablesRequest>

Specified by:

toBuilder in class RedshiftDataRequest

builder

public static ListTablesRequest.Builder builder()

serializableBuilderClass

public static Class<? extends ListTablesRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

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.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo