github/azure-sdk-for-cpp
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

Removed ServiceVersion type, replaced with ApiVersion field in the TableClientOptions type. (#6136)

Browse Source 
* Removed ServiceVersion type, replaced with ApiVersion field in the TableClientOptions type.

* Reword CL a bit.

* Fix typo

* Fix usage of ApiVersion in source.
This commit is contained in:
Ahson Khan 2024-10-29 10:01:19 -07:00 committed by GitHub
parent 22c997d36a
commit 0144780b18
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
3 changed files with 14 additions and 69 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
sdk/tables/azure-data-tables/CHANGELOG.md
View File

@ -6,6 +6,8 @@
### Breaking Changes
- Removed ServiceVersion type and changed the ApiVersion field within `TableClientOptions` to be std::string.
### Bugs Fixed
- Use the package version for telemetry, rather than api version.

48
sdk/tables/azure-data-tables/inc/azure/data/tables/tables_clients.hpp
View File

@ -38,10 +38,6 @@ namespace Azure { namespace Data { namespace Test {
namespace Azure { namespace Data { namespace Tables {
namespace _detail {
/**
* The version used for the operations to Tables services.
*/
constexpr static const char* ApiVersion = "2019-02-02";
/**
* The package name of the SDK.
*/
@ -74,48 +70,6 @@ namespace Azure { namespace Data { namespace Tables {
constexpr static const char* ODataError = "odata.error";
} // namespace _detail
/**
* @brief API version for Tables service.
*/
class ServiceVersion final {
public:
/**
* @brief Construct a new Service Version object
*
* @param version The string version for Tables Service.
*/
explicit ServiceVersion(std::string version) : m_version{std::move(version)} {}
/**
* @brief Enable comparing between two versions.
*
* @param other Another service version to be compared.
*/
bool operator==(const ServiceVersion& other) const { return m_version == other.m_version; }
/**
* @brief Enable comparing between two versions.
*
* @param other Another service version to be compared.
*/
bool operator!=(const ServiceVersion& other) const { return !(*this == other); }
/**
* @brief Returns string representation.
*
*/
std::string const& ToString() const { return m_version; }
/**
* @brief API version 2019-12-12.
*
*/
AZ_DATA_TABLES_DLLEXPORT const static ServiceVersion V2019_02_02;
private:
std::string m_version;
};
/**
* @brief Audiences available for Blobs
*
@ -145,7 +99,7 @@ namespace Azure { namespace Data { namespace Tables {
/**
* API version used by this client.
*/
ServiceVersion ApiVersion{_detail::ApiVersion};
std::string ApiVersion{"2019-02-02"};
/**
* Enables tenant discovery through the authorization challenge when the client is configured to

33
sdk/tables/azure-data-tables/src/tables_clients.cpp
View File

@ -25,8 +25,7 @@ TableServiceClient::TableServiceClient(const TableClientOptions& options)
std::vector<std::unique_ptr<Azure::Core::Http::Policies::HttpPolicy>> perRetryPolicies;
std::vector<std::unique_ptr<Azure::Core::Http::Policies::HttpPolicy>> perOperationPolicies;
perRetryPolicies.emplace_back(std::make_unique<TimeoutPolicy>());
perOperationPolicies.emplace_back(
std::make_unique<ServiceVersionPolicy>(newOptions.ApiVersion.ToString()));
perOperationPolicies.emplace_back(std::make_unique<ServiceVersionPolicy>(newOptions.ApiVersion));
m_pipeline = std::make_shared<Azure::Core::Http::_internal::HttpPipeline>(
newOptions,
_detail::TablesServicePackageName,
@ -43,8 +42,7 @@ TableServiceClient::TableServiceClient(
std::vector<std::unique_ptr<Azure::Core::Http::Policies::HttpPolicy>> perRetryPolicies;
std::vector<std::unique_ptr<Azure::Core::Http::Policies::HttpPolicy>> perOperationPolicies;
perRetryPolicies.emplace_back(std::make_unique<TimeoutPolicy>());
perOperationPolicies.emplace_back(
std::make_unique<ServiceVersionPolicy>(options.ApiVersion.ToString()));
perOperationPolicies.emplace_back(std::make_unique<ServiceVersionPolicy>(options.ApiVersion));
m_pipeline = std::make_shared<Azure::Core::Http::_internal::HttpPipeline>(
options,
_detail::TablesServicePackageName,
@ -66,8 +64,7 @@ TableServiceClient::TableServiceClient(
std::vector<std::unique_ptr<Azure::Core::Http::Policies::HttpPolicy>> perRetryPolicies;
std::vector<std::unique_ptr<Azure::Core::Http::Policies::HttpPolicy>> perOperationPolicies;
perRetryPolicies.emplace_back(std::make_unique<TimeoutPolicy>());
perOperationPolicies.emplace_back(
std::make_unique<ServiceVersionPolicy>(options.ApiVersion.ToString()));
perOperationPolicies.emplace_back(std::make_unique<ServiceVersionPolicy>(options.ApiVersion));
perRetryPolicies.emplace_back(std::make_unique<TimeoutPolicy>());
{
@ -79,8 +76,7 @@ TableServiceClient::TableServiceClient(
perRetryPolicies.emplace_back(std::make_unique<TenantBearerTokenAuthenticationPolicy>(
credential, tokenContext, newOptions.EnableTenantDiscovery));
}
perOperationPolicies.emplace_back(
std::make_unique<ServiceVersionPolicy>(newOptions.ApiVersion.ToString()));
perOperationPolicies.emplace_back(std::make_unique<ServiceVersionPolicy>(newOptions.ApiVersion));
m_pipeline = std::make_shared<Azure::Core::Http::_internal::HttpPipeline>(
newOptions,
_detail::TablesServicePackageName,
@ -99,8 +95,7 @@ TableServiceClient::TableServiceClient(
std::vector<std::unique_ptr<Azure::Core::Http::Policies::HttpPolicy>> perRetryPolicies;
std::vector<std::unique_ptr<Azure::Core::Http::Policies::HttpPolicy>> perOperationPolicies;
perRetryPolicies.emplace_back(std::make_unique<TimeoutPolicy>());
perOperationPolicies.emplace_back(
std::make_unique<ServiceVersionPolicy>(options.ApiVersion.ToString()));
perOperationPolicies.emplace_back(std::make_unique<ServiceVersionPolicy>(options.ApiVersion));
m_pipeline = std::make_shared<Azure::Core::Http::_internal::HttpPipeline>(
options,
_detail::TablesServicePackageName,
@ -115,8 +110,7 @@ TableServiceClient::TableServiceClient(
std::vector<std::unique_ptr<Azure::Core::Http::Policies::HttpPolicy>> perRetryPolicies2;
std::vector<std::unique_ptr<Azure::Core::Http::Policies::HttpPolicy>> perOperationPolicies2;
perRetryPolicies2.emplace_back(std::make_unique<TimeoutPolicy>());
perOperationPolicies2.emplace_back(
std::make_unique<ServiceVersionPolicy>(newOptions.ApiVersion.ToString()));
perOperationPolicies2.emplace_back(std::make_unique<ServiceVersionPolicy>(newOptions.ApiVersion));
m_pipeline = std::make_shared<Azure::Core::Http::_internal::HttpPipeline>(
newOptions,
_detail::TablesServicePackageName,
@ -332,8 +326,7 @@ TableClient::TableClient(
std::vector<std::unique_ptr<Azure::Core::Http::Policies::HttpPolicy>> perRetryPolicies;
std::vector<std::unique_ptr<Azure::Core::Http::Policies::HttpPolicy>> perOperationPolicies;
perRetryPolicies.emplace_back(std::make_unique<TimeoutPolicy>());
perOperationPolicies.emplace_back(
std::make_unique<ServiceVersionPolicy>(options.ApiVersion.ToString()));
perOperationPolicies.emplace_back(std::make_unique<ServiceVersionPolicy>(options.ApiVersion));
m_pipeline = std::make_shared<Azure::Core::Http::_internal::HttpPipeline>(
options,
_detail::TablesServicePackageName,
@ -355,8 +348,7 @@ TableClient::TableClient(
std::vector<std::unique_ptr<Azure::Core::Http::Policies::HttpPolicy>> perRetryPolicies;
std::vector<std::unique_ptr<Azure::Core::Http::Policies::HttpPolicy>> perOperationPolicies;
perRetryPolicies.emplace_back(std::make_unique<TimeoutPolicy>());
perOperationPolicies.emplace_back(
std::make_unique<ServiceVersionPolicy>(options.ApiVersion.ToString()));
perOperationPolicies.emplace_back(std::make_unique<ServiceVersionPolicy>(options.ApiVersion));
perRetryPolicies.emplace_back(std::make_unique<TimeoutPolicy>());
{
@ -368,8 +360,7 @@ TableClient::TableClient(
perRetryPolicies.emplace_back(std::make_unique<TenantBearerTokenAuthenticationPolicy>(
credential, tokenContext, newOptions.EnableTenantDiscovery));
}
perOperationPolicies.emplace_back(
std::make_unique<ServiceVersionPolicy>(newOptions.ApiVersion.ToString()));
perOperationPolicies.emplace_back(std::make_unique<ServiceVersionPolicy>(newOptions.ApiVersion));
m_pipeline = std::make_shared<Azure::Core::Http::_internal::HttpPipeline>(
newOptions,
_detail::TablesServicePackageName,
@ -389,8 +380,7 @@ TableClient::TableClient(
std::vector<std::unique_ptr<Azure::Core::Http::Policies::HttpPolicy>> perRetryPolicies;
std::vector<std::unique_ptr<Azure::Core::Http::Policies::HttpPolicy>> perOperationPolicies;
perRetryPolicies.emplace_back(std::make_unique<TimeoutPolicy>());
perOperationPolicies.emplace_back(
std::make_unique<ServiceVersionPolicy>(options.ApiVersion.ToString()));
perOperationPolicies.emplace_back(std::make_unique<ServiceVersionPolicy>(options.ApiVersion));
m_pipeline = std::make_shared<Azure::Core::Http::_internal::HttpPipeline>(
options,
_detail::TablesServicePackageName,
@ -405,8 +395,7 @@ TableClient::TableClient(
std::vector<std::unique_ptr<Azure::Core::Http::Policies::HttpPolicy>> perRetryPolicies2;
std::vector<std::unique_ptr<Azure::Core::Http::Policies::HttpPolicy>> perOperationPolicies2;
perRetryPolicies2.emplace_back(std::make_unique<TimeoutPolicy>());
perOperationPolicies2.emplace_back(
std::make_unique<ServiceVersionPolicy>(newOptions.ApiVersion.ToString()));
perOperationPolicies2.emplace_back(std::make_unique<ServiceVersionPolicy>(newOptions.ApiVersion));
m_pipeline = std::make_shared<Azure::Core::Http::_internal::HttpPipeline>(
newOptions,
_detail::TablesServicePackageName,