/** * 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 Utils { namespace Json { class JsonValue; class JsonView; } // namespace Json } // namespace Utils namespace LakeFormation { namespace Model { /** *

A structure containing information about the query plan.

See * Also:

AWS * API Reference

*/ class QueryPlanningContext { public: AWS_LAKEFORMATION_API QueryPlanningContext(); AWS_LAKEFORMATION_API QueryPlanningContext(Aws::Utils::Json::JsonView jsonValue); AWS_LAKEFORMATION_API QueryPlanningContext& operator=(Aws::Utils::Json::JsonView jsonValue); AWS_LAKEFORMATION_API Aws::Utils::Json::JsonValue Jsonize() const; /** *

The ID of the Data Catalog where the partition in question resides. If none * is provided, the Amazon Web Services account ID is used by default.

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

The ID of the Data Catalog where the partition in question resides. If none * is provided, the Amazon Web Services account ID is used by default.

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

The ID of the Data Catalog where the partition in question resides. If none * is provided, the Amazon Web Services account ID is used by default.

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

The ID of the Data Catalog where the partition in question resides. If none * is provided, the Amazon Web Services account ID is used by default.

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

The ID of the Data Catalog where the partition in question resides. If none * is provided, the Amazon Web Services account ID is used by default.

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

The ID of the Data Catalog where the partition in question resides. If none * is provided, the Amazon Web Services account ID is used by default.

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

The ID of the Data Catalog where the partition in question resides. If none * is provided, the Amazon Web Services account ID is used by default.

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

The ID of the Data Catalog where the partition in question resides. If none * is provided, the Amazon Web Services account ID is used by default.

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

The database containing the table.

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

The database containing the table.

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

The database containing the table.

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

The database containing the table.

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

The database containing the table.

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

The database containing the table.

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

The database containing the table.

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

The database containing the table.

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

The time as of when to read the table contents. If not set, the most recent * transaction commit time will be 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 table contents. If not set, the most recent * transaction commit time will be used. Cannot be specified along with * TransactionId.

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

The time as of when to read the table contents. If not set, the most recent * transaction commit time will be 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 table contents. If not set, the most recent * transaction commit time will be 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 table contents. If not set, the most recent * transaction commit time will be used. Cannot be specified along with * TransactionId.

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

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

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

A map consisting of key-value pairs.

*/ inline const Aws::Map& GetQueryParameters() const{ return m_queryParameters; } /** *

A map consisting of key-value pairs.

*/ inline bool QueryParametersHasBeenSet() const { return m_queryParametersHasBeenSet; } /** *

A map consisting of key-value pairs.

*/ inline void SetQueryParameters(const Aws::Map& value) { m_queryParametersHasBeenSet = true; m_queryParameters = value; } /** *

A map consisting of key-value pairs.

*/ inline void SetQueryParameters(Aws::Map&& value) { m_queryParametersHasBeenSet = true; m_queryParameters = std::move(value); } /** *

A map consisting of key-value pairs.

*/ inline QueryPlanningContext& WithQueryParameters(const Aws::Map& value) { SetQueryParameters(value); return *this;} /** *

A map consisting of key-value pairs.

*/ inline QueryPlanningContext& WithQueryParameters(Aws::Map&& value) { SetQueryParameters(std::move(value)); return *this;} /** *

A map consisting of key-value pairs.

*/ inline QueryPlanningContext& AddQueryParameters(const Aws::String& key, const Aws::String& value) { m_queryParametersHasBeenSet = true; m_queryParameters.emplace(key, value); return *this; } /** *

A map consisting of key-value pairs.

*/ inline QueryPlanningContext& AddQueryParameters(Aws::String&& key, const Aws::String& value) { m_queryParametersHasBeenSet = true; m_queryParameters.emplace(std::move(key), value); return *this; } /** *

A map consisting of key-value pairs.

*/ inline QueryPlanningContext& AddQueryParameters(const Aws::String& key, Aws::String&& value) { m_queryParametersHasBeenSet = true; m_queryParameters.emplace(key, std::move(value)); return *this; } /** *

A map consisting of key-value pairs.

*/ inline QueryPlanningContext& AddQueryParameters(Aws::String&& key, Aws::String&& value) { m_queryParametersHasBeenSet = true; m_queryParameters.emplace(std::move(key), std::move(value)); return *this; } /** *

A map consisting of key-value pairs.

*/ inline QueryPlanningContext& AddQueryParameters(const char* key, Aws::String&& value) { m_queryParametersHasBeenSet = true; m_queryParameters.emplace(key, std::move(value)); return *this; } /** *

A map consisting of key-value pairs.

*/ inline QueryPlanningContext& AddQueryParameters(Aws::String&& key, const char* value) { m_queryParametersHasBeenSet = true; m_queryParameters.emplace(std::move(key), value); return *this; } /** *

A map consisting of key-value pairs.

*/ inline QueryPlanningContext& AddQueryParameters(const char* key, const char* value) { m_queryParametersHasBeenSet = true; m_queryParameters.emplace(key, value); return *this; } /** *

The transaction ID at which to read the table contents. If this transaction * is not committed, the read will be treated as part of that transaction and will * see its writes. If this transaction has aborted, an error will be 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 table contents. If this transaction * is not committed, the read will be treated as part of that transaction and will * see its writes. If this transaction has aborted, an error will be 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 table contents. If this transaction * is not committed, the read will be treated as part of that transaction and will * see its writes. If this transaction has aborted, an error will be 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 table contents. If this transaction * is not committed, the read will be treated as part of that transaction and will * see its writes. If this transaction has aborted, an error will be 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 table contents. If this transaction * is not committed, the read will be treated as part of that transaction and will * see its writes. If this transaction has aborted, an error will be 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 table contents. If this transaction * is not committed, the read will be treated as part of that transaction and will * see its writes. If this transaction has aborted, an error will be returned. If * not set, defaults to the most recent committed transaction. Cannot be specified * along with QueryAsOfTime.

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

The transaction ID at which to read the table contents. If this transaction * is not committed, the read will be treated as part of that transaction and will * see its writes. If this transaction has aborted, an error will be returned. If * not set, defaults to the most recent committed transaction. Cannot be specified * along with QueryAsOfTime.

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

The transaction ID at which to read the table contents. If this transaction * is not committed, the read will be treated as part of that transaction and will * see its writes. If this transaction has aborted, an error will be returned. If * not set, defaults to the most recent committed transaction. Cannot be specified * along with QueryAsOfTime.

*/ inline QueryPlanningContext& WithTransactionId(const char* value) { SetTransactionId(value); return *this;} private: Aws::String m_catalogId; bool m_catalogIdHasBeenSet = false; Aws::String m_databaseName; bool m_databaseNameHasBeenSet = false; Aws::Utils::DateTime m_queryAsOfTime; bool m_queryAsOfTimeHasBeenSet = false; Aws::Map m_queryParameters; bool m_queryParametersHasBeenSet = false; Aws::String m_transactionId; bool m_transactionIdHasBeenSet = false; }; } // namespace Model } // namespace LakeFormation } // namespace Aws