deprecate(storage): Mark google::cloud::storage::oauth2 as deprecated (googleapis#15139)

shubham-up-47 · scotthart · commit 4e61232c1e8c · 2025-08-12T17:17:43.000-04:00
diff --git a/google/cloud/storage/oauth2/anonymous_credentials.h b/google/cloud/storage/oauth2/anonymous_credentials.h
@@ -36,7 +36,10 @@ namespace oauth2 {
  *
  * @deprecated Prefer using the unified credentials documented in @ref guac
  */
-class AnonymousCredentials : public Credentials {
+class GOOGLE_CLOUD_CPP_DEPRECATED(
+    "This class will be removed in v4.0.0 and later. "
+    "Prefer using the unified credentials "
+    "documented in @ref guac.") AnonymousCredentials : public Credentials {
  public:
   AnonymousCredentials() = default;
 
diff --git a/google/cloud/storage/oauth2/authorized_user_credentials.h b/google/cloud/storage/oauth2/authorized_user_credentials.h
@@ -45,7 +45,10 @@ namespace oauth2 {
  *
  * @deprecated Prefer using the unified credentials documented in @ref guac
  */
-struct AuthorizedUserCredentialsInfo {
+struct GOOGLE_CLOUD_CPP_DEPRECATED(
+    "This struct will be removed in v4.0.0 and later. Prefer using the "
+    "unified credentials documented in @ref guac.")
+    AuthorizedUserCredentialsInfo {
   std::string client_id;
   std::string client_secret;
   std::string refresh_token;
@@ -60,6 +63,9 @@ struct AuthorizedUserCredentialsInfo {
  *
  * @deprecated Prefer using the unified credentials documented in @ref guac
  */
+GOOGLE_CLOUD_CPP_DEPRECATED(
+    "This function will be removed in v4.0.0 and later. Prefer using the "
+    "unified credentials documented in @ref guac.")
 StatusOr<RefreshingCredentialsWrapper::TemporaryToken>
 ParseAuthorizedUserRefreshResponse(
     storage::internal::HttpResponse const& response,
@@ -70,6 +76,9 @@ ParseAuthorizedUserRefreshResponse(
  *
  * @deprecated Prefer using the unified credentials documented in @ref guac
  */
+GOOGLE_CLOUD_CPP_DEPRECATED(
+    "This function will be removed in v4.0.0 and later. Prefer using the "
+    "unified credentials documented in @ref guac.")
 StatusOr<AuthorizedUserCredentialsInfo> ParseAuthorizedUserCredentials(
     std::string const& content, std::string const& source,
     std::string const& default_token_uri =
@@ -106,9 +115,11 @@ class AuthorizedUserCredentials;
 
 /// @copydoc AuthorizedUserCredentials
 template <>
-class AuthorizedUserCredentials<storage::internal::CurlRequestBuilder,
-                                std::chrono::system_clock>
-    : public Credentials {
+class GOOGLE_CLOUD_CPP_DEPRECATED(
+    "This class will be removed in v4.0.0 and later. Prefer using the "
+    "unified credentials documented in @ref guac.")
+    AuthorizedUserCredentials<storage::internal::CurlRequestBuilder,
+                              std::chrono::system_clock> : public Credentials {
  public:
   explicit AuthorizedUserCredentials(
       AuthorizedUserCredentialsInfo const& info,
@@ -138,7 +149,10 @@ class AuthorizedUserCredentials<storage::internal::CurlRequestBuilder,
 
 /// @copydoc AuthorizedUserCredentials
 template <typename HttpRequestBuilderType, typename ClockType>
-class AuthorizedUserCredentials : public Credentials {
+class GOOGLE_CLOUD_CPP_DEPRECATED(
+    "This class will be removed in v4.0.0 and later. Prefer using the "
+    "unified credentials documented in @ref guac.") AuthorizedUserCredentials
+    : public Credentials {
  public:
   explicit AuthorizedUserCredentials(AuthorizedUserCredentialsInfo info,
                                      ChannelOptions const& channel_options = {})
diff --git a/google/cloud/storage/oauth2/compute_engine_credentials.h b/google/cloud/storage/oauth2/compute_engine_credentials.h
@@ -47,7 +47,9 @@ namespace oauth2 {
  *
  * @deprecated Prefer using the unified credentials documented in @ref guac
  */
-struct ServiceAccountMetadata {
+struct GOOGLE_CLOUD_CPP_DEPRECATED(
+    "This struct will be removed in v4.0.0 and later. Prefer using the "
+    "unified credentials documented in @ref guac.") ServiceAccountMetadata {
   std::set<std::string> scopes;
   std::string email;
 };
@@ -57,6 +59,9 @@ struct ServiceAccountMetadata {
  *
  * @deprecated Prefer using the unified credentials documented in @ref guac
  */
+GOOGLE_CLOUD_CPP_DEPRECATED(
+    "This function will be removed in v4.0.0 and later. Prefer using the "
+    "unified credentials documented in @ref guac.")
 StatusOr<ServiceAccountMetadata> ParseMetadataServerResponse(
     storage::internal::HttpResponse const& response);
 
@@ -67,6 +72,9 @@ StatusOr<ServiceAccountMetadata> ParseMetadataServerResponse(
  *
  * @deprecated Prefer using the unified credentials documented in @ref guac
  */
+GOOGLE_CLOUD_CPP_DEPRECATED(
+    "This function will be removed in v4.0.0 and later. Prefer using the "
+    "unified credentials documented in @ref guac.")
 StatusOr<RefreshingCredentialsWrapper::TemporaryToken>
 ParseComputeEngineRefreshResponse(
     storage::internal::HttpResponse const& response,
@@ -104,8 +112,11 @@ class ComputeEngineCredentials;
 
 /// @copydoc ComputeEngineCredentials
 template <>
-class ComputeEngineCredentials<storage::internal::CurlRequestBuilder,
-                               std::chrono::system_clock> : public Credentials {
+class GOOGLE_CLOUD_CPP_DEPRECATED(
+    "This class will be removed in v4.0.0 and later. Prefer using the "
+    "unified credentials documented in @ref guac.")
+    ComputeEngineCredentials<storage::internal::CurlRequestBuilder,
+                             std::chrono::system_clock> : public Credentials {
  public:
   explicit ComputeEngineCredentials() : ComputeEngineCredentials("default") {}
   explicit ComputeEngineCredentials(std::string service_account_email);
@@ -152,7 +163,10 @@ class ComputeEngineCredentials<storage::internal::CurlRequestBuilder,
 
 /// @copydoc ComputeEngineCredentials
 template <typename HttpRequestBuilderType, typename ClockType>
-class ComputeEngineCredentials : public Credentials {
+class GOOGLE_CLOUD_CPP_DEPRECATED(
+    "This class will be removed in v4.0.0 and later. Prefer using the "
+    "unified credentials documented in @ref guac.") ComputeEngineCredentials
+    : public Credentials {
  public:
   explicit ComputeEngineCredentials() : ComputeEngineCredentials("default") {}
 
diff --git a/google/cloud/storage/oauth2/credential_constants.h b/google/cloud/storage/oauth2/credential_constants.h
@@ -32,14 +32,21 @@ namespace oauth2 {
  *
  * @deprecated Prefer using the unified credentials documented in @ref guac
  */
-// NOLINTNEXTLINE(readability-identifier-naming)
-enum class JwtSigningAlgorithms { RS256 };
+enum class GOOGLE_CLOUD_CPP_DEPRECATED(
+    "This enum will be removed in v4.0.0 and later. Prefer using the unified "
+    "credentials documented in @ref guac.") JwtSigningAlgorithms {
+  // NOLINTNEXTLINE(readability-identifier-naming)
+  RS256
+};
 
 /**
  * The max lifetime in seconds of an access token.
  *
  * @deprecated Prefer using the unified credentials documented in @ref guac
  */
+GOOGLE_CLOUD_CPP_DEPRECATED(
+    "This constant will be removed in v4.0.0 and later. Prefer using the "
+    "unified credentials documented in @ref guac.")
 constexpr std::chrono::seconds GoogleOAuthAccessTokenLifetime() {
   return std::chrono::seconds(3600);
 }
@@ -55,6 +62,9 @@ constexpr std::chrono::seconds GoogleOAuthAccessTokenLifetime() {
  *
  * @deprecated Prefer using the unified credentials documented in @ref guac
  */
+GOOGLE_CLOUD_CPP_DEPRECATED(
+    "This constant will be removed in v4.0.0 and later. Prefer using the "
+    "unified credentials documented in @ref guac.")
 constexpr std::chrono::seconds GoogleOAuthAccessTokenExpirationSlack() {
   return std::chrono::seconds(300);
 }
@@ -64,6 +74,9 @@ constexpr std::chrono::seconds GoogleOAuthAccessTokenExpirationSlack() {
  *
  * @deprecated Prefer using the unified credentials documented in @ref guac
  */
+GOOGLE_CLOUD_CPP_DEPRECATED(
+    "This constant will be removed in v4.0.0 and later. Prefer using the "
+    "unified credentials documented in @ref guac.")
 inline char const* GoogleOAuthRefreshEndpoint() {
   static constexpr char kEndpoint[] = "https://oauth2.googleapis.com/token";
   return kEndpoint;
@@ -74,6 +87,9 @@ inline char const* GoogleOAuthRefreshEndpoint() {
  *
  * @deprecated Prefer using the unified credentials documented in @ref guac
  */
+GOOGLE_CLOUD_CPP_DEPRECATED(
+    "This constant will be removed in v4.0.0 and later. Prefer using the "
+    "unified credentials documented in @ref guac.")
 inline char const* GoogleOAuthScopeCloudPlatform() {
   static constexpr char kScope[] =
       "https://www.googleapis.com/auth/cloud-platform";
diff --git a/google/cloud/storage/oauth2/credentials.h b/google/cloud/storage/oauth2/credentials.h
@@ -44,7 +44,9 @@ namespace oauth2 {
  *
  * @deprecated Prefer using the unified credentials documented in @ref guac
  */
-class Credentials {
+class GOOGLE_CLOUD_CPP_DEPRECATED(
+    "This class will be removed in v4.0.0 and later. Prefer using the "
+    "unified credentials documented in @ref guac.") Credentials {
  public:
   virtual ~Credentials() = default;
 
diff --git a/google/cloud/storage/oauth2/google_application_default_credentials_file.h b/google/cloud/storage/oauth2/google_application_default_credentials_file.h
@@ -32,6 +32,9 @@ namespace oauth2 {
  *
  * @deprecated Prefer using the unified credentials documented in @ref guac
  */
+GOOGLE_CLOUD_CPP_DEPRECATED(
+    "This function will be removed in v4.0.0 and later. Prefer using the "
+    "unified credentials documented in @ref guac.")
 char const* GoogleAdcEnvVar();
 
 /**
@@ -43,6 +46,9 @@ char const* GoogleAdcEnvVar();
  *
  * @deprecated Prefer using the unified credentials documented in @ref guac
  */
+GOOGLE_CLOUD_CPP_DEPRECATED(
+    "This function will be removed in v4.0.0 and later. Prefer using the "
+    "unified credentials documented in @ref guac.")
 std::string GoogleAdcFilePathFromEnvVarOrEmpty();
 
 /**
@@ -54,6 +60,9 @@ std::string GoogleAdcFilePathFromEnvVarOrEmpty();
  *
  * @deprecated Prefer using the unified credentials documented in @ref guac
  */
+GOOGLE_CLOUD_CPP_DEPRECATED(
+    "This function will be removed in v4.0.0 and later. Prefer using the "
+    "unified credentials documented in @ref guac.")
 std::string GoogleAdcFilePathFromWellKnownPathOrEmpty();
 
 /**
@@ -64,6 +73,9 @@ std::string GoogleAdcFilePathFromWellKnownPathOrEmpty();
  *
  * @deprecated Prefer using the unified credentials documented in @ref guac
  */
+GOOGLE_CLOUD_CPP_DEPRECATED(
+    "This function will be removed in v4.0.0 and later. Prefer using the "
+    "unified credentials documented in @ref guac.")
 char const* GoogleGcloudAdcFileEnvVar();
 
 /**
@@ -76,6 +88,9 @@ char const* GoogleGcloudAdcFileEnvVar();
  *
  * @deprecated Prefer using the unified credentials documented in @ref guac
  */
+GOOGLE_CLOUD_CPP_DEPRECATED(
+    "This function will be removed in v4.0.0 and later. Prefer using the "
+    "unified credentials documented in @ref guac.")
 char const* GoogleAdcHomeEnvVar();
 
 }  // namespace oauth2
diff --git a/google/cloud/storage/oauth2/google_credentials.h b/google/cloud/storage/oauth2/google_credentials.h
diff --git a/google/cloud/storage/oauth2/refreshing_credentials_wrapper.h b/google/cloud/storage/oauth2/refreshing_credentials_wrapper.h
diff --git a/google/cloud/storage/oauth2/service_account_credentials.h b/google/cloud/storage/oauth2/service_account_credentials.h
