Skip to content

Commit 074fe7e

Browse files
shubham-up-47shubham-up-47
committed
change deprecation message
1 parent 10347db commit 074fe7e

9 files changed

Lines changed: 126 additions & 55 deletions

‎google/cloud/storage/oauth2/anonymous_credentials.h‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ namespace oauth2 {
3737
* @deprecated Prefer using the unified credentials documented in @ref guac
3838
*/
3939
class GOOGLE_CLOUD_CPP_DEPRECATED(
40-
"This class will be removed shortly. "
40+
"This class will be removed in v3.0.0 and later. "
4141
"Prefer using the unified credentials "
4242
"documented in @ref guac.") AnonymousCredentials : public Credentials {
4343
public:

‎google/cloud/storage/oauth2/authorized_user_credentials.h‎

Lines changed: 15 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,10 @@ namespace oauth2 {
4545
*
4646
* @deprecated Prefer using the unified credentials documented in @ref guac
4747
*/
48-
struct AuthorizedUserCredentialsInfo {
48+
struct GOOGLE_CLOUD_CPP_DEPRECATED(
49+
"This struct will be removed in v3.0.0 and later. Prefer using the "
50+
"unified credentials documented in @ref guac.")
51+
AuthorizedUserCredentialsInfo {
4952
std::string client_id;
5053
std::string client_secret;
5154
std::string refresh_token;
@@ -60,6 +63,9 @@ struct AuthorizedUserCredentialsInfo {
6063
*
6164
* @deprecated Prefer using the unified credentials documented in @ref guac
6265
*/
66+
GOOGLE_CLOUD_CPP_DEPRECATED(
67+
"This function will be removed in v3.0.0 and later. Prefer using the "
68+
"unified credentials documented in @ref guac.")
6369
StatusOr<RefreshingCredentialsWrapper::TemporaryToken>
6470
ParseAuthorizedUserRefreshResponse(
6571
storage::internal::HttpResponse const& response,
@@ -70,6 +76,9 @@ ParseAuthorizedUserRefreshResponse(
7076
*
7177
* @deprecated Prefer using the unified credentials documented in @ref guac
7278
*/
79+
GOOGLE_CLOUD_CPP_DEPRECATED(
80+
"This function will be removed in v3.0.0 and later. Prefer using the "
81+
"unified credentials documented in @ref guac.")
7382
StatusOr<AuthorizedUserCredentialsInfo> ParseAuthorizedUserCredentials(
7483
std::string const& content, std::string const& source,
7584
std::string const& default_token_uri =
@@ -107,8 +116,8 @@ class AuthorizedUserCredentials;
107116
/// @copydoc AuthorizedUserCredentials
108117
template <>
109118
class GOOGLE_CLOUD_CPP_DEPRECATED(
110-
"This class will be removed shortly. Prefer using the unified credentials "
111-
"documented in @ref guac.")
119+
"This class will be removed in v3.0.0 and later. Prefer using the "
120+
"unified credentials documented in @ref guac.")
112121
AuthorizedUserCredentials<storage::internal::CurlRequestBuilder,
113122
std::chrono::system_clock> : public Credentials {
114123
public:
@@ -141,8 +150,9 @@ class GOOGLE_CLOUD_CPP_DEPRECATED(
141150
/// @copydoc AuthorizedUserCredentials
142151
template <typename HttpRequestBuilderType, typename ClockType>
143152
class GOOGLE_CLOUD_CPP_DEPRECATED(
144-
"This class will be removed shortly. Prefer using the unified credentials "
145-
"documented in @ref guac.") AuthorizedUserCredentials : public Credentials {
153+
"This class will be removed in v3.0.0 and later. Prefer using the "
154+
"unified credentials documented in @ref guac.") AuthorizedUserCredentials
155+
: public Credentials {
146156
public:
147157
explicit AuthorizedUserCredentials(AuthorizedUserCredentialsInfo info,
148158
ChannelOptions const& channel_options = {})

‎google/cloud/storage/oauth2/compute_engine_credentials.h‎

Lines changed: 14 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,9 @@ namespace oauth2 {
4747
*
4848
* @deprecated Prefer using the unified credentials documented in @ref guac
4949
*/
50-
struct ServiceAccountMetadata {
50+
struct GOOGLE_CLOUD_CPP_DEPRECATED(
51+
"This struct will be removed in v3.0.0 and later. Prefer using the "
52+
"unified credentials documented in @ref guac.") ServiceAccountMetadata {
5153
std::set<std::string> scopes;
5254
std::string email;
5355
};
@@ -57,6 +59,9 @@ struct ServiceAccountMetadata {
5759
*
5860
* @deprecated Prefer using the unified credentials documented in @ref guac
5961
*/
62+
GOOGLE_CLOUD_CPP_DEPRECATED(
63+
"This function will be removed in v3.0.0 and later. Prefer using the "
64+
"unified credentials documented in @ref guac.")
6065
StatusOr<ServiceAccountMetadata> ParseMetadataServerResponse(
6166
storage::internal::HttpResponse const& response);
6267

@@ -67,6 +72,9 @@ StatusOr<ServiceAccountMetadata> ParseMetadataServerResponse(
6772
*
6873
* @deprecated Prefer using the unified credentials documented in @ref guac
6974
*/
75+
GOOGLE_CLOUD_CPP_DEPRECATED(
76+
"This function will be removed in v3.0.0 and later. Prefer using the "
77+
"unified credentials documented in @ref guac.")
7078
StatusOr<RefreshingCredentialsWrapper::TemporaryToken>
7179
ParseComputeEngineRefreshResponse(
7280
storage::internal::HttpResponse const& response,
@@ -105,8 +113,8 @@ class ComputeEngineCredentials;
105113
/// @copydoc ComputeEngineCredentials
106114
template <>
107115
class GOOGLE_CLOUD_CPP_DEPRECATED(
108-
"This class will be removed shortly. Prefer using the unified credentials "
109-
"documented in @ref guac.")
116+
"This class will be removed in v3.0.0 and later. Prefer using the "
117+
"unified credentials documented in @ref guac.")
110118
ComputeEngineCredentials<storage::internal::CurlRequestBuilder,
111119
std::chrono::system_clock> : public Credentials {
112120
public:
@@ -156,8 +164,9 @@ class GOOGLE_CLOUD_CPP_DEPRECATED(
156164
/// @copydoc ComputeEngineCredentials
157165
template <typename HttpRequestBuilderType, typename ClockType>
158166
class GOOGLE_CLOUD_CPP_DEPRECATED(
159-
"This class will be removed shortly. Prefer using the unified credentials "
160-
"documented in @ref guac.") ComputeEngineCredentials : public Credentials {
167+
"This class will be removed in v3.0.0 and later. Prefer using the "
168+
"unified credentials documented in @ref guac.") ComputeEngineCredentials
169+
: public Credentials {
161170
public:
162171
explicit ComputeEngineCredentials() : ComputeEngineCredentials("default") {}
163172

‎google/cloud/storage/oauth2/credential_constants.h‎

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -33,8 +33,8 @@ namespace oauth2 {
3333
* @deprecated Prefer using the unified credentials documented in @ref guac
3434
*/
3535
enum class GOOGLE_CLOUD_CPP_DEPRECATED(
36-
"This enum will be removed shortly. Prefer using the unified credentials "
37-
"documented in @ref guac.") JwtSigningAlgorithms {
36+
"This enum will be removed in v3.0.0 and later. Prefer using the unified "
37+
"credentials documented in @ref guac.") JwtSigningAlgorithms {
3838
// NOLINTNEXTLINE(readability-identifier-naming)
3939
RS256
4040
};
@@ -45,7 +45,8 @@ enum class GOOGLE_CLOUD_CPP_DEPRECATED(
4545
* @deprecated Prefer using the unified credentials documented in @ref guac
4646
*/
4747
GOOGLE_CLOUD_CPP_DEPRECATED(
48-
"This constant will be removed shortly. Prefer using the unified "
48+
"This constant will be removed in v3.0.0 and later. Prefer using the "
49+
"unified "
4950
"credentials documented in @ref guac.")
5051
constexpr std::chrono::seconds GoogleOAuthAccessTokenLifetime() {
5152
return std::chrono::seconds(3600);
@@ -63,7 +64,8 @@ constexpr std::chrono::seconds GoogleOAuthAccessTokenLifetime() {
6364
* @deprecated Prefer using the unified credentials documented in @ref guac
6465
*/
6566
GOOGLE_CLOUD_CPP_DEPRECATED(
66-
"This constant will be removed shortly. Prefer using the unified "
67+
"This constant will be removed in v3.0.0 and later. Prefer using the "
68+
"unified "
6769
"credentials documented in @ref guac.")
6870
constexpr std::chrono::seconds GoogleOAuthAccessTokenExpirationSlack() {
6971
return std::chrono::seconds(300);
@@ -75,7 +77,8 @@ constexpr std::chrono::seconds GoogleOAuthAccessTokenExpirationSlack() {
7577
* @deprecated Prefer using the unified credentials documented in @ref guac
7678
*/
7779
GOOGLE_CLOUD_CPP_DEPRECATED(
78-
"This constant will be removed shortly. Prefer using the unified "
80+
"This constant will be removed in v3.0.0 and later. Prefer using the "
81+
"unified "
7982
"credentials documented in @ref guac.")
8083
inline char const* GoogleOAuthRefreshEndpoint() {
8184
static constexpr char kEndpoint[] = "https://oauth2.googleapis.com/token";
@@ -88,7 +91,8 @@ inline char const* GoogleOAuthRefreshEndpoint() {
8891
* @deprecated Prefer using the unified credentials documented in @ref guac
8992
*/
9093
GOOGLE_CLOUD_CPP_DEPRECATED(
91-
"This constant will be removed shortly. Prefer using the unified "
94+
"This constant will be removed in v3.0.0 and later. Prefer using the "
95+
"unified "
9296
"credentials documented in @ref guac.")
9397
inline char const* GoogleOAuthScopeCloudPlatform() {
9498
static constexpr char kScope[] =

‎google/cloud/storage/oauth2/credentials.h‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -45,8 +45,8 @@ namespace oauth2 {
4545
* @deprecated Prefer using the unified credentials documented in @ref guac
4646
*/
4747
class GOOGLE_CLOUD_CPP_DEPRECATED(
48-
"This class will be removed shortly. Prefer using the unified credentials "
49-
"documented in @ref guac.") Credentials {
48+
"This class will be removed in v3.0.0 and later. Prefer using the "
49+
"unified credentials documented in @ref guac.") Credentials {
5050
public:
5151
virtual ~Credentials() = default;
5252

‎google/cloud/storage/oauth2/google_application_default_credentials_file.h‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -33,8 +33,8 @@ namespace oauth2 {
3333
* @deprecated Prefer using the unified credentials documented in @ref guac
3434
*/
3535
GOOGLE_CLOUD_CPP_DEPRECATED(
36-
"This function will be removed shortly. Prefer using the unified "
37-
"credentials documented in @ref guac.")
36+
"This function will be removed in v3.0.0 and later. Prefer using the "
37+
"unified credentials documented in @ref guac.")
3838
char const* GoogleAdcEnvVar();
3939

4040
/**
@@ -47,8 +47,8 @@ char const* GoogleAdcEnvVar();
4747
* @deprecated Prefer using the unified credentials documented in @ref guac
4848
*/
4949
GOOGLE_CLOUD_CPP_DEPRECATED(
50-
"This function will be removed shortly. Prefer using the unified "
51-
"credentials documented in @ref guac.")
50+
"This function will be removed in v3.0.0 and later. Prefer using the "
51+
"unified credentials documented in @ref guac.")
5252
std::string GoogleAdcFilePathFromEnvVarOrEmpty();
5353

5454
/**
@@ -61,8 +61,8 @@ std::string GoogleAdcFilePathFromEnvVarOrEmpty();
6161
* @deprecated Prefer using the unified credentials documented in @ref guac
6262
*/
6363
GOOGLE_CLOUD_CPP_DEPRECATED(
64-
"This function will be removed shortly. Prefer using the unified "
65-
"credentials documented in @ref guac.")
64+
"This function will be removed in v3.0.0 and later. Prefer using the "
65+
"unified credentials documented in @ref guac.")
6666
std::string GoogleAdcFilePathFromWellKnownPathOrEmpty();
6767

6868
/**
@@ -74,8 +74,8 @@ std::string GoogleAdcFilePathFromWellKnownPathOrEmpty();
7474
* @deprecated Prefer using the unified credentials documented in @ref guac
7575
*/
7676
GOOGLE_CLOUD_CPP_DEPRECATED(
77-
"This function will be removed shortly. Prefer using the unified "
78-
"credentials documented in @ref guac.")
77+
"This function will be removed in v3.0.0 and later. Prefer using the "
78+
"unified credentials documented in @ref guac.")
7979
char const* GoogleGcloudAdcFileEnvVar();
8080

8181
/**
@@ -89,8 +89,8 @@ char const* GoogleGcloudAdcFileEnvVar();
8989
* @deprecated Prefer using the unified credentials documented in @ref guac
9090
*/
9191
GOOGLE_CLOUD_CPP_DEPRECATED(
92-
"This function will be removed shortly. Prefer using the unified "
93-
"credentials documented in @ref guac.")
92+
"This function will be removed in v3.0.0 and later. Prefer using the "
93+
"unified credentials documented in @ref guac.")
9494
char const* GoogleAdcHomeEnvVar();
9595

9696
} // namespace oauth2

‎google/cloud/storage/oauth2/google_credentials.h‎

Lines changed: 32 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,8 @@ namespace oauth2 {
4545
* @deprecated Prefer using the unified credentials documented in @ref guac
4646
*/
4747
GOOGLE_CLOUD_CPP_DEPRECATED(
48-
"This function will be removed. Prefer using the unified credentials "
48+
"This function will be removed in v3.0.0 and later. Prefer using the "
49+
"unified credentials "
4950
"documented in @ref guac.")
5051
StatusOr<std::shared_ptr<Credentials>> GoogleDefaultCredentials(
5152
ChannelOptions const& options = {});
@@ -63,7 +64,8 @@ StatusOr<std::shared_ptr<Credentials>> GoogleDefaultCredentials(
6364
* @deprecated Prefer using the unified credentials documented in @ref guac
6465
*/
6566
GOOGLE_CLOUD_CPP_DEPRECATED(
66-
"This function will be removed. Prefer using the unified credentials "
67+
"This function will be removed in v3.0.0 and later. Prefer using the "
68+
"unified credentials "
6769
"documented in @ref guac.")
6870
std::shared_ptr<Credentials> CreateAnonymousCredentials();
6971

@@ -76,7 +78,8 @@ std::shared_ptr<Credentials> CreateAnonymousCredentials();
7678
* @deprecated Prefer using the unified credentials documented in @ref guac
7779
*/
7880
GOOGLE_CLOUD_CPP_DEPRECATED(
79-
"This function will be removed. Prefer using the unified credentials "
81+
"This function will be removed in v3.0.0 and later. Prefer using the "
82+
"unified credentials "
8083
"documented in @ref guac.")
8184
StatusOr<std::shared_ptr<Credentials>>
8285
CreateAuthorizedUserCredentialsFromJsonFilePath(std::string const& path);
@@ -90,7 +93,8 @@ CreateAuthorizedUserCredentialsFromJsonFilePath(std::string const& path);
9093
* @deprecated Prefer using the unified credentials documented in @ref guac
9194
*/
9295
GOOGLE_CLOUD_CPP_DEPRECATED(
93-
"This function will be removed. Prefer using the unified credentials "
96+
"This function will be removed in v3.0.0 and later. Prefer using the "
97+
"unified credentials "
9498
"documented in @ref guac.")
9599
StatusOr<std::shared_ptr<Credentials>>
96100
CreateAuthorizedUserCredentialsFromJsonContents(
@@ -118,7 +122,8 @@ CreateAuthorizedUserCredentialsFromJsonContents(
118122
* @deprecated Prefer using the unified credentials documented in @ref guac
119123
*/
120124
GOOGLE_CLOUD_CPP_DEPRECATED(
121-
"This function will be removed. Prefer using the unified credentials "
125+
"This function will be removed in v3.0.0 and later. Prefer using the "
126+
"unified credentials "
122127
"documented in @ref guac.")
123128
StatusOr<std::shared_ptr<Credentials>>
124129
CreateServiceAccountCredentialsFromFilePath(std::string const& path);
@@ -148,7 +153,8 @@ CreateServiceAccountCredentialsFromFilePath(std::string const& path);
148153
* @deprecated Prefer using the unified credentials documented in @ref guac
149154
*/
150155
GOOGLE_CLOUD_CPP_DEPRECATED(
151-
"This function will be removed. Prefer using the unified credentials "
156+
"This function will be removed in v3.0.0 and later. Prefer using the "
157+
"unified credentials "
152158
"documented in @ref guac.")
153159
StatusOr<std::shared_ptr<Credentials>>
154160
CreateServiceAccountCredentialsFromFilePath(
@@ -165,7 +171,8 @@ CreateServiceAccountCredentialsFromFilePath(
165171
* @deprecated Prefer using the unified credentials documented in @ref guac
166172
*/
167173
GOOGLE_CLOUD_CPP_DEPRECATED(
168-
"This function will be removed. Prefer using the unified credentials "
174+
"This function will be removed in v3.0.0 and later. Prefer using the "
175+
"unified credentials "
169176
"documented in @ref guac.")
170177
StatusOr<std::shared_ptr<Credentials>>
171178
CreateServiceAccountCredentialsFromJsonFilePath(std::string const& path);
@@ -192,7 +199,8 @@ CreateServiceAccountCredentialsFromJsonFilePath(std::string const& path);
192199
* @deprecated Prefer using the unified credentials documented in @ref guac
193200
*/
194201
GOOGLE_CLOUD_CPP_DEPRECATED(
195-
"This function will be removed. Prefer using the unified credentials "
202+
"This function will be removed in v3.0.0 and later. Prefer using the "
203+
"unified credentials "
196204
"documented in @ref guac.")
197205
StatusOr<std::shared_ptr<Credentials>>
198206
CreateServiceAccountCredentialsFromJsonFilePath(
@@ -209,7 +217,8 @@ CreateServiceAccountCredentialsFromJsonFilePath(
209217
* @deprecated Prefer using the unified credentials documented in @ref guac
210218
*/
211219
GOOGLE_CLOUD_CPP_DEPRECATED(
212-
"This function will be removed. Prefer using the unified credentials "
220+
"This function will be removed in v3.0.0 and later. Prefer using the "
221+
"unified credentials "
213222
"documented in @ref guac.")
214223
StatusOr<std::shared_ptr<Credentials>>
215224
CreateServiceAccountCredentialsFromP12FilePath(std::string const& path);
@@ -236,7 +245,8 @@ CreateServiceAccountCredentialsFromP12FilePath(std::string const& path);
236245
* @deprecated Prefer using the unified credentials documented in @ref guac
237246
*/
238247
GOOGLE_CLOUD_CPP_DEPRECATED(
239-
"This function will be removed. Prefer using the unified credentials "
248+
"This function will be removed in v3.0.0 and later. Prefer using the "
249+
"unified credentials "
240250
"documented in @ref guac.")
241251
StatusOr<std::shared_ptr<Credentials>>
242252
CreateServiceAccountCredentialsFromP12FilePath(
@@ -262,7 +272,8 @@ CreateServiceAccountCredentialsFromP12FilePath(
262272
* @deprecated Prefer using the unified credentials documented in @ref guac
263273
*/
264274
GOOGLE_CLOUD_CPP_DEPRECATED(
265-
"This function will be removed. Prefer using the unified credentials "
275+
"This function will be removed in v3.0.0 and later. Prefer using the "
276+
"unified credentials "
266277
"documented in @ref guac.")
267278
StatusOr<std::shared_ptr<Credentials>>
268279
CreateServiceAccountCredentialsFromDefaultPaths(
@@ -295,7 +306,8 @@ CreateServiceAccountCredentialsFromDefaultPaths(
295306
* @deprecated Prefer using the unified credentials documented in @ref guac
296307
*/
297308
GOOGLE_CLOUD_CPP_DEPRECATED(
298-
"This function will be removed. Prefer using the unified credentials "
309+
"This function will be removed in v3.0.0 and later. Prefer using the "
310+
"unified credentials "
299311
"documented in @ref guac.")
300312
StatusOr<std::shared_ptr<Credentials>>
301313
CreateServiceAccountCredentialsFromDefaultPaths(
@@ -312,7 +324,8 @@ CreateServiceAccountCredentialsFromDefaultPaths(
312324
* @deprecated Prefer using the unified credentials documented in @ref guac
313325
*/
314326
GOOGLE_CLOUD_CPP_DEPRECATED(
315-
"This function will be removed. Prefer using the unified credentials "
327+
"This function will be removed in v3.0.0 and later. Prefer using the "
328+
"unified credentials "
316329
"documented in @ref guac.")
317330
StatusOr<std::shared_ptr<Credentials>>
318331
CreateServiceAccountCredentialsFromJsonContents(
@@ -341,7 +354,8 @@ CreateServiceAccountCredentialsFromJsonContents(
341354
* @deprecated Prefer using the unified credentials documented in @ref guac
342355
*/
343356
GOOGLE_CLOUD_CPP_DEPRECATED(
344-
"This function will be removed. Prefer using the unified credentials "
357+
"This function will be removed in v3.0.0 and later. Prefer using the "
358+
"unified credentials "
345359
"documented in @ref guac.")
346360
StatusOr<std::shared_ptr<Credentials>>
347361
CreateServiceAccountCredentialsFromJsonContents(
@@ -354,7 +368,8 @@ CreateServiceAccountCredentialsFromJsonContents(
354368
* @deprecated Prefer using the unified credentials documented in @ref guac
355369
*/
356370
GOOGLE_CLOUD_CPP_DEPRECATED(
357-
"This function will be removed. Prefer using the unified credentials "
371+
"This function will be removed in v3.0.0 and later. Prefer using the "
372+
"unified credentials "
358373
"documented in @ref guac.")
359374
std::shared_ptr<Credentials> CreateComputeEngineCredentials();
360375

@@ -364,7 +379,8 @@ std::shared_ptr<Credentials> CreateComputeEngineCredentials();
364379
* @deprecated Prefer using the unified credentials documented in @ref guac
365380
*/
366381
GOOGLE_CLOUD_CPP_DEPRECATED(
367-
"This function will be removed. Prefer using the unified credentials "
382+
"This function will be removed in v3.0.0 and later. Prefer using the "
383+
"unified credentials "
368384
"documented in @ref guac.")
369385
std::shared_ptr<Credentials> CreateComputeEngineCredentials(
370386
std::string const& service_account_email);

0 commit comments

Comments
 (0)