-
Notifications
You must be signed in to change notification settings - Fork 444
Expand file tree
/
Copy pathidempotency_policy.h
More file actions
470 lines (439 loc) · 19 KB
/
idempotency_policy.h
File metadata and controls
470 lines (439 loc) · 19 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
// Copyright 2018 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// https://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
#ifndef GOOGLE_CLOUD_CPP_GOOGLE_CLOUD_STORAGE_IDEMPOTENCY_POLICY_H
#define GOOGLE_CLOUD_CPP_GOOGLE_CLOUD_STORAGE_IDEMPOTENCY_POLICY_H
#include "google/cloud/storage/internal/bucket_acl_requests.h"
#include "google/cloud/storage/internal/bucket_requests.h"
#include "google/cloud/storage/internal/default_object_acl_requests.h"
#include "google/cloud/storage/internal/hmac_key_requests.h"
#include "google/cloud/storage/internal/notification_requests.h"
#include "google/cloud/storage/internal/object_acl_requests.h"
#include "google/cloud/storage/internal/object_requests.h"
#include "google/cloud/storage/internal/service_account_requests.h"
#include "google/cloud/storage/internal/sign_blob_requests.h"
#include "google/cloud/storage/version.h"
#include <memory>
namespace google {
namespace cloud {
namespace storage {
GOOGLE_CLOUD_CPP_INLINE_NAMESPACE_BEGIN
/**
* Define the interface for the idempotency policy.
*
* The idempotency policy controls which requests are treated as idempotent and
* therefore safe to retry on a transient failure. Non-idempotent operations can
* result in data loss. For example, consider `DeleteObject()`, if this
* operation is called without pre-conditions retrying this operation may delete
* more than one version of an object, which may not have the desired effect.
* Even operations that "add" data can result in data loss, consider
* `InsertObjectMedia()`, if called without pre-conditions retrying this
* operation will insert multiple new versions, possibly deleting old data if
* the bucket is configured to keep only N versions of each object.
*
* Some applications are designed to handle duplicate requests without data
* loss, or the library may be used in an environment where the risk of data
* loss due to duplicate requests is negligible or zero.
*
* This policy allows application developers to control the behavior of the
* library with respect to retrying non-idempotent operations. Application
* developers can configure the library to only retry operations that are known
* to be idempotent (that is, they will succeed only once). Application may also
* configure the library to retry all operations, regardless of whether the
* operations are idempotent or not.
*/
class IdempotencyPolicy {
public:
virtual ~IdempotencyPolicy() = default;
/// Create a new copy of this object.
virtual std::unique_ptr<IdempotencyPolicy> clone() const = 0;
///@{
/// @name Bucket resource operations
virtual bool IsIdempotent(
internal::ListBucketsRequest const& request) const = 0;
virtual bool IsIdempotent(
internal::CreateBucketRequest const& request) const = 0;
virtual bool IsIdempotent(
internal::GetBucketMetadataRequest const& request) const = 0;
virtual bool IsIdempotent(
internal::DeleteBucketRequest const& request) const = 0;
virtual bool IsIdempotent(
internal::UpdateBucketRequest const& request) const = 0;
virtual bool IsIdempotent(
internal::PatchBucketRequest const& request) const = 0;
virtual bool IsIdempotent(
internal::GetBucketIamPolicyRequest const& request) const = 0;
virtual bool IsIdempotent(
internal::SetNativeBucketIamPolicyRequest const& request) const = 0;
virtual bool IsIdempotent(
internal::TestBucketIamPermissionsRequest const& request) const = 0;
virtual bool IsIdempotent(
internal::LockBucketRetentionPolicyRequest const& request) const = 0;
///@}
///@{
/// @name Object resource operations
virtual bool IsIdempotent(
internal::InsertObjectMediaRequest const& request) const = 0;
virtual bool IsIdempotent(
internal::CopyObjectRequest const& request) const = 0;
virtual bool IsIdempotent(
internal::GetObjectMetadataRequest const& request) const = 0;
virtual bool IsIdempotent(
internal::ReadObjectRangeRequest const& request) const = 0;
virtual bool IsIdempotent(
internal::ListObjectsRequest const& request) const = 0;
virtual bool IsIdempotent(
internal::DeleteObjectRequest const& request) const = 0;
virtual bool IsIdempotent(
internal::UpdateObjectRequest const& request) const = 0;
virtual bool IsIdempotent(internal::MoveObjectRequest const&) const {
return false;
};
virtual bool IsIdempotent(
internal::PatchObjectRequest const& request) const = 0;
virtual bool IsIdempotent(
internal::ComposeObjectRequest const& request) const = 0;
virtual bool IsIdempotent(
internal::RewriteObjectRequest const& request) const = 0;
virtual bool IsIdempotent(internal::RestoreObjectRequest const&) const {
return false;
};
virtual bool IsIdempotent(
internal::ResumableUploadRequest const& request) const = 0;
virtual bool IsIdempotent(
internal::UploadChunkRequest const& request) const = 0;
///@}
///@{
/// @name BucketAccessControls resource operations
virtual bool IsIdempotent(
internal::ListBucketAclRequest const& request) const = 0;
virtual bool IsIdempotent(
internal::CreateBucketAclRequest const& request) const = 0;
virtual bool IsIdempotent(
internal::DeleteBucketAclRequest const& request) const = 0;
virtual bool IsIdempotent(
internal::GetBucketAclRequest const& request) const = 0;
virtual bool IsIdempotent(
internal::UpdateBucketAclRequest const& request) const = 0;
virtual bool IsIdempotent(
internal::PatchBucketAclRequest const& request) const = 0;
///@}
///@{
/// @name ObjectAccessControls operations
virtual bool IsIdempotent(
internal::ListObjectAclRequest const& request) const = 0;
virtual bool IsIdempotent(
internal::CreateObjectAclRequest const& request) const = 0;
virtual bool IsIdempotent(
internal::DeleteObjectAclRequest const& request) const = 0;
virtual bool IsIdempotent(
internal::GetObjectAclRequest const& request) const = 0;
virtual bool IsIdempotent(
internal::UpdateObjectAclRequest const& request) const = 0;
virtual bool IsIdempotent(
internal::PatchObjectAclRequest const& request) const = 0;
///@}
///@{
/// @name DefaultObjectAccessControls operations.
virtual bool IsIdempotent(
internal::ListDefaultObjectAclRequest const& request) const = 0;
virtual bool IsIdempotent(
internal::CreateDefaultObjectAclRequest const& request) const = 0;
virtual bool IsIdempotent(
internal::DeleteDefaultObjectAclRequest const& request) const = 0;
virtual bool IsIdempotent(
internal::GetDefaultObjectAclRequest const& request) const = 0;
virtual bool IsIdempotent(
internal::UpdateDefaultObjectAclRequest const& request) const = 0;
virtual bool IsIdempotent(
internal::PatchDefaultObjectAclRequest const& request) const = 0;
///@}
///@{
virtual bool IsIdempotent(
internal::GetProjectServiceAccountRequest const& request) const = 0;
virtual bool IsIdempotent(
internal::ListHmacKeysRequest const& request) const = 0;
virtual bool IsIdempotent(
internal::CreateHmacKeyRequest const& request) const = 0;
virtual bool IsIdempotent(
internal::DeleteHmacKeyRequest const& request) const = 0;
virtual bool IsIdempotent(
internal::GetHmacKeyRequest const& request) const = 0;
virtual bool IsIdempotent(
internal::UpdateHmacKeyRequest const& request) const = 0;
virtual bool IsIdempotent(internal::SignBlobRequest const& request) const = 0;
///@}
///@{
virtual bool IsIdempotent(
internal::ListNotificationsRequest const& request) const = 0;
virtual bool IsIdempotent(
internal::CreateNotificationRequest const& request) const = 0;
virtual bool IsIdempotent(
internal::GetNotificationRequest const& request) const = 0;
virtual bool IsIdempotent(
internal::DeleteNotificationRequest const& request) const = 0;
///@}
};
/**
* A IdempotencyPolicy that always retries all requests.
*/
class AlwaysRetryIdempotencyPolicy : public IdempotencyPolicy {
public:
AlwaysRetryIdempotencyPolicy() = default;
std::unique_ptr<IdempotencyPolicy> clone() const override;
///@{
/// @name Bucket resource operations
bool IsIdempotent(internal::ListBucketsRequest const& request) const override;
bool IsIdempotent(
internal::CreateBucketRequest const& request) const override;
bool IsIdempotent(
internal::GetBucketMetadataRequest const& request) const override;
bool IsIdempotent(
internal::DeleteBucketRequest const& request) const override;
bool IsIdempotent(
internal::UpdateBucketRequest const& request) const override;
bool IsIdempotent(internal::PatchBucketRequest const& request) const override;
bool IsIdempotent(
internal::GetBucketIamPolicyRequest const& request) const override;
bool IsIdempotent(
internal::SetNativeBucketIamPolicyRequest const& request) const override;
bool IsIdempotent(
internal::TestBucketIamPermissionsRequest const& request) const override;
bool IsIdempotent(
internal::LockBucketRetentionPolicyRequest const& request) const override;
///@}
///@{
/// @name Object resource operations
bool IsIdempotent(
internal::InsertObjectMediaRequest const& request) const override;
bool IsIdempotent(internal::CopyObjectRequest const& request) const override;
bool IsIdempotent(
internal::GetObjectMetadataRequest const& request) const override;
bool IsIdempotent(
internal::ReadObjectRangeRequest const& request) const override;
bool IsIdempotent(internal::ListObjectsRequest const& request) const override;
bool IsIdempotent(
internal::DeleteObjectRequest const& request) const override;
bool IsIdempotent(
internal::UpdateObjectRequest const& request) const override;
bool IsIdempotent(internal::MoveObjectRequest const& request) const override;
bool IsIdempotent(internal::PatchObjectRequest const& request) const override;
bool IsIdempotent(
internal::ComposeObjectRequest const& request) const override;
bool IsIdempotent(
internal::RewriteObjectRequest const& request) const override;
bool IsIdempotent(
internal::RestoreObjectRequest const& request) const override;
bool IsIdempotent(
internal::ResumableUploadRequest const& request) const override;
bool IsIdempotent(internal::UploadChunkRequest const& request) const override;
///@}
///@{
/// @name BucketAccessControls resource operations
bool IsIdempotent(
internal::ListBucketAclRequest const& request) const override;
bool IsIdempotent(
internal::CreateBucketAclRequest const& request) const override;
bool IsIdempotent(
internal::DeleteBucketAclRequest const& request) const override;
bool IsIdempotent(
internal::GetBucketAclRequest const& request) const override;
bool IsIdempotent(
internal::UpdateBucketAclRequest const& request) const override;
bool IsIdempotent(
internal::PatchBucketAclRequest const& request) const override;
///@}
///@{
/// @name ObjectAccessControls operations
bool IsIdempotent(
internal::ListObjectAclRequest const& request) const override;
bool IsIdempotent(
internal::CreateObjectAclRequest const& request) const override;
bool IsIdempotent(
internal::DeleteObjectAclRequest const& request) const override;
bool IsIdempotent(
internal::GetObjectAclRequest const& request) const override;
bool IsIdempotent(
internal::UpdateObjectAclRequest const& request) const override;
bool IsIdempotent(
internal::PatchObjectAclRequest const& request) const override;
///@}
///@{
/// @name DefaultObjectAccessControls operations.
bool IsIdempotent(
internal::ListDefaultObjectAclRequest const& request) const override;
bool IsIdempotent(
internal::CreateDefaultObjectAclRequest const& request) const override;
bool IsIdempotent(
internal::DeleteDefaultObjectAclRequest const& request) const override;
bool IsIdempotent(
internal::GetDefaultObjectAclRequest const& request) const override;
bool IsIdempotent(
internal::UpdateDefaultObjectAclRequest const& request) const override;
bool IsIdempotent(
internal::PatchDefaultObjectAclRequest const& request) const override;
///@}
///@{
bool IsIdempotent(
internal::GetProjectServiceAccountRequest const& request) const override;
bool IsIdempotent(
internal::ListHmacKeysRequest const& request) const override;
bool IsIdempotent(
internal::CreateHmacKeyRequest const& request) const override;
bool IsIdempotent(
internal::DeleteHmacKeyRequest const& request) const override;
bool IsIdempotent(internal::GetHmacKeyRequest const& request) const override;
bool IsIdempotent(
internal::UpdateHmacKeyRequest const& request) const override;
bool IsIdempotent(internal::SignBlobRequest const& request) const override;
///@}
///@{
bool IsIdempotent(
internal::ListNotificationsRequest const& request) const override;
bool IsIdempotent(
internal::CreateNotificationRequest const& request) const override;
bool IsIdempotent(
internal::GetNotificationRequest const& request) const override;
bool IsIdempotent(
internal::DeleteNotificationRequest const& request) const override;
///@}
};
/**
* A IdempotencyPolicy that only retries strictly idempotent requests.
*/
class StrictIdempotencyPolicy : public IdempotencyPolicy {
public:
StrictIdempotencyPolicy() = default;
std::unique_ptr<IdempotencyPolicy> clone() const override;
///@{
/// @name Bucket resource operations
bool IsIdempotent(internal::ListBucketsRequest const& request) const override;
bool IsIdempotent(
internal::CreateBucketRequest const& request) const override;
bool IsIdempotent(
internal::GetBucketMetadataRequest const& request) const override;
bool IsIdempotent(
internal::DeleteBucketRequest const& request) const override;
bool IsIdempotent(
internal::UpdateBucketRequest const& request) const override;
bool IsIdempotent(internal::PatchBucketRequest const& request) const override;
bool IsIdempotent(
internal::GetBucketIamPolicyRequest const& request) const override;
bool IsIdempotent(
internal::SetNativeBucketIamPolicyRequest const& request) const override;
bool IsIdempotent(
internal::TestBucketIamPermissionsRequest const& request) const override;
bool IsIdempotent(
internal::LockBucketRetentionPolicyRequest const& request) const override;
///@}
///@{
/// @name Object resource operations
bool IsIdempotent(
internal::InsertObjectMediaRequest const& request) const override;
bool IsIdempotent(internal::CopyObjectRequest const& request) const override;
bool IsIdempotent(
internal::GetObjectMetadataRequest const& request) const override;
bool IsIdempotent(
internal::ReadObjectRangeRequest const& request) const override;
bool IsIdempotent(internal::ListObjectsRequest const& request) const override;
bool IsIdempotent(
internal::DeleteObjectRequest const& request) const override;
bool IsIdempotent(
internal::UpdateObjectRequest const& request) const override;
bool IsIdempotent(internal::MoveObjectRequest const& request) const override;
bool IsIdempotent(internal::PatchObjectRequest const& request) const override;
bool IsIdempotent(
internal::ComposeObjectRequest const& request) const override;
bool IsIdempotent(
internal::RewriteObjectRequest const& request) const override;
bool IsIdempotent(
internal::RestoreObjectRequest const& request) const override;
bool IsIdempotent(
internal::ResumableUploadRequest const& request) const override;
bool IsIdempotent(internal::UploadChunkRequest const& request) const override;
///@}
///@{
/// @name BucketAccessControls resource operations
bool IsIdempotent(
internal::ListBucketAclRequest const& request) const override;
bool IsIdempotent(
internal::CreateBucketAclRequest const& request) const override;
bool IsIdempotent(
internal::DeleteBucketAclRequest const& request) const override;
bool IsIdempotent(
internal::GetBucketAclRequest const& request) const override;
bool IsIdempotent(
internal::UpdateBucketAclRequest const& request) const override;
bool IsIdempotent(
internal::PatchBucketAclRequest const& request) const override;
///@}
///@{
/// @name ObjectAccessControls operations
bool IsIdempotent(
internal::ListObjectAclRequest const& request) const override;
bool IsIdempotent(
internal::CreateObjectAclRequest const& request) const override;
bool IsIdempotent(
internal::DeleteObjectAclRequest const& request) const override;
bool IsIdempotent(
internal::GetObjectAclRequest const& request) const override;
bool IsIdempotent(
internal::UpdateObjectAclRequest const& request) const override;
bool IsIdempotent(
internal::PatchObjectAclRequest const& request) const override;
///@}
///@{
/// @name DefaultObjectAccessControls operations.
bool IsIdempotent(
internal::ListDefaultObjectAclRequest const& request) const override;
bool IsIdempotent(
internal::CreateDefaultObjectAclRequest const& request) const override;
bool IsIdempotent(
internal::DeleteDefaultObjectAclRequest const& request) const override;
bool IsIdempotent(
internal::GetDefaultObjectAclRequest const& request) const override;
bool IsIdempotent(
internal::UpdateDefaultObjectAclRequest const& request) const override;
bool IsIdempotent(
internal::PatchDefaultObjectAclRequest const& request) const override;
///@}
///@{
bool IsIdempotent(
internal::GetProjectServiceAccountRequest const& request) const override;
bool IsIdempotent(
internal::ListHmacKeysRequest const& request) const override;
bool IsIdempotent(
internal::CreateHmacKeyRequest const& request) const override;
bool IsIdempotent(
internal::DeleteHmacKeyRequest const& request) const override;
bool IsIdempotent(internal::GetHmacKeyRequest const& request) const override;
bool IsIdempotent(
internal::UpdateHmacKeyRequest const& request) const override;
bool IsIdempotent(internal::SignBlobRequest const& request) const override;
///@}
///@{
bool IsIdempotent(
internal::ListNotificationsRequest const& request) const override;
bool IsIdempotent(
internal::CreateNotificationRequest const& request) const override;
bool IsIdempotent(
internal::GetNotificationRequest const& request) const override;
bool IsIdempotent(
internal::DeleteNotificationRequest const& request) const override;
///@}
};
GOOGLE_CLOUD_CPP_INLINE_NAMESPACE_END
} // namespace storage
} // namespace cloud
} // namespace google
#endif // GOOGLE_CLOUD_CPP_GOOGLE_CLOUD_STORAGE_IDEMPOTENCY_POLICY_H