/** * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * SPDX-License-Identifier: Apache-2.0. */ #pragma once #include #include #include #include namespace Aws { namespace RedshiftDataAPIService { namespace Model { /** */ class ListTablesRequest : public RedshiftDataAPIServiceRequest { public: AWS_REDSHIFTDATAAPISERVICE_API ListTablesRequest(); // Service request name is the Operation name which will send this request out, // each operation should has unique request name, so that we can get operation's name from this request. // Note: this is not true for response, multiple operations may have the same response name, // so we can not get operation's name from response. inline virtual const char* GetServiceRequestName() const override { return "ListTables"; } AWS_REDSHIFTDATAAPISERVICE_API Aws::String SerializePayload() const override; AWS_REDSHIFTDATAAPISERVICE_API Aws::Http::HeaderValueCollection GetRequestSpecificHeaders() const override; /** *

The cluster identifier. This parameter is required when connecting to a * cluster and authenticating using either Secrets Manager or temporary * credentials.

*/ inline const Aws::String& GetClusterIdentifier() const{ return m_clusterIdentifier; } /** *

The cluster identifier. This parameter is required when connecting to a * cluster and authenticating using either Secrets Manager or temporary * credentials.

*/ inline bool ClusterIdentifierHasBeenSet() const { return m_clusterIdentifierHasBeenSet; } /** *

The cluster identifier. This parameter is required when connecting to a * cluster and authenticating using either Secrets Manager or temporary * credentials.

*/ inline void SetClusterIdentifier(const Aws::String& value) { m_clusterIdentifierHasBeenSet = true; m_clusterIdentifier = value; } /** *

The cluster identifier. This parameter is required when connecting to a * cluster and authenticating using either Secrets Manager or temporary * credentials.

*/ inline void SetClusterIdentifier(Aws::String&& value) { m_clusterIdentifierHasBeenSet = true; m_clusterIdentifier = std::move(value); } /** *

The cluster identifier. This parameter is required when connecting to a * cluster and authenticating using either Secrets Manager or temporary * credentials.

*/ inline void SetClusterIdentifier(const char* value) { m_clusterIdentifierHasBeenSet = true; m_clusterIdentifier.assign(value); } /** *

The cluster identifier. This parameter is required when connecting to a * cluster and authenticating using either Secrets Manager or temporary * credentials.

*/ inline ListTablesRequest& WithClusterIdentifier(const Aws::String& value) { SetClusterIdentifier(value); return *this;} /** *

The cluster identifier. This parameter is required when connecting to a * cluster and authenticating using either Secrets Manager or temporary * credentials.

*/ inline ListTablesRequest& WithClusterIdentifier(Aws::String&& value) { SetClusterIdentifier(std::move(value)); return *this;} /** *

The cluster identifier. This parameter is required when connecting to a * cluster and authenticating using either Secrets Manager or temporary * credentials.

*/ inline ListTablesRequest& WithClusterIdentifier(const char* value) { SetClusterIdentifier(value); return *this;} /** *

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

*/ inline const Aws::String& GetConnectedDatabase() const{ return m_connectedDatabase; } /** *

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

*/ inline bool ConnectedDatabaseHasBeenSet() const { return m_connectedDatabaseHasBeenSet; } /** *

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

*/ inline void SetConnectedDatabase(const Aws::String& value) { m_connectedDatabaseHasBeenSet = true; m_connectedDatabase = value; } /** *

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

*/ inline void SetConnectedDatabase(Aws::String&& value) { m_connectedDatabaseHasBeenSet = true; m_connectedDatabase = std::move(value); } /** *

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

*/ inline void SetConnectedDatabase(const char* value) { m_connectedDatabaseHasBeenSet = true; m_connectedDatabase.assign(value); } /** *

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

*/ inline ListTablesRequest& WithConnectedDatabase(const Aws::String& value) { SetConnectedDatabase(value); return *this;} /** *

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

*/ inline ListTablesRequest& WithConnectedDatabase(Aws::String&& value) { SetConnectedDatabase(std::move(value)); return *this;} /** *

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

*/ inline ListTablesRequest& WithConnectedDatabase(const char* value) { SetConnectedDatabase(value); return *this;} /** *

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.

*/ inline const Aws::String& GetDatabase() const{ return m_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.

*/ inline bool DatabaseHasBeenSet() const { return m_databaseHasBeenSet; } /** *

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.

*/ inline void SetDatabase(const Aws::String& value) { m_databaseHasBeenSet = true; m_database = value; } /** *

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.

*/ inline void SetDatabase(Aws::String&& value) { m_databaseHasBeenSet = true; m_database = std::move(value); } /** *

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.

*/ inline void SetDatabase(const char* value) { m_databaseHasBeenSet = true; m_database.assign(value); } /** *

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.

*/ inline ListTablesRequest& WithDatabase(const Aws::String& value) { SetDatabase(value); return *this;} /** *

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.

*/ inline ListTablesRequest& WithDatabase(Aws::String&& value) { SetDatabase(std::move(value)); return *this;} /** *

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.

*/ inline ListTablesRequest& WithDatabase(const char* value) { SetDatabase(value); return *this;} /** *

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

*/ inline const Aws::String& GetDbUser() const{ return m_dbUser; } /** *

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

*/ inline bool DbUserHasBeenSet() const { return m_dbUserHasBeenSet; } /** *

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

*/ inline void SetDbUser(const Aws::String& value) { m_dbUserHasBeenSet = true; m_dbUser = value; } /** *

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

*/ inline void SetDbUser(Aws::String&& value) { m_dbUserHasBeenSet = true; m_dbUser = std::move(value); } /** *

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

*/ inline void SetDbUser(const char* value) { m_dbUserHasBeenSet = true; m_dbUser.assign(value); } /** *

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

*/ inline ListTablesRequest& WithDbUser(const Aws::String& value) { SetDbUser(value); return *this;} /** *

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

*/ inline ListTablesRequest& WithDbUser(Aws::String&& value) { SetDbUser(std::move(value)); return *this;} /** *

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

*/ inline ListTablesRequest& WithDbUser(const char* value) { SetDbUser(value); return *this;} /** *

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.

*/ inline int GetMaxResults() const{ return m_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.

*/ inline bool MaxResultsHasBeenSet() const { return m_maxResultsHasBeenSet; } /** *

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.

*/ inline void SetMaxResults(int value) { m_maxResultsHasBeenSet = true; m_maxResults = value; } /** *

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.

*/ inline ListTablesRequest& WithMaxResults(int value) { SetMaxResults(value); return *this;} /** *

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.

*/ inline const Aws::String& GetNextToken() const{ return m_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.

*/ inline bool NextTokenHasBeenSet() const { return m_nextTokenHasBeenSet; } /** *

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.

*/ inline void SetNextToken(const Aws::String& value) { m_nextTokenHasBeenSet = true; m_nextToken = value; } /** *

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.

*/ inline void SetNextToken(Aws::String&& value) { m_nextTokenHasBeenSet = true; m_nextToken = std::move(value); } /** *

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.

*/ inline void SetNextToken(const char* value) { m_nextTokenHasBeenSet = true; m_nextToken.assign(value); } /** *

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.

*/ inline ListTablesRequest& WithNextToken(const Aws::String& value) { SetNextToken(value); return *this;} /** *

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.

*/ inline ListTablesRequest& WithNextToken(Aws::String&& value) { SetNextToken(std::move(value)); return *this;} /** *

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.

*/ inline ListTablesRequest& WithNextToken(const char* value) { SetNextToken(value); return *this;} /** *

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.

*/ inline const Aws::String& GetSchemaPattern() const{ return m_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.

*/ inline bool SchemaPatternHasBeenSet() const { return m_schemaPatternHasBeenSet; } /** *

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.

*/ inline void SetSchemaPattern(const Aws::String& value) { m_schemaPatternHasBeenSet = true; m_schemaPattern = value; } /** *

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.

*/ inline void SetSchemaPattern(Aws::String&& value) { m_schemaPatternHasBeenSet = true; m_schemaPattern = std::move(value); } /** *

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.

*/ inline void SetSchemaPattern(const char* value) { m_schemaPatternHasBeenSet = true; m_schemaPattern.assign(value); } /** *

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.

*/ inline ListTablesRequest& WithSchemaPattern(const Aws::String& value) { SetSchemaPattern(value); return *this;} /** *

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.

*/ inline ListTablesRequest& WithSchemaPattern(Aws::String&& value) { SetSchemaPattern(std::move(value)); return *this;} /** *

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.

*/ inline ListTablesRequest& WithSchemaPattern(const char* value) { SetSchemaPattern(value); return *this;} /** *

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

*/ inline const Aws::String& GetSecretArn() const{ return m_secretArn; } /** *

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

*/ inline bool SecretArnHasBeenSet() const { return m_secretArnHasBeenSet; } /** *

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

*/ inline void SetSecretArn(const Aws::String& value) { m_secretArnHasBeenSet = true; m_secretArn = value; } /** *

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

*/ inline void SetSecretArn(Aws::String&& value) { m_secretArnHasBeenSet = true; m_secretArn = std::move(value); } /** *

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

*/ inline void SetSecretArn(const char* value) { m_secretArnHasBeenSet = true; m_secretArn.assign(value); } /** *

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

*/ inline ListTablesRequest& WithSecretArn(const Aws::String& value) { SetSecretArn(value); return *this;} /** *

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

*/ inline ListTablesRequest& WithSecretArn(Aws::String&& value) { SetSecretArn(std::move(value)); return *this;} /** *

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

*/ inline ListTablesRequest& WithSecretArn(const char* value) { SetSecretArn(value); return *this;} /** *

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.

*/ inline const Aws::String& GetTablePattern() const{ return m_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.

*/ inline bool TablePatternHasBeenSet() const { return m_tablePatternHasBeenSet; } /** *

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.

*/ inline void SetTablePattern(const Aws::String& value) { m_tablePatternHasBeenSet = true; m_tablePattern = value; } /** *

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.

*/ inline void SetTablePattern(Aws::String&& value) { m_tablePatternHasBeenSet = true; m_tablePattern = std::move(value); } /** *

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.

*/ inline void SetTablePattern(const char* value) { m_tablePatternHasBeenSet = true; m_tablePattern.assign(value); } /** *

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.

*/ inline ListTablesRequest& WithTablePattern(const Aws::String& value) { SetTablePattern(value); return *this;} /** *

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.

*/ inline ListTablesRequest& WithTablePattern(Aws::String&& value) { SetTablePattern(std::move(value)); return *this;} /** *

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.

*/ inline ListTablesRequest& WithTablePattern(const char* value) { SetTablePattern(value); return *this;} /** *

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.

*/ inline const Aws::String& GetWorkgroupName() const{ return m_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.

*/ inline bool WorkgroupNameHasBeenSet() const { return m_workgroupNameHasBeenSet; } /** *

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.

*/ inline void SetWorkgroupName(const Aws::String& value) { m_workgroupNameHasBeenSet = true; m_workgroupName = value; } /** *

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.

*/ inline void SetWorkgroupName(Aws::String&& value) { m_workgroupNameHasBeenSet = true; m_workgroupName = std::move(value); } /** *

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.

*/ inline void SetWorkgroupName(const char* value) { m_workgroupNameHasBeenSet = true; m_workgroupName.assign(value); } /** *

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.

*/ inline ListTablesRequest& WithWorkgroupName(const Aws::String& value) { SetWorkgroupName(value); return *this;} /** *

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.

*/ inline ListTablesRequest& WithWorkgroupName(Aws::String&& value) { SetWorkgroupName(std::move(value)); return *this;} /** *

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.

*/ inline ListTablesRequest& WithWorkgroupName(const char* value) { SetWorkgroupName(value); return *this;} private: Aws::String m_clusterIdentifier; bool m_clusterIdentifierHasBeenSet = false; Aws::String m_connectedDatabase; bool m_connectedDatabaseHasBeenSet = false; Aws::String m_database; bool m_databaseHasBeenSet = false; Aws::String m_dbUser; bool m_dbUserHasBeenSet = false; int m_maxResults; bool m_maxResultsHasBeenSet = false; Aws::String m_nextToken; bool m_nextTokenHasBeenSet = false; Aws::String m_schemaPattern; bool m_schemaPatternHasBeenSet = false; Aws::String m_secretArn; bool m_secretArnHasBeenSet = false; Aws::String m_tablePattern; bool m_tablePatternHasBeenSet = false; Aws::String m_workgroupName; bool m_workgroupNameHasBeenSet = false; }; } // namespace Model } // namespace RedshiftDataAPIService } // namespace Aws