AWS SDK for C++  1.9.19
AWS SDK for C++
Public Member Functions | List of all members
Aws::RedshiftDataAPIService::Model::ListTablesRequest Class Reference

#include <ListTablesRequest.h>

+ Inheritance diagram for Aws::RedshiftDataAPIService::Model::ListTablesRequest:

Public Member Functions

 ListTablesRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override
 
const Aws::StringGetClusterIdentifier () const
 
bool ClusterIdentifierHasBeenSet () const
 
void SetClusterIdentifier (const Aws::String &value)
 
void SetClusterIdentifier (Aws::String &&value)
 
void SetClusterIdentifier (const char *value)
 
ListTablesRequestWithClusterIdentifier (const Aws::String &value)
 
ListTablesRequestWithClusterIdentifier (Aws::String &&value)
 
ListTablesRequestWithClusterIdentifier (const char *value)
 
const Aws::StringGetConnectedDatabase () const
 
bool ConnectedDatabaseHasBeenSet () const
 
void SetConnectedDatabase (const Aws::String &value)
 
void SetConnectedDatabase (Aws::String &&value)
 
void SetConnectedDatabase (const char *value)
 
ListTablesRequestWithConnectedDatabase (const Aws::String &value)
 
ListTablesRequestWithConnectedDatabase (Aws::String &&value)
 
ListTablesRequestWithConnectedDatabase (const char *value)
 
const Aws::StringGetDatabase () const
 
bool DatabaseHasBeenSet () const
 
void SetDatabase (const Aws::String &value)
 
void SetDatabase (Aws::String &&value)
 
void SetDatabase (const char *value)
 
ListTablesRequestWithDatabase (const Aws::String &value)
 
ListTablesRequestWithDatabase (Aws::String &&value)
 
ListTablesRequestWithDatabase (const char *value)
 
const Aws::StringGetDbUser () const
 
bool DbUserHasBeenSet () const
 
void SetDbUser (const Aws::String &value)
 
void SetDbUser (Aws::String &&value)
 
void SetDbUser (const char *value)
 
ListTablesRequestWithDbUser (const Aws::String &value)
 
ListTablesRequestWithDbUser (Aws::String &&value)
 
ListTablesRequestWithDbUser (const char *value)
 
int GetMaxResults () const
 
bool MaxResultsHasBeenSet () const
 
void SetMaxResults (int value)
 
ListTablesRequestWithMaxResults (int value)
 
const Aws::StringGetNextToken () const
 
bool NextTokenHasBeenSet () const
 
void SetNextToken (const Aws::String &value)
 
void SetNextToken (Aws::String &&value)
 
void SetNextToken (const char *value)
 
ListTablesRequestWithNextToken (const Aws::String &value)
 
ListTablesRequestWithNextToken (Aws::String &&value)
 
ListTablesRequestWithNextToken (const char *value)
 
const Aws::StringGetSchemaPattern () const
 
bool SchemaPatternHasBeenSet () const
 
void SetSchemaPattern (const Aws::String &value)
 
void SetSchemaPattern (Aws::String &&value)
 
void SetSchemaPattern (const char *value)
 
ListTablesRequestWithSchemaPattern (const Aws::String &value)
 
ListTablesRequestWithSchemaPattern (Aws::String &&value)
 
ListTablesRequestWithSchemaPattern (const char *value)
 
const Aws::StringGetSecretArn () const
 
bool SecretArnHasBeenSet () const
 
void SetSecretArn (const Aws::String &value)
 
void SetSecretArn (Aws::String &&value)
 
void SetSecretArn (const char *value)
 
ListTablesRequestWithSecretArn (const Aws::String &value)
 
ListTablesRequestWithSecretArn (Aws::String &&value)
 
ListTablesRequestWithSecretArn (const char *value)
 
const Aws::StringGetTablePattern () const
 
bool TablePatternHasBeenSet () const
 
void SetTablePattern (const Aws::String &value)
 
void SetTablePattern (Aws::String &&value)
 
void SetTablePattern (const char *value)
 
ListTablesRequestWithTablePattern (const Aws::String &value)
 
ListTablesRequestWithTablePattern (Aws::String &&value)
 
ListTablesRequestWithTablePattern (const char *value)
 
- Public Member Functions inherited from Aws::RedshiftDataAPIService::RedshiftDataAPIServiceRequest
virtual ~RedshiftDataAPIServiceRequest ()
 
void AddParametersToRequest (Aws::Http::HttpRequest &httpRequest) const
 
Aws::Http::HeaderValueCollection GetHeaders () const override
 
- Public Member Functions inherited from Aws::AmazonSerializableWebServiceRequest
 AmazonSerializableWebServiceRequest ()
 
virtual ~AmazonSerializableWebServiceRequest ()
 
std::shared_ptr< Aws::IOStreamGetBody () const override
 
- Public Member Functions inherited from Aws::AmazonWebServiceRequest
 AmazonWebServiceRequest ()
 
virtual ~AmazonWebServiceRequest ()=default
 
virtual void AddQueryStringParameters (Aws::Http::URI &uri) const
 
virtual void PutToPresignedUrl (Aws::Http::URI &uri) const
 
virtual bool IsStreaming () const
 
virtual bool IsEventStreamRequest () const
 
virtual bool SignBody () const
 
virtual bool IsChunked () const
 
virtual void SetRequestSignedHandler (const RequestSignedHandler &handler)
 
virtual const RequestSignedHandlerGetRequestSignedHandler () const
 
const Aws::IOStreamFactoryGetResponseStreamFactory () const
 
void SetResponseStreamFactory (const Aws::IOStreamFactory &factory)
 
virtual void SetDataReceivedEventHandler (const Aws::Http::DataReceivedEventHandler &dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (const Aws::Http::DataSentEventHandler &dataSentEventHandler)
 
virtual void SetContinueRequestHandler (const Aws::Http::ContinueRequestHandler &continueRequestHandler)
 
virtual void SetDataReceivedEventHandler (Aws::Http::DataReceivedEventHandler &&dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (Aws::Http::DataSentEventHandler &&dataSentEventHandler)
 
virtual void SetContinueRequestHandler (Aws::Http::ContinueRequestHandler &&continueRequestHandler)
 
virtual void SetRequestRetryHandler (const RequestRetryHandler &handler)
 
virtual void SetRequestRetryHandler (RequestRetryHandler &&handler)
 
virtual const Aws::Http::DataReceivedEventHandlerGetDataReceivedEventHandler () const
 
virtual const Aws::Http::DataSentEventHandlerGetDataSentEventHandler () const
 
virtual const Aws::Http::ContinueRequestHandlerGetContinueRequestHandler () const
 
virtual const RequestRetryHandlerGetRequestRetryHandler () const
 
virtual bool ShouldComputeContentMd5 () const
 

Additional Inherited Members

- Protected Member Functions inherited from Aws::AmazonWebServiceRequest
virtual void DumpBodyToUrl (Aws::Http::URI &uri) const
 

Detailed Description

Definition at line 21 of file ListTablesRequest.h.

Constructor & Destructor Documentation

◆ ListTablesRequest()

Aws::RedshiftDataAPIService::Model::ListTablesRequest::ListTablesRequest ( )

Member Function Documentation

◆ ClusterIdentifierHasBeenSet()

bool Aws::RedshiftDataAPIService::Model::ListTablesRequest::ClusterIdentifierHasBeenSet ( ) const
inline

The cluster identifier. This parameter is required when authenticating using either AWS Secrets Manager or temporary credentials.

Definition at line 47 of file ListTablesRequest.h.

◆ ConnectedDatabaseHasBeenSet()

bool Aws::RedshiftDataAPIService::Model::ListTablesRequest::ConnectedDatabaseHasBeenSet ( ) const
inline

A database name. The connected database is specified when you connect with your authentication credentials.

Definition at line 96 of file ListTablesRequest.h.

◆ DatabaseHasBeenSet()

bool Aws::RedshiftDataAPIService::Model::ListTablesRequest::DatabaseHasBeenSet ( ) const
inline

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.

Definition at line 147 of file ListTablesRequest.h.

◆ DbUserHasBeenSet()

bool Aws::RedshiftDataAPIService::Model::ListTablesRequest::DbUserHasBeenSet ( ) const
inline

The database user name. This parameter is required when authenticating using temporary credentials.

Definition at line 202 of file ListTablesRequest.h.

◆ GetClusterIdentifier()

const Aws::String& Aws::RedshiftDataAPIService::Model::ListTablesRequest::GetClusterIdentifier ( ) const
inline

The cluster identifier. This parameter is required when authenticating using either AWS Secrets Manager or temporary credentials.

Definition at line 41 of file ListTablesRequest.h.

◆ GetConnectedDatabase()

const Aws::String& Aws::RedshiftDataAPIService::Model::ListTablesRequest::GetConnectedDatabase ( ) const
inline

A database name. The connected database is specified when you connect with your authentication credentials.

Definition at line 90 of file ListTablesRequest.h.

◆ GetDatabase()

const Aws::String& Aws::RedshiftDataAPIService::Model::ListTablesRequest::GetDatabase ( ) const
inline

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.

Definition at line 140 of file ListTablesRequest.h.

◆ GetDbUser()

const Aws::String& Aws::RedshiftDataAPIService::Model::ListTablesRequest::GetDbUser ( ) const
inline

The database user name. This parameter is required when authenticating using temporary credentials.

Definition at line 196 of file ListTablesRequest.h.

◆ GetMaxResults()

int Aws::RedshiftDataAPIService::Model::ListTablesRequest::GetMaxResults ( ) const
inline

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.

Definition at line 246 of file ListTablesRequest.h.

◆ GetNextToken()

const Aws::String& Aws::RedshiftDataAPIService::Model::ListTablesRequest::GetNextToken ( ) const
inline

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.

Definition at line 277 of file ListTablesRequest.h.

◆ GetRequestSpecificHeaders()

Aws::Http::HeaderValueCollection Aws::RedshiftDataAPIService::Model::ListTablesRequest::GetRequestSpecificHeaders ( ) const
overridevirtual

◆ GetSchemaPattern()

const Aws::String& Aws::RedshiftDataAPIService::Model::ListTablesRequest::GetSchemaPattern ( ) const
inline

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.

Definition at line 351 of file ListTablesRequest.h.

◆ GetSecretArn()

const Aws::String& Aws::RedshiftDataAPIService::Model::ListTablesRequest::GetSecretArn ( ) const
inline

The name or ARN of the secret that enables access to the database. This parameter is required when authenticating using AWS Secrets Manager.

Definition at line 428 of file ListTablesRequest.h.

◆ GetServiceRequestName()

virtual const char* Aws::RedshiftDataAPIService::Model::ListTablesRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 30 of file ListTablesRequest.h.

◆ GetTablePattern()

const Aws::String& Aws::RedshiftDataAPIService::Model::ListTablesRequest::GetTablePattern ( ) const
inline

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.

Definition at line 481 of file ListTablesRequest.h.

◆ MaxResultsHasBeenSet()

bool Aws::RedshiftDataAPIService::Model::ListTablesRequest::MaxResultsHasBeenSet ( ) const
inline

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.

Definition at line 253 of file ListTablesRequest.h.

◆ NextTokenHasBeenSet()

bool Aws::RedshiftDataAPIService::Model::ListTablesRequest::NextTokenHasBeenSet ( ) const
inline

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.

Definition at line 286 of file ListTablesRequest.h.

◆ SchemaPatternHasBeenSet()

bool Aws::RedshiftDataAPIService::Model::ListTablesRequest::SchemaPatternHasBeenSet ( ) const
inline

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.

Definition at line 361 of file ListTablesRequest.h.

◆ SecretArnHasBeenSet()

bool Aws::RedshiftDataAPIService::Model::ListTablesRequest::SecretArnHasBeenSet ( ) const
inline

The name or ARN of the secret that enables access to the database. This parameter is required when authenticating using AWS Secrets Manager.

Definition at line 434 of file ListTablesRequest.h.

◆ SerializePayload()

Aws::String Aws::RedshiftDataAPIService::Model::ListTablesRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetClusterIdentifier() [1/3]

void Aws::RedshiftDataAPIService::Model::ListTablesRequest::SetClusterIdentifier ( Aws::String &&  value)
inline

The cluster identifier. This parameter is required when authenticating using either AWS Secrets Manager or temporary credentials.

Definition at line 59 of file ListTablesRequest.h.

◆ SetClusterIdentifier() [2/3]

void Aws::RedshiftDataAPIService::Model::ListTablesRequest::SetClusterIdentifier ( const Aws::String value)
inline

The cluster identifier. This parameter is required when authenticating using either AWS Secrets Manager or temporary credentials.

Definition at line 53 of file ListTablesRequest.h.

◆ SetClusterIdentifier() [3/3]

void Aws::RedshiftDataAPIService::Model::ListTablesRequest::SetClusterIdentifier ( const char *  value)
inline

The cluster identifier. This parameter is required when authenticating using either AWS Secrets Manager or temporary credentials.

Definition at line 65 of file ListTablesRequest.h.

◆ SetConnectedDatabase() [1/3]

void Aws::RedshiftDataAPIService::Model::ListTablesRequest::SetConnectedDatabase ( Aws::String &&  value)
inline

A database name. The connected database is specified when you connect with your authentication credentials.

Definition at line 108 of file ListTablesRequest.h.

◆ SetConnectedDatabase() [2/3]

void Aws::RedshiftDataAPIService::Model::ListTablesRequest::SetConnectedDatabase ( const Aws::String value)
inline

A database name. The connected database is specified when you connect with your authentication credentials.

Definition at line 102 of file ListTablesRequest.h.

◆ SetConnectedDatabase() [3/3]

void Aws::RedshiftDataAPIService::Model::ListTablesRequest::SetConnectedDatabase ( const char *  value)
inline

A database name. The connected database is specified when you connect with your authentication credentials.

Definition at line 114 of file ListTablesRequest.h.

◆ SetDatabase() [1/3]

void Aws::RedshiftDataAPIService::Model::ListTablesRequest::SetDatabase ( Aws::String &&  value)
inline

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.

Definition at line 161 of file ListTablesRequest.h.

◆ SetDatabase() [2/3]

void Aws::RedshiftDataAPIService::Model::ListTablesRequest::SetDatabase ( const Aws::String value)
inline

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.

Definition at line 154 of file ListTablesRequest.h.

◆ SetDatabase() [3/3]

void Aws::RedshiftDataAPIService::Model::ListTablesRequest::SetDatabase ( const char *  value)
inline

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.

Definition at line 168 of file ListTablesRequest.h.

◆ SetDbUser() [1/3]

void Aws::RedshiftDataAPIService::Model::ListTablesRequest::SetDbUser ( Aws::String &&  value)
inline

The database user name. This parameter is required when authenticating using temporary credentials.

Definition at line 214 of file ListTablesRequest.h.

◆ SetDbUser() [2/3]

void Aws::RedshiftDataAPIService::Model::ListTablesRequest::SetDbUser ( const Aws::String value)
inline

The database user name. This parameter is required when authenticating using temporary credentials.

Definition at line 208 of file ListTablesRequest.h.

◆ SetDbUser() [3/3]

void Aws::RedshiftDataAPIService::Model::ListTablesRequest::SetDbUser ( const char *  value)
inline

The database user name. This parameter is required when authenticating using temporary credentials.

Definition at line 220 of file ListTablesRequest.h.

◆ SetMaxResults()

void Aws::RedshiftDataAPIService::Model::ListTablesRequest::SetMaxResults ( int  value)
inline

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.

Definition at line 260 of file ListTablesRequest.h.

◆ SetNextToken() [1/3]

void Aws::RedshiftDataAPIService::Model::ListTablesRequest::SetNextToken ( Aws::String &&  value)
inline

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.

Definition at line 304 of file ListTablesRequest.h.

◆ SetNextToken() [2/3]

void Aws::RedshiftDataAPIService::Model::ListTablesRequest::SetNextToken ( const Aws::String value)
inline

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.

Definition at line 295 of file ListTablesRequest.h.

◆ SetNextToken() [3/3]

void Aws::RedshiftDataAPIService::Model::ListTablesRequest::SetNextToken ( const char *  value)
inline

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.

Definition at line 313 of file ListTablesRequest.h.

◆ SetSchemaPattern() [1/3]

void Aws::RedshiftDataAPIService::Model::ListTablesRequest::SetSchemaPattern ( Aws::String &&  value)
inline

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.

Definition at line 381 of file ListTablesRequest.h.

◆ SetSchemaPattern() [2/3]

void Aws::RedshiftDataAPIService::Model::ListTablesRequest::SetSchemaPattern ( const Aws::String value)
inline

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.

Definition at line 371 of file ListTablesRequest.h.

◆ SetSchemaPattern() [3/3]

void Aws::RedshiftDataAPIService::Model::ListTablesRequest::SetSchemaPattern ( const char *  value)
inline

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.

Definition at line 391 of file ListTablesRequest.h.

◆ SetSecretArn() [1/3]

void Aws::RedshiftDataAPIService::Model::ListTablesRequest::SetSecretArn ( Aws::String &&  value)
inline

The name or ARN of the secret that enables access to the database. This parameter is required when authenticating using AWS Secrets Manager.

Definition at line 446 of file ListTablesRequest.h.

◆ SetSecretArn() [2/3]

void Aws::RedshiftDataAPIService::Model::ListTablesRequest::SetSecretArn ( const Aws::String value)
inline

The name or ARN of the secret that enables access to the database. This parameter is required when authenticating using AWS Secrets Manager.

Definition at line 440 of file ListTablesRequest.h.

◆ SetSecretArn() [3/3]

void Aws::RedshiftDataAPIService::Model::ListTablesRequest::SetSecretArn ( const char *  value)
inline

The name or ARN of the secret that enables access to the database. This parameter is required when authenticating using AWS Secrets Manager.

Definition at line 452 of file ListTablesRequest.h.

◆ SetTablePattern() [1/3]

void Aws::RedshiftDataAPIService::Model::ListTablesRequest::SetTablePattern ( Aws::String &&  value)
inline

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.

Definition at line 511 of file ListTablesRequest.h.

◆ SetTablePattern() [2/3]

void Aws::RedshiftDataAPIService::Model::ListTablesRequest::SetTablePattern ( const Aws::String value)
inline

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.

Definition at line 501 of file ListTablesRequest.h.

◆ SetTablePattern() [3/3]

void Aws::RedshiftDataAPIService::Model::ListTablesRequest::SetTablePattern ( const char *  value)
inline

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.

Definition at line 521 of file ListTablesRequest.h.

◆ TablePatternHasBeenSet()

bool Aws::RedshiftDataAPIService::Model::ListTablesRequest::TablePatternHasBeenSet ( ) const
inline

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.

Definition at line 491 of file ListTablesRequest.h.

◆ WithClusterIdentifier() [1/3]

ListTablesRequest& Aws::RedshiftDataAPIService::Model::ListTablesRequest::WithClusterIdentifier ( Aws::String &&  value)
inline

The cluster identifier. This parameter is required when authenticating using either AWS Secrets Manager or temporary credentials.

Definition at line 77 of file ListTablesRequest.h.

◆ WithClusterIdentifier() [2/3]

ListTablesRequest& Aws::RedshiftDataAPIService::Model::ListTablesRequest::WithClusterIdentifier ( const Aws::String value)
inline

The cluster identifier. This parameter is required when authenticating using either AWS Secrets Manager or temporary credentials.

Definition at line 71 of file ListTablesRequest.h.

◆ WithClusterIdentifier() [3/3]

ListTablesRequest& Aws::RedshiftDataAPIService::Model::ListTablesRequest::WithClusterIdentifier ( const char *  value)
inline

The cluster identifier. This parameter is required when authenticating using either AWS Secrets Manager or temporary credentials.

Definition at line 83 of file ListTablesRequest.h.

◆ WithConnectedDatabase() [1/3]

ListTablesRequest& Aws::RedshiftDataAPIService::Model::ListTablesRequest::WithConnectedDatabase ( Aws::String &&  value)
inline

A database name. The connected database is specified when you connect with your authentication credentials.

Definition at line 126 of file ListTablesRequest.h.

◆ WithConnectedDatabase() [2/3]

ListTablesRequest& Aws::RedshiftDataAPIService::Model::ListTablesRequest::WithConnectedDatabase ( const Aws::String value)
inline

A database name. The connected database is specified when you connect with your authentication credentials.

Definition at line 120 of file ListTablesRequest.h.

◆ WithConnectedDatabase() [3/3]

ListTablesRequest& Aws::RedshiftDataAPIService::Model::ListTablesRequest::WithConnectedDatabase ( const char *  value)
inline

A database name. The connected database is specified when you connect with your authentication credentials.

Definition at line 132 of file ListTablesRequest.h.

◆ WithDatabase() [1/3]

ListTablesRequest& Aws::RedshiftDataAPIService::Model::ListTablesRequest::WithDatabase ( Aws::String &&  value)
inline

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.

Definition at line 182 of file ListTablesRequest.h.

◆ WithDatabase() [2/3]

ListTablesRequest& Aws::RedshiftDataAPIService::Model::ListTablesRequest::WithDatabase ( const Aws::String value)
inline

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.

Definition at line 175 of file ListTablesRequest.h.

◆ WithDatabase() [3/3]

ListTablesRequest& Aws::RedshiftDataAPIService::Model::ListTablesRequest::WithDatabase ( const char *  value)
inline

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.

Definition at line 189 of file ListTablesRequest.h.

◆ WithDbUser() [1/3]

ListTablesRequest& Aws::RedshiftDataAPIService::Model::ListTablesRequest::WithDbUser ( Aws::String &&  value)
inline

The database user name. This parameter is required when authenticating using temporary credentials.

Definition at line 232 of file ListTablesRequest.h.

◆ WithDbUser() [2/3]

ListTablesRequest& Aws::RedshiftDataAPIService::Model::ListTablesRequest::WithDbUser ( const Aws::String value)
inline

The database user name. This parameter is required when authenticating using temporary credentials.

Definition at line 226 of file ListTablesRequest.h.

◆ WithDbUser() [3/3]

ListTablesRequest& Aws::RedshiftDataAPIService::Model::ListTablesRequest::WithDbUser ( const char *  value)
inline

The database user name. This parameter is required when authenticating using temporary credentials.

Definition at line 238 of file ListTablesRequest.h.

◆ WithMaxResults()

ListTablesRequest& Aws::RedshiftDataAPIService::Model::ListTablesRequest::WithMaxResults ( int  value)
inline

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.

Definition at line 267 of file ListTablesRequest.h.

◆ WithNextToken() [1/3]

ListTablesRequest& Aws::RedshiftDataAPIService::Model::ListTablesRequest::WithNextToken ( Aws::String &&  value)
inline

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.

Definition at line 331 of file ListTablesRequest.h.

◆ WithNextToken() [2/3]

ListTablesRequest& Aws::RedshiftDataAPIService::Model::ListTablesRequest::WithNextToken ( const Aws::String value)
inline

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.

Definition at line 322 of file ListTablesRequest.h.

◆ WithNextToken() [3/3]

ListTablesRequest& Aws::RedshiftDataAPIService::Model::ListTablesRequest::WithNextToken ( const char *  value)
inline

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.

Definition at line 340 of file ListTablesRequest.h.

◆ WithSchemaPattern() [1/3]

ListTablesRequest& Aws::RedshiftDataAPIService::Model::ListTablesRequest::WithSchemaPattern ( Aws::String &&  value)
inline

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.

Definition at line 411 of file ListTablesRequest.h.

◆ WithSchemaPattern() [2/3]

ListTablesRequest& Aws::RedshiftDataAPIService::Model::ListTablesRequest::WithSchemaPattern ( const Aws::String value)
inline

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.

Definition at line 401 of file ListTablesRequest.h.

◆ WithSchemaPattern() [3/3]

ListTablesRequest& Aws::RedshiftDataAPIService::Model::ListTablesRequest::WithSchemaPattern ( const char *  value)
inline

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.

Definition at line 421 of file ListTablesRequest.h.

◆ WithSecretArn() [1/3]

ListTablesRequest& Aws::RedshiftDataAPIService::Model::ListTablesRequest::WithSecretArn ( Aws::String &&  value)
inline

The name or ARN of the secret that enables access to the database. This parameter is required when authenticating using AWS Secrets Manager.

Definition at line 464 of file ListTablesRequest.h.

◆ WithSecretArn() [2/3]

ListTablesRequest& Aws::RedshiftDataAPIService::Model::ListTablesRequest::WithSecretArn ( const Aws::String value)
inline

The name or ARN of the secret that enables access to the database. This parameter is required when authenticating using AWS Secrets Manager.

Definition at line 458 of file ListTablesRequest.h.

◆ WithSecretArn() [3/3]

ListTablesRequest& Aws::RedshiftDataAPIService::Model::ListTablesRequest::WithSecretArn ( const char *  value)
inline

The name or ARN of the secret that enables access to the database. This parameter is required when authenticating using AWS Secrets Manager.

Definition at line 470 of file ListTablesRequest.h.

◆ WithTablePattern() [1/3]

ListTablesRequest& Aws::RedshiftDataAPIService::Model::ListTablesRequest::WithTablePattern ( Aws::String &&  value)
inline

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.

Definition at line 541 of file ListTablesRequest.h.

◆ WithTablePattern() [2/3]

ListTablesRequest& Aws::RedshiftDataAPIService::Model::ListTablesRequest::WithTablePattern ( const Aws::String value)
inline

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.

Definition at line 531 of file ListTablesRequest.h.

◆ WithTablePattern() [3/3]

ListTablesRequest& Aws::RedshiftDataAPIService::Model::ListTablesRequest::WithTablePattern ( const char *  value)
inline

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.

Definition at line 551 of file ListTablesRequest.h.


The documentation for this class was generated from the following file: