feat: Support object retention

amanda-tarafa · amanda-tarafa · commit 6d20fd3e01d6 · 2024-03-04T23:55:43.000-08:00
Closes googleapis#11227 Closes googleapis#11368
diff --git a/apis/Google.Cloud.Storage.V1/Google.Cloud.Storage.V1.Tests/CreateBucketOptionsTest.cs b/apis/Google.Cloud.Storage.V1/Google.Cloud.Storage.V1.Tests/CreateBucketOptionsTest.cs
@@ -29,6 +29,7 @@ public void ModifyRequest_DefaultOptions()
             Assert.Null(request.PredefinedAcl);
             Assert.Null(request.PredefinedDefaultObjectAcl);
             Assert.Null(request.Projection);
+            Assert.Null(request.EnableObjectRetention);
         }
 
         [Fact]
@@ -39,12 +40,14 @@ public void ModifyRequest_AllOptions()
             {
                 PredefinedAcl = PredefinedBucketAcl.AuthenticatedRead,
                 PredefinedDefaultObjectAcl = PredefinedObjectAcl.BucketOwnerFullControl,
-                Projection = Projection.Full
+                Projection = Projection.Full,
+                ObjectRetentionEnabled = true,
             };
             options.ModifyRequest(request);
             Assert.Equal(PredefinedAclEnum.AuthenticatedRead, request.PredefinedAcl);
             Assert.Equal(PredefinedDefaultObjectAclEnum.BucketOwnerFullControl, request.PredefinedDefaultObjectAcl);
             Assert.Equal(ProjectionEnum.Full, request.Projection);
+            Assert.True(request.EnableObjectRetention);
         }
     }
 }
diff --git a/apis/Google.Cloud.Storage.V1/Google.Cloud.Storage.V1.Tests/PatchObjectOptionsTest.cs b/apis/Google.Cloud.Storage.V1/Google.Cloud.Storage.V1.Tests/PatchObjectOptionsTest.cs
@@ -35,6 +35,7 @@ public void ModifyRequest_DefaultOptions()
             Assert.Null(request.PredefinedAcl);
             Assert.Null(request.Projection);
             Assert.Null(request.UserProject);
+            Assert.Null(request.OverrideUnlockedRetention);
         }
 
         [Fact]
@@ -48,7 +49,8 @@ public void ModifyRequest_PositiveMatchOptions()
                 IfMetagenerationMatch = 3L,
                 PredefinedAcl = PredefinedObjectAcl.AuthenticatedRead,
                 Projection = Projection.Full,
-                UserProject = "proj"
+                UserProject = "proj",
+                OverrideUnlockedRetention = true,
             };
             options.ModifyRequest(request);
             Assert.Equal(1L, request.Generation);
@@ -59,6 +61,7 @@ public void ModifyRequest_PositiveMatchOptions()
             Assert.Equal(PredefinedAclEnum.AuthenticatedRead, request.PredefinedAcl);
             Assert.Equal(ProjectionEnum.Full, request.Projection);
             Assert.Equal("proj", request.UserProject);
+            Assert.True(request.OverrideUnlockedRetention);
         }
 
         [Fact]
diff --git a/apis/Google.Cloud.Storage.V1/Google.Cloud.Storage.V1.Tests/UpdateObjectOptionsTest.cs b/apis/Google.Cloud.Storage.V1/Google.Cloud.Storage.V1.Tests/UpdateObjectOptionsTest.cs
@@ -37,6 +37,7 @@ public void ModifyRequest_DefaultOptions()
             Assert.Null(request.PredefinedAcl);
             Assert.Null(request.Projection);
             Assert.Null(request.UserProject);
+            Assert.Null(request.OverrideUnlockedRetention);
         }
 
         [Fact]
@@ -67,7 +68,8 @@ public void ModifyRequest_PositiveMatchOptions()
                 IfMetagenerationMatch = 3L,
                 PredefinedAcl = PredefinedObjectAcl.AuthenticatedRead,
                 Projection = Projection.Full,
-                UserProject = "proj"
+                UserProject = "proj",
+                OverrideUnlockedRetention = true,
             };
             options.ModifyRequest(request, obj);
             Assert.Equal(1L, request.Generation);
@@ -78,6 +80,7 @@ public void ModifyRequest_PositiveMatchOptions()
             Assert.Equal(PredefinedAclEnum.AuthenticatedRead, request.PredefinedAcl);
             Assert.Equal(ProjectionEnum.Full, request.Projection);
             Assert.Equal("proj", request.UserProject);
+            Assert.True(request.OverrideUnlockedRetention);
         }
 
         [Fact]
diff --git a/apis/Google.Cloud.Storage.V1/Google.Cloud.Storage.V1/CreateBucketOptions.cs b/apis/Google.Cloud.Storage.V1/Google.Cloud.Storage.V1/CreateBucketOptions.cs
@@ -38,6 +38,11 @@ public sealed class CreateBucketOptions
         /// </summary>
         public Projection? Projection { get; set; }
 
+        /// <summary>
+        /// When set to true, permanently enable object retention for this bucket.
+        /// </summary>
+        public bool? ObjectRetentionEnabled { get; set; }
+
         /// <summary>
         /// Options to pass custom retry configuration for each API request.
         /// </summary>
@@ -59,6 +64,10 @@ internal void ModifyRequest(BucketsResource.InsertRequest request)
             {
                 request.Projection = GaxPreconditions.CheckEnumValue((ProjectionEnum) Projection, nameof(Projection));
             }
+            if (ObjectRetentionEnabled.HasValue)
+            {
+                request.EnableObjectRetention = ObjectRetentionEnabled.Value;
+            }
         }
     }
 }
diff --git a/apis/Google.Cloud.Storage.V1/Google.Cloud.Storage.V1/PatchObjectOptions.cs b/apis/Google.Cloud.Storage.V1/Google.Cloud.Storage.V1/PatchObjectOptions.cs
@@ -75,6 +75,12 @@ public sealed class PatchObjectOptions
         /// </summary>
         public string UserProject { get; set; }
 
+        /// <summary>
+        /// Must be true to remove the retention configuration, reduce its unlocked retention period, or change its
+        /// mode from unlocked to locked.
+        /// </summary>
+        public bool? OverrideUnlockedRetention {  get; set; }
+
         /// <summary>
         /// Options to pass custom retry configuration for each API request.
         /// </summary>
@@ -126,6 +132,10 @@ internal void ModifyRequest(PatchRequest request)
             {
                 request.UserProject = UserProject;
             }
+            if (OverrideUnlockedRetention.HasValue)
+            {
+                request.OverrideUnlockedRetention = OverrideUnlockedRetention.Value;
+            }
         }
     }
 }
diff --git a/apis/Google.Cloud.Storage.V1/Google.Cloud.Storage.V1/UpdateObjectOptions.cs b/apis/Google.Cloud.Storage.V1/Google.Cloud.Storage.V1/UpdateObjectOptions.cs
@@ -83,6 +83,12 @@ public sealed class UpdateObjectOptions
         /// </summary>
         public string UserProject { get; set; }
 
+        /// <summary>
+        /// Must be true to remove the retention configuration, reduce its unlocked retention period, or change its
+        /// mode from unlocked to locked.
+        /// </summary>
+        public bool? OverrideUnlockedRetention { get; set; }
+
         /// <summary>
         /// Options to pass custom retry configuration for each API request.
         /// </summary>
@@ -149,6 +155,10 @@ internal void ModifyRequest(UpdateRequest request, Object obj)
             {
                 request.UserProject = UserProject;
             }
+            if (OverrideUnlockedRetention.HasValue)
+            {
+                request.OverrideUnlockedRetention = OverrideUnlockedRetention.Value;
+            }
         }
     }
 }

Original file line number	Diff line number	Diff line change
`@@ -29,6 +29,7 @@ public void ModifyRequest_DefaultOptions()`
`29`	`29`	`Assert.Null(request.PredefinedAcl);`
`30`	`30`	`Assert.Null(request.PredefinedDefaultObjectAcl);`
`31`	`31`	`Assert.Null(request.Projection);`
	`32`	`+ Assert.Null(request.EnableObjectRetention);`
`32`	`33`	`}`
`33`	`34`
`34`	`35`	`[Fact]`
`@@ -39,12 +40,14 @@ public void ModifyRequest_AllOptions()`
`39`	`40`	`{`
`40`	`41`	`PredefinedAcl = PredefinedBucketAcl.AuthenticatedRead,`
`41`	`42`	`PredefinedDefaultObjectAcl = PredefinedObjectAcl.BucketOwnerFullControl,`
`42`		`- Projection = Projection.Full`
	`43`	`+ Projection = Projection.Full,`
	`44`	`+ ObjectRetentionEnabled = true,`
`43`	`45`	`};`
`44`	`46`	`options.ModifyRequest(request);`
`45`	`47`	`Assert.Equal(PredefinedAclEnum.AuthenticatedRead, request.PredefinedAcl);`
`46`	`48`	`Assert.Equal(PredefinedDefaultObjectAclEnum.BucketOwnerFullControl, request.PredefinedDefaultObjectAcl);`
`47`	`49`	`Assert.Equal(ProjectionEnum.Full, request.Projection);`
	`50`	`+ Assert.True(request.EnableObjectRetention);`
`48`	`51`	`}`
`49`	`52`	`}`
`50`	`53`	`}`
Original file line number	Diff line number	Diff line change
`@@ -38,6 +38,11 @@ public sealed class CreateBucketOptions`
`38`	`38`	`/// </summary>`
`39`	`39`	`public Projection? Projection { get; set; }`
`40`	`40`
	`41`	`+ /// <summary>`
	`42`	`+ /// When set to true, permanently enable object retention for this bucket.`
	`43`	`+ /// </summary>`
	`44`	`+ public bool? ObjectRetentionEnabled { get; set; }`
	`45`	`+`
`41`	`46`	`/// <summary>`
`42`	`47`	`/// Options to pass custom retry configuration for each API request.`
`43`	`48`	`/// </summary>`
`@@ -59,6 +64,10 @@ internal void ModifyRequest(BucketsResource.InsertRequest request)`
`59`	`64`	`{`
`60`	`65`	`request.Projection = GaxPreconditions.CheckEnumValue((ProjectionEnum) Projection, nameof(Projection));`
`61`	`66`	`}`
	`67`	`+ if (ObjectRetentionEnabled.HasValue)`
	`68`	`+ {`
	`69`	`+ request.EnableObjectRetention = ObjectRetentionEnabled.Value;`
	`70`	`+ }`
`62`	`71`	`}`
`63`	`72`	`}`
`64`	`73`	`}`
Original file line number	Diff line number	Diff line change
`@@ -75,6 +75,12 @@ public sealed class PatchObjectOptions`
`75`	`75`	`/// </summary>`
`76`	`76`	`public string UserProject { get; set; }`
`77`	`77`
	`78`	`+ /// <summary>`
	`79`	`+ /// Must be true to remove the retention configuration, reduce its unlocked retention period, or change its`
	`80`	`+ /// mode from unlocked to locked.`
	`81`	`+ /// </summary>`
	`82`	`+ public bool? OverrideUnlockedRetention { get; set; }`
	`83`	`+`
`78`	`84`	`/// <summary>`
`79`	`85`	`/// Options to pass custom retry configuration for each API request.`
`80`	`86`	`/// </summary>`
`@@ -126,6 +132,10 @@ internal void ModifyRequest(PatchRequest request)`
`126`	`132`	`{`
`127`	`133`	`request.UserProject = UserProject;`
`128`	`134`	`}`
	`135`	`+ if (OverrideUnlockedRetention.HasValue)`
	`136`	`+ {`
	`137`	`+ request.OverrideUnlockedRetention = OverrideUnlockedRetention.Value;`
	`138`	`+ }`
`129`	`139`	`}`
`130`	`140`	`}`
`131`	`141`	`}`
Original file line number	Diff line number	Diff line change
`@@ -83,6 +83,12 @@ public sealed class UpdateObjectOptions`
`83`	`83`	`/// </summary>`
`84`	`84`	`public string UserProject { get; set; }`
`85`	`85`
	`86`	`+ /// <summary>`
	`87`	`+ /// Must be true to remove the retention configuration, reduce its unlocked retention period, or change its`
	`88`	`+ /// mode from unlocked to locked.`
	`89`	`+ /// </summary>`
	`90`	`+ public bool? OverrideUnlockedRetention { get; set; }`
	`91`	`+`
`86`	`92`	`/// <summary>`
`87`	`93`	`/// Options to pass custom retry configuration for each API request.`
`88`	`94`	`/// </summary>`
`@@ -149,6 +155,10 @@ internal void ModifyRequest(UpdateRequest request, Object obj)`
`149`	`155`	`{`
`150`	`156`	`request.UserProject = UserProject;`
`151`	`157`	`}`
	`158`	`+ if (OverrideUnlockedRetention.HasValue)`
	`159`	`+ {`
	`160`	`+ request.OverrideUnlockedRetention = OverrideUnlockedRetention.Value;`
	`161`	`+ }`
`152`	`162`	`}`
`153`	`163`	`}`
`154`	`164`	`}`