/** * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * SPDX-License-Identifier: Apache-2.0. */ #pragma once #include #include #include #include #include namespace Aws { namespace LakeFormation { namespace Model { /** */ class GetTableObjectsRequest : public LakeFormationRequest { public: AWS_LAKEFORMATION_API GetTableObjectsRequest(); // 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 "GetTableObjects"; } AWS_LAKEFORMATION_API Aws::String SerializePayload() const override; /** *

The catalog containing the governed table. Defaults to the caller’s * account.

*/ inline const Aws::String& GetCatalogId() const{ return m_catalogId; } /** *

The catalog containing the governed table. Defaults to the caller’s * account.

*/ inline bool CatalogIdHasBeenSet() const { return m_catalogIdHasBeenSet; } /** *

The catalog containing the governed table. Defaults to the caller’s * account.

*/ inline void SetCatalogId(const Aws::String& value) { m_catalogIdHasBeenSet = true; m_catalogId = value; } /** *

The catalog containing the governed table. Defaults to the caller’s * account.

*/ inline void SetCatalogId(Aws::String&& value) { m_catalogIdHasBeenSet = true; m_catalogId = std::move(value); } /** *

The catalog containing the governed table. Defaults to the caller’s * account.

*/ inline void SetCatalogId(const char* value) { m_catalogIdHasBeenSet = true; m_catalogId.assign(value); } /** *

The catalog containing the governed table. Defaults to the caller’s * account.

*/ inline GetTableObjectsRequest& WithCatalogId(const Aws::String& value) { SetCatalogId(value); return *this;} /** *

The catalog containing the governed table. Defaults to the caller’s * account.

*/ inline GetTableObjectsRequest& WithCatalogId(Aws::String&& value) { SetCatalogId(std::move(value)); return *this;} /** *

The catalog containing the governed table. Defaults to the caller’s * account.

*/ inline GetTableObjectsRequest& WithCatalogId(const char* value) { SetCatalogId(value); return *this;} /** *

The database containing the governed table.

*/ inline const Aws::String& GetDatabaseName() const{ return m_databaseName; } /** *

The database containing the governed table.

*/ inline bool DatabaseNameHasBeenSet() const { return m_databaseNameHasBeenSet; } /** *

The database containing the governed table.

*/ inline void SetDatabaseName(const Aws::String& value) { m_databaseNameHasBeenSet = true; m_databaseName = value; } /** *

The database containing the governed table.

*/ inline void SetDatabaseName(Aws::String&& value) { m_databaseNameHasBeenSet = true; m_databaseName = std::move(value); } /** *

The database containing the governed table.

*/ inline void SetDatabaseName(const char* value) { m_databaseNameHasBeenSet = true; m_databaseName.assign(value); } /** *

The database containing the governed table.

*/ inline GetTableObjectsRequest& WithDatabaseName(const Aws::String& value) { SetDatabaseName(value); return *this;} /** *

The database containing the governed table.

*/ inline GetTableObjectsRequest& WithDatabaseName(Aws::String&& value) { SetDatabaseName(std::move(value)); return *this;} /** *

The database containing the governed table.

*/ inline GetTableObjectsRequest& WithDatabaseName(const char* value) { SetDatabaseName(value); return *this;} /** *

The governed table for which to retrieve objects.

*/ inline const Aws::String& GetTableName() const{ return m_tableName; } /** *

The governed table for which to retrieve objects.

*/ inline bool TableNameHasBeenSet() const { return m_tableNameHasBeenSet; } /** *

The governed table for which to retrieve objects.

*/ inline void SetTableName(const Aws::String& value) { m_tableNameHasBeenSet = true; m_tableName = value; } /** *

The governed table for which to retrieve objects.

*/ inline void SetTableName(Aws::String&& value) { m_tableNameHasBeenSet = true; m_tableName = std::move(value); } /** *

The governed table for which to retrieve objects.

*/ inline void SetTableName(const char* value) { m_tableNameHasBeenSet = true; m_tableName.assign(value); } /** *

The governed table for which to retrieve objects.

*/ inline GetTableObjectsRequest& WithTableName(const Aws::String& value) { SetTableName(value); return *this;} /** *

The governed table for which to retrieve objects.

*/ inline GetTableObjectsRequest& WithTableName(Aws::String&& value) { SetTableName(std::move(value)); return *this;} /** *

The governed table for which to retrieve objects.

*/ inline GetTableObjectsRequest& WithTableName(const char* value) { SetTableName(value); return *this;} /** *

The transaction ID at which to read the governed table contents. If this * transaction has aborted, an error is returned. If not set, defaults to the most * recent committed transaction. Cannot be specified along with * QueryAsOfTime.

*/ inline const Aws::String& GetTransactionId() const{ return m_transactionId; } /** *

The transaction ID at which to read the governed table contents. If this * transaction has aborted, an error is returned. If not set, defaults to the most * recent committed transaction. Cannot be specified along with * QueryAsOfTime.

*/ inline bool TransactionIdHasBeenSet() const { return m_transactionIdHasBeenSet; } /** *

The transaction ID at which to read the governed table contents. If this * transaction has aborted, an error is returned. If not set, defaults to the most * recent committed transaction. Cannot be specified along with * QueryAsOfTime.

*/ inline void SetTransactionId(const Aws::String& value) { m_transactionIdHasBeenSet = true; m_transactionId = value; } /** *

The transaction ID at which to read the governed table contents. If this * transaction has aborted, an error is returned. If not set, defaults to the most * recent committed transaction. Cannot be specified along with * QueryAsOfTime.

*/ inline void SetTransactionId(Aws::String&& value) { m_transactionIdHasBeenSet = true; m_transactionId = std::move(value); } /** *

The transaction ID at which to read the governed table contents. If this * transaction has aborted, an error is returned. If not set, defaults to the most * recent committed transaction. Cannot be specified along with * QueryAsOfTime.

*/ inline void SetTransactionId(const char* value) { m_transactionIdHasBeenSet = true; m_transactionId.assign(value); } /** *

The transaction ID at which to read the governed table contents. If this * transaction has aborted, an error is returned. If not set, defaults to the most * recent committed transaction. Cannot be specified along with * QueryAsOfTime.

*/ inline GetTableObjectsRequest& WithTransactionId(const Aws::String& value) { SetTransactionId(value); return *this;} /** *

The transaction ID at which to read the governed table contents. If this * transaction has aborted, an error is returned. If not set, defaults to the most * recent committed transaction. Cannot be specified along with * QueryAsOfTime.

*/ inline GetTableObjectsRequest& WithTransactionId(Aws::String&& value) { SetTransactionId(std::move(value)); return *this;} /** *

The transaction ID at which to read the governed table contents. If this * transaction has aborted, an error is returned. If not set, defaults to the most * recent committed transaction. Cannot be specified along with * QueryAsOfTime.

*/ inline GetTableObjectsRequest& WithTransactionId(const char* value) { SetTransactionId(value); return *this;} /** *

The time as of when to read the governed table contents. If not set, the most * recent transaction commit time is used. Cannot be specified along with * TransactionId.

*/ inline const Aws::Utils::DateTime& GetQueryAsOfTime() const{ return m_queryAsOfTime; } /** *

The time as of when to read the governed table contents. If not set, the most * recent transaction commit time is used. Cannot be specified along with * TransactionId.

*/ inline bool QueryAsOfTimeHasBeenSet() const { return m_queryAsOfTimeHasBeenSet; } /** *

The time as of when to read the governed table contents. If not set, the most * recent transaction commit time is used. Cannot be specified along with * TransactionId.

*/ inline void SetQueryAsOfTime(const Aws::Utils::DateTime& value) { m_queryAsOfTimeHasBeenSet = true; m_queryAsOfTime = value; } /** *

The time as of when to read the governed table contents. If not set, the most * recent transaction commit time is used. Cannot be specified along with * TransactionId.

*/ inline void SetQueryAsOfTime(Aws::Utils::DateTime&& value) { m_queryAsOfTimeHasBeenSet = true; m_queryAsOfTime = std::move(value); } /** *

The time as of when to read the governed table contents. If not set, the most * recent transaction commit time is used. Cannot be specified along with * TransactionId.

*/ inline GetTableObjectsRequest& WithQueryAsOfTime(const Aws::Utils::DateTime& value) { SetQueryAsOfTime(value); return *this;} /** *

The time as of when to read the governed table contents. If not set, the most * recent transaction commit time is used. Cannot be specified along with * TransactionId.

*/ inline GetTableObjectsRequest& WithQueryAsOfTime(Aws::Utils::DateTime&& value) { SetQueryAsOfTime(std::move(value)); return *this;} /** *

A predicate to filter the objects returned based on the partition keys * defined in the governed table.

  • The comparison operators * supported are: =, >, <, >=, <=

  • The logical * operators supported are: AND

  • The data types supported are * integer, long, date(yyyy-MM-dd), timestamp(yyyy-MM-dd HH:mm:ssXXX or yyyy-MM-dd * HH:mm:ss"), string and decimal.

*/ inline const Aws::String& GetPartitionPredicate() const{ return m_partitionPredicate; } /** *

A predicate to filter the objects returned based on the partition keys * defined in the governed table.

  • The comparison operators * supported are: =, >, <, >=, <=

  • The logical * operators supported are: AND

  • The data types supported are * integer, long, date(yyyy-MM-dd), timestamp(yyyy-MM-dd HH:mm:ssXXX or yyyy-MM-dd * HH:mm:ss"), string and decimal.

*/ inline bool PartitionPredicateHasBeenSet() const { return m_partitionPredicateHasBeenSet; } /** *

A predicate to filter the objects returned based on the partition keys * defined in the governed table.

  • The comparison operators * supported are: =, >, <, >=, <=

  • The logical * operators supported are: AND

  • The data types supported are * integer, long, date(yyyy-MM-dd), timestamp(yyyy-MM-dd HH:mm:ssXXX or yyyy-MM-dd * HH:mm:ss"), string and decimal.

*/ inline void SetPartitionPredicate(const Aws::String& value) { m_partitionPredicateHasBeenSet = true; m_partitionPredicate = value; } /** *

A predicate to filter the objects returned based on the partition keys * defined in the governed table.

  • The comparison operators * supported are: =, >, <, >=, <=

  • The logical * operators supported are: AND

  • The data types supported are * integer, long, date(yyyy-MM-dd), timestamp(yyyy-MM-dd HH:mm:ssXXX or yyyy-MM-dd * HH:mm:ss"), string and decimal.

*/ inline void SetPartitionPredicate(Aws::String&& value) { m_partitionPredicateHasBeenSet = true; m_partitionPredicate = std::move(value); } /** *

A predicate to filter the objects returned based on the partition keys * defined in the governed table.

  • The comparison operators * supported are: =, >, <, >=, <=

  • The logical * operators supported are: AND

  • The data types supported are * integer, long, date(yyyy-MM-dd), timestamp(yyyy-MM-dd HH:mm:ssXXX or yyyy-MM-dd * HH:mm:ss"), string and decimal.

*/ inline void SetPartitionPredicate(const char* value) { m_partitionPredicateHasBeenSet = true; m_partitionPredicate.assign(value); } /** *

A predicate to filter the objects returned based on the partition keys * defined in the governed table.

  • The comparison operators * supported are: =, >, <, >=, <=

  • The logical * operators supported are: AND

  • The data types supported are * integer, long, date(yyyy-MM-dd), timestamp(yyyy-MM-dd HH:mm:ssXXX or yyyy-MM-dd * HH:mm:ss"), string and decimal.

*/ inline GetTableObjectsRequest& WithPartitionPredicate(const Aws::String& value) { SetPartitionPredicate(value); return *this;} /** *

A predicate to filter the objects returned based on the partition keys * defined in the governed table.

  • The comparison operators * supported are: =, >, <, >=, <=

  • The logical * operators supported are: AND

  • The data types supported are * integer, long, date(yyyy-MM-dd), timestamp(yyyy-MM-dd HH:mm:ssXXX or yyyy-MM-dd * HH:mm:ss"), string and decimal.

*/ inline GetTableObjectsRequest& WithPartitionPredicate(Aws::String&& value) { SetPartitionPredicate(std::move(value)); return *this;} /** *

A predicate to filter the objects returned based on the partition keys * defined in the governed table.

  • The comparison operators * supported are: =, >, <, >=, <=

  • The logical * operators supported are: AND

  • The data types supported are * integer, long, date(yyyy-MM-dd), timestamp(yyyy-MM-dd HH:mm:ssXXX or yyyy-MM-dd * HH:mm:ss"), string and decimal.

*/ inline GetTableObjectsRequest& WithPartitionPredicate(const char* value) { SetPartitionPredicate(value); return *this;} /** *

Specifies how many values to return in a page.

*/ inline int GetMaxResults() const{ return m_maxResults; } /** *

Specifies how many values to return in a page.

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

Specifies how many values to return in a page.

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

Specifies how many values to return in a page.

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

A continuation token if this is not the first call to retrieve these * objects.

*/ inline const Aws::String& GetNextToken() const{ return m_nextToken; } /** *

A continuation token if this is not the first call to retrieve these * objects.

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

A continuation token if this is not the first call to retrieve these * objects.

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

A continuation token if this is not the first call to retrieve these * objects.

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

A continuation token if this is not the first call to retrieve these * objects.

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

A continuation token if this is not the first call to retrieve these * objects.

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

A continuation token if this is not the first call to retrieve these * objects.

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

A continuation token if this is not the first call to retrieve these * objects.

*/ inline GetTableObjectsRequest& WithNextToken(const char* value) { SetNextToken(value); return *this;} private: Aws::String m_catalogId; bool m_catalogIdHasBeenSet = false; Aws::String m_databaseName; bool m_databaseNameHasBeenSet = false; Aws::String m_tableName; bool m_tableNameHasBeenSet = false; Aws::String m_transactionId; bool m_transactionIdHasBeenSet = false; Aws::Utils::DateTime m_queryAsOfTime; bool m_queryAsOfTimeHasBeenSet = false; Aws::String m_partitionPredicate; bool m_partitionPredicateHasBeenSet = false; int m_maxResults; bool m_maxResultsHasBeenSet = false; Aws::String m_nextToken; bool m_nextTokenHasBeenSet = false; }; } // namespace Model } // namespace LakeFormation } // namespace Aws