google-cloud-storage 1.46.0 → 1.47.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9180138623d24136aba3789a2999158c8e1936ccc483be54e96d7ad5ce0270cd
-  data.tar.gz: db71d2a866acb5b3c63a55d26393ef4d4b05dbdbdc529f51b4e8343d0674ec3d
+  metadata.gz: fb6046c8eb979e1cbd733518d8fd242e1332813d6241f85e65b07f6d7d9e631f
+  data.tar.gz: 1124d71be6c1954b38f3fb6c8c3814891d9dd108fc0862f2c5436db18c111782
 SHA512:
-  metadata.gz: 33f397b67897fb16738284a45998c6df621cf7cc7a26cf57582c092ec0ff40b3fa38c2cc7a74489ff46debcad240cb82a1e4293302dd0eb6214e261aa7972e4d
-  data.tar.gz: d52e0f8e792f8dc9359d24c58cba4c1dbc7714114078be630c40ce8d652bef3e4b336785c3b7f440b6df41f61f2699fa69d3073113e1c985a504d69a24debf2c
+  metadata.gz: 2e8598d2cf01a52f20c7bd554b593d7049134a367f17571721e2779a0634013452ad42025c22d59f8542c030a411092c3f2f63edfe8489fee0a9dcb9ccb5c774
+  data.tar.gz: 4918a472cd83aab2c7d1a5ffe6be9957c0113686a00769f082522799fd9cc713c3315de8d8b2d87caa22b37d7d54c2c82702fb2b5b9e1ed30ef011319dc841cf

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Release History
 
+### 1.47.0 (2024-01-09)
+
+#### Features
+
+* support for object lock / retention ([#23732](https://github.com/googleapis/google-cloud-ruby/issues/23732)) 
+
 ### 1.46.0 (2024-01-08)
 
 #### Features

data/lib/google/cloud/storage/bucket.rb

@@ -118,6 +118,15 @@ module Google
           @gapi.autoclass
         end
 
+        ##
+        # The object retention configuration of the bucket
+        #
+        # @return [Google::Apis::StorageV1::Bucket::ObjectRetention]
+        #
+        def object_retention
+          @gapi.object_retention
+        end
+
         ##
         # The name of the bucket.
         #

data/lib/google/cloud/storage/file.rb

@@ -825,6 +825,9 @@ module Google
         # @param [Integer] if_metageneration_not_match Makes the operation
         #   conditional on whether the file's current metageneration does not
         #   match the given value.
+        # @param [Boolean] override_unlocked_retention
+        #   Must be true to remove the retention configuration, reduce its unlocked
+        #   retention period, or change its mode from unlocked to locked.
         #
         # @yield [file] a block yielding a delegate object for updating the file
         #
@@ -865,7 +868,8 @@ module Google
                    if_generation_match: nil,
                    if_generation_not_match: nil,
                    if_metageneration_match: nil,
-                   if_metageneration_not_match: nil
+                   if_metageneration_not_match: nil,
+                   override_unlocked_retention: nil
           updater = Updater.new gapi
           yield updater
           updater.check_for_changed_metadata!
@@ -875,7 +879,8 @@ module Google
                        if_generation_match: if_generation_match,
                        if_generation_not_match: if_generation_not_match,
                        if_metageneration_match: if_metageneration_match,
-                       if_metageneration_not_match: if_metageneration_not_match
+                       if_metageneration_not_match: if_metageneration_not_match,
+                       override_unlocked_retention: override_unlocked_retention
         end
 
         ##
@@ -1560,6 +1565,64 @@ module Google
           true
         end
 
+        # Mode of object level retention configuration.
+        # Valid values are 'Locked' or 'Unlocked'
+        #
+        # @return [String]
+        def retention_mode
+          @gapi.retention&.mode
+        end
+
+        # The earliest time in RFC 3339 UTC "Zulu" format that the object can
+        # be deleted or replaced.
+        #
+        # @return [DateTime]
+        def retention_retain_until_time
+          @gapi.retention&.retain_until_time
+        end
+
+        # A collection of object level retention parameters.
+        # The full list of available options are outlined at the [JSON API docs]
+        # (https://cloud.google.com/storage/docs/json_api/v1/objects/insert#request-body).
+        #
+        # @return [Google::Apis::StorageV1::Object::Retention]
+        def retention
+          @gapi.retention
+        end
+
+        ##
+        # Update method to update retention parameter of an object / file
+        # It accepts params as a Hash of attributes in the following format:
+        #
+        #     { mode: 'Locked|Unlocked', retain_until_time: '2023-12-19T03:22:23+00:00' }
+        #
+        # @param [Hash(String => String)] new_retention_attributes
+        #
+        # @example Update retention parameters for the File / Object
+        #   require "google/cloud/storage"
+        #   storage = Google::Cloud::Storage.new
+        #   bucket = storage.bucket "my-bucket"
+        #   file = bucket.file "avatars/heidi/400x400.png"
+        #   retention_params = { mode: 'Unlocked', retain_until_time: '2023-12-19T03:22:23+00:00'.to_datetime }
+        #   file.retention = retention_params
+        #
+        # @example Update retention parameters for the File / Object with override enabled
+        #   require "google/cloud/storage"
+        #   storage = Google::Cloud::Storage.new
+        #   bucket = storage.bucket "my-bucket"
+        #   file = bucket.file "avatars/heidi/400x400.png"
+        #   retention_params = { mode: 'Unlocked',
+        #                        retain_until_time: '2023-12-19T03:22:23+00:00'.to_datetime,
+        #                        override_unlocked_retention: true }
+        #   file.retention = retention_params
+        #
+        def retention= new_retention_attributes
+          @gapi.retention ||= Google::Apis::StorageV1::Object::Retention.new
+          @gapi.retention.mode = new_retention_attributes[:mode]
+          @gapi.retention.retain_until_time = new_retention_attributes[:retain_until_time]
+          update_gapi! :retention, override_unlocked_retention: new_retention_attributes[:override_unlocked_retention]
+        end
+
         ##
         # Public URL to access the file. If the file is not public, requests to
         # the URL will return an error. (See {File::Acl#public!} and
@@ -2015,7 +2078,8 @@ module Google
                          if_generation_match: nil,
                          if_generation_not_match: nil,
                          if_metageneration_match: nil,
-                         if_metageneration_not_match: nil
+                         if_metageneration_not_match: nil,
+                         override_unlocked_retention: nil
           attributes = Array(attributes)
           attributes.flatten!
           return if attributes.empty?
@@ -2044,7 +2108,8 @@ module Google
                                        if_generation_not_match: if_generation_not_match,
                                        if_metageneration_match: if_metageneration_match,
                                        if_metageneration_not_match: if_metageneration_not_match,
-                                       user_project: user_project
+                                       user_project: user_project,
+                                       override_unlocked_retention: override_unlocked_retention
                   end
         end
 

data/lib/google/cloud/storage/project.rb

@@ -372,6 +372,8 @@ module Google
         #   bucket instance and its files.
         #
         #   See also {Bucket#requester_pays=} and {Bucket#requester_pays}.
+        # @param [Boolean] enable_object_retention
+        #   When set to true, object retention is enabled for this bucket.
         #
         # @yield [bucket] a block for configuring the bucket before it is
         #   created
@@ -386,6 +388,13 @@ module Google
         #
         #   bucket = storage.create_bucket "my-bucket"
         #
+        # @example
+        #   require "google/cloud/storage"
+        #
+        #   storage = Google::Cloud::Storage.new
+        #
+        #   bucket = storage.create_bucket "my-bucket", enable_object_retention: true
+        #
         # @example Configure the bucket in a block:
         #   require "google/cloud/storage"
         #
@@ -416,7 +425,8 @@ module Google
                           versioning: nil,
                           requester_pays: nil,
                           user_project: nil,
-                          autoclass_enabled: false
+                          autoclass_enabled: false,
+                          enable_object_retention: nil
           params = {
             name: bucket_name,
             location: location,
@@ -440,7 +450,8 @@ module Google
           updater.check_for_mutable_lifecycle!
           gapi = service.insert_bucket \
             new_bucket, acl: acl_rule(acl), default_acl: acl_rule(default_acl),
-                        user_project: user_project
+                        user_project: user_project,
+                        enable_object_retention: enable_object_retention
           Bucket.from_gapi gapi, service, user_project: user_project
         end
 

data/lib/google/cloud/storage/service.rb

@@ -112,14 +112,16 @@ module Google
         # Creates a new bucket.
         # Returns Google::Apis::StorageV1::Bucket.
         def insert_bucket bucket_gapi, acl: nil, default_acl: nil,
-                          user_project: nil, options: {}
+                          user_project: nil, enable_object_retention: nil,
+                          options: {}
           execute do
             service.insert_bucket \
               @project, bucket_gapi,
               predefined_acl: acl,
               predefined_default_object_acl: default_acl,
               user_project: user_project(user_project),
-              options: options
+              options: options,
+              enable_object_retention: enable_object_retention
           end
         end
 
@@ -582,6 +584,7 @@ module Google
                        if_metageneration_not_match: nil,
                        predefined_acl: nil,
                        user_project: nil,
+                       override_unlocked_retention: nil,
                        options: {}
           file_gapi ||= Google::Apis::StorageV1::Object.new
 
@@ -601,6 +604,7 @@ module Google
                                  if_metageneration_not_match: if_metageneration_not_match,
                                  predefined_acl: predefined_acl,
                                  user_project: user_project(user_project),
+                                 override_unlocked_retention: override_unlocked_retention,
                                  options: options
           end
         end

data/lib/google/cloud/storage/version.rb

@@ -16,7 +16,7 @@
 module Google
   module Cloud
     module Storage
-      VERSION = "1.46.0".freeze
+      VERSION = "1.47.0".freeze
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-storage
 version: !ruby/object:Gem::Version
-  version: 1.46.0
+  version: 1.47.0
 platform: ruby
 authors:
 - Mike Moore
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-01-08 00:00:00.000000000 Z
+date: 2024-01-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-cloud-core
@@ -45,14 +45,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.29.0
+        version: 0.31.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.29.0
+        version: 0.31.0
 - !ruby/object:Gem::Dependency
   name: googleauth
   requirement: !ruby/object:Gem::Requirement