google-cloud-storage 1.27.0 → 1.28.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA256:
-  metadata.gz: c1c5fde2ed35606723e05c787ff96fd6ec31d7e06015e09bcac8dc0bc4b9ae05
-  data.tar.gz: bf1391389ff711934df5302f65cdf6136bad14b0a00865728da8fe3b549b3cbe
+SHA1:
+  metadata.gz: 5141d81168421311ea103c5d466e2f0a1e6a6b6d
+  data.tar.gz: 352c5ac1297c6919c8a71d80bd61a24697692bd2
 SHA512:
-  metadata.gz: 1e7d9a97562357737322928a56f093ed42bc8f8015a06723c5e403c402367a89f56604eeefb2bbbf289a7dce5b84ee055f76f3d6ef6df6d987f7f05ed5eed5fe
-  data.tar.gz: 67046c8397a7e7fabf7b0a4d4e6501417ba815b55267e641a0ab51cdb233641e699348629a021763724aaca623e25a901395d77453b78fbc90ae67d4efca17b1
+  metadata.gz: 7bec28a4b4eebf986b43b9d06115955cc44ed03430f657b5f5eb9a2aff1ba26e77adcbbac9f2a57536f1734fda1c795664e65532f3476dcd085703aa8dc167b8
+  data.tar.gz: 894e70a45cf36a63158e07059a84a13e3a668d4730dab612a8acca3fdf532fa97e74e20a06bb86c037343e54c468a53fa16e2eaefbbe25e1cb9c0c198d007e82

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 # Release History
 
+### 1.28.0 / 2020-08-26
+
+* Add Object Lifecycle Management fields
+  * Add custom_time_before to Lifecycle::Rule
+  * Add days_since_custom_time to Lifecycle::Rule
+  * Add days_since_noncurrent_time to Lifecycle::Rule
+  * Add noncurrent_time_before to Lifecycle::Rule
+  * Add File#custom_time and #custom_time=
+
 ### 1.27.0 / 2020-07-29
 
 #### Features

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

@@ -1128,6 +1128,11 @@ module Google
         # @param [String] content_type The
         #   [Content-Type](https://tools.ietf.org/html/rfc2616#section-14.17)
         #   response header to be returned when the file is downloaded.
+        # @param [DateTime] custom_time A custom time specified by the user for
+        #   the file. Once set, custom_time can't be unset, and it can only be
+        #   changed to a time in the future. If custom_time must be unset, you
+        #   must either perform a rewrite operation, or upload the data again
+        #   and create a new file.
         # @param [String] crc32c The CRC32c checksum of the file data, as
         #   described in [RFC 4960, Appendix
         #   B](http://tools.ietf.org/html/rfc4960#appendix-B).
@@ -1249,7 +1254,7 @@ module Google
         #
         def create_file file, path = nil, acl: nil, cache_control: nil,
                         content_disposition: nil, content_encoding: nil,
-                        content_language: nil, content_type: nil,
+                        content_language: nil, content_type: nil, custom_time: nil,
                         crc32c: nil, md5: nil, metadata: nil,
                         storage_class: nil, encryption_key: nil, kms_key: nil,
                         temporary_hold: nil, event_based_hold: nil
@@ -1264,6 +1269,7 @@ module Google
                                                        md5: md5,
                                                        cache_control: cache_control,
                                                        content_type: content_type,
+                                                       custom_time: custom_time,
                                                        content_disposition: content_disposition,
                                                        crc32c: crc32c,
                                                        content_encoding: content_encoding,

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

@@ -105,6 +105,21 @@ module Google
           #   only the date part (for instance, "2013-01-15"). This condition is
           #   satisfied when a file is created before midnight of the specified
           #   date in UTC.
+          # @param [String,Date] custom_time_before A date in RFC 3339 format with
+          #   only the date part (for instance, "2013-01-15"). This condition is
+          #   satisfied when the custom time on an object is before this date in UTC.
+          # @param [Integer] days_since_custom_time Represents the number of
+          #   days elapsed since the user-specified timestamp set on an object.
+          #   The condition is satisfied if the days elapsed is at least this
+          #   number. If no custom timestamp is specified on an object, the
+          #   condition does not apply.
+          # @param [Integer] days_since_noncurrent_time Represents the number of
+          #   days elapsed since the noncurrent timestamp of an object. The
+          #   condition is satisfied if the days elapsed is at least this number.
+          #   The value of the field must be a nonnegative integer. If it's zero,
+          #   the object version will become eligible for Lifecycle action as
+          #   soon as it becomes noncurrent. Relevant only for versioning-enabled
+          #   buckets. (See {Bucket#versioning?})
           # @param [Boolean] is_live Relevant only for versioned files. If the
           #   value is `true`, this condition matches live files; if the value
           #   is `false`, it matches archived files.
@@ -115,6 +130,10 @@ module Google
           #   `DURABLE_REDUCED_AVAILABILITY` are supported as legacy storage
           #   classes. Arguments will be converted from symbols and lower-case
           #   to upper-case strings.
+          # @param [String,Date] noncurrent_time_before A date in RFC 3339 format
+          #   with only the date part (for instance, "2013-01-15"). This condition
+          #   is satisfied when the noncurrent time on an object is before this
+          #   date in UTC. This condition is relevant only for versioned objects.
           # @param [Integer] num_newer_versions Relevant only for versioned
           #   files. If the value is N, this condition is satisfied when there
           #   are at least N versions (including the live version) newer than
@@ -129,16 +148,29 @@ module Google
           #     b.lifecycle.add_set_storage_class_rule "COLDLINE", age: 10
           #   end
           #
-          def add_set_storage_class_rule storage_class, age: nil,
-                                         created_before: nil, is_live: nil,
+          def add_set_storage_class_rule storage_class,
+                                         age: nil,
+                                         created_before: nil,
+                                         custom_time_before: nil,
+                                         days_since_custom_time: nil,
+                                         days_since_noncurrent_time: nil,
+                                         is_live: nil,
                                          matches_storage_class: nil,
+                                         noncurrent_time_before: nil,
                                          num_newer_versions: nil
-            push Rule.new \
+            push Rule.new(
               "SetStorageClass",
               storage_class: storage_class_for(storage_class),
-              age: age, created_before: created_before, is_live: is_live,
+              age: age,
+              created_before: created_before,
+              custom_time_before: custom_time_before,
+              days_since_custom_time: days_since_custom_time,
+              days_since_noncurrent_time: days_since_noncurrent_time,
+              is_live: is_live,
               matches_storage_class: storage_class_for(matches_storage_class),
+              noncurrent_time_before: noncurrent_time_before,
               num_newer_versions: num_newer_versions
+            )
           end
 
           ##
@@ -156,6 +188,21 @@ module Google
           #   only the date part (for instance, "2013-01-15"). This condition is
           #   satisfied when a file is created before midnight of the specified
           #   date in UTC.
+          # @param [String,Date] custom_time_before A date in RFC 3339 format with
+          #   only the date part (for instance, "2013-01-15"). This condition is
+          #   satisfied when the custom time on an object is before this date in UTC.
+          # @param [Integer] days_since_custom_time Represents the number of
+          #   days elapsed since the user-specified timestamp set on an object.
+          #   The condition is satisfied if the days elapsed is at least this
+          #   number. If no custom timestamp is specified on an object, the
+          #   condition does not apply.
+          # @param [Integer] days_since_noncurrent_time Represents the number of
+          #   days elapsed since the noncurrent timestamp of an object. The
+          #   condition is satisfied if the days elapsed is at least this number.
+          #   The value of the field must be a nonnegative integer. If it's zero,
+          #   the object version will become eligible for Lifecycle action as
+          #   soon as it becomes noncurrent. Relevant only for versioning-enabled
+          #   buckets. (See {Bucket#versioning?})
           # @param [Boolean] is_live Relevant only for versioned files. If the
           #   value is `true`, this condition matches live files; if the value
           #   is `false`, it matches archived files.
@@ -166,6 +213,10 @@ module Google
           #   `DURABLE_REDUCED_AVAILABILITY` are supported as legacy storage
           #   classes. Arguments will be converted from symbols and lower-case
           #   to upper-case strings.
+          # @param [String,Date] noncurrent_time_before A date in RFC 3339 format
+          #   with only the date part (for instance, "2013-01-15"). This condition
+          #   is satisfied when the noncurrent time on an object is before this
+          #   date in UTC. This condition is relevant only for versioned objects.
           # @param [Integer] num_newer_versions Relevant only for versioned
           #   files. If the value is N, this condition is satisfied when there
           #   are at least N versions (including the live version) newer than
@@ -180,14 +231,27 @@ module Google
           #     b.lifecycle.add_delete_rule age: 30, is_live: false
           #   end
           #
-          def add_delete_rule age: nil, created_before: nil, is_live: nil,
+          def add_delete_rule age: nil,
+                              created_before: nil,
+                              custom_time_before: nil,
+                              days_since_custom_time: nil,
+                              days_since_noncurrent_time: nil,
+                              is_live: nil,
                               matches_storage_class: nil,
+                              noncurrent_time_before: nil,
                               num_newer_versions: nil
-            push Rule.new \
+            push Rule.new(
               "Delete",
-              age: age, created_before: created_before, is_live: is_live,
+              age: age,
+              created_before: created_before,
+              custom_time_before: custom_time_before,
+              days_since_custom_time: days_since_custom_time,
+              days_since_noncurrent_time: days_since_noncurrent_time,
+              is_live: is_live,
               matches_storage_class: storage_class_for(matches_storage_class),
+              noncurrent_time_before: noncurrent_time_before,
               num_newer_versions: num_newer_versions
+            )
           end
 
           # @private
@@ -231,10 +295,26 @@ module Google
           #   action. Required only if the action is `SetStorageClass`.
           # @attr [Integer] age The age of a file (in days). This condition is
           #   satisfied when a file reaches the specified age.
-          # @attr [String,Date] created_before A date in RFC 3339 format with
+          # @attr [String,Date,nil] created_before A date in RFC 3339 format with
           #   only the date part (for instance, "2013-01-15"). This condition is
           #   satisfied when a file is created before midnight of the specified
-          #   date in UTC.
+          #   date in UTC. When returned by the service, a non-empty value will
+          #   always be a Date object.
+          # @attr [String,Date,nil] custom_time_before A date in RFC 3339 format with
+          #   only the date part (for instance, "2013-01-15"). This condition is
+          #   satisfied when the custom time on an object is before this date in UTC.
+          # @attr [Integer,nil] days_since_custom_time Represents the number of
+          #   days elapsed since the user-specified timestamp set on an object.
+          #   The condition is satisfied if the days elapsed is at least this
+          #   number. If no custom timestamp is specified on an object, the
+          #   condition does not apply.
+          # @attr [Integer] days_since_noncurrent_time Represents the number of
+          #   days elapsed since the noncurrent timestamp of an object. The
+          #   condition is satisfied if the days elapsed is at least this number.
+          #   The value of the field must be a nonnegative integer. If it's zero,
+          #   the object version will become eligible for Lifecycle action as
+          #   soon as it becomes noncurrent. Relevant only for versioning-enabled
+          #   buckets. (See {Bucket#versioning?})
           # @attr [Boolean] is_live Relevant only for versioned files. If the
           #   value is `true`, this condition matches live files; if the value
           #   is `false`, it matches archived files.
@@ -243,6 +323,12 @@ module Google
           #   Values include `STANDARD`, `NEARLINE`, `COLDLINE`, and `ARCHIVE`.
           #   `REGIONAL`, `MULTI_REGIONAL`, and `DURABLE_REDUCED_AVAILABILITY`
           #   are supported as legacy storage classes.
+          # @attr [String,Date,nil] noncurrent_time_before A date in RFC 3339 format
+          #   with only the date part (for instance, "2013-01-15"). This condition
+          #   is satisfied when the noncurrent time on an object is before this
+          #   date in UTC. This condition is relevant only for versioned objects.
+          #   When returned by the service, a non-empty value will always be a
+          #   Date object.
           # @attr [Integer] num_newer_versions Relevant only for versioned
           #   files. If the value is N, this condition is satisfied when there
           #   are at least N versions (including the live version) newer than
@@ -285,28 +371,57 @@ module Google
           #   end
           #
           class Rule
-            attr_accessor :action, :storage_class, :age, :created_before,
-                          :is_live, :matches_storage_class, :num_newer_versions
+            attr_accessor :action,
+                          :storage_class,
+                          :age,
+                          :created_before,
+                          :custom_time_before,
+                          :days_since_custom_time,
+                          :days_since_noncurrent_time,
+                          :is_live,
+                          :matches_storage_class,
+                          :noncurrent_time_before,
+                          :num_newer_versions
 
             # @private
-            def initialize action, storage_class: nil, age: nil,
-                           created_before: nil, is_live: nil,
-                           matches_storage_class: nil, num_newer_versions: nil
+            def initialize action,
+                           storage_class: nil,
+                           age: nil,
+                           created_before: nil,
+                           custom_time_before: nil,
+                           days_since_custom_time: nil,
+                           days_since_noncurrent_time: nil,
+                           is_live: nil,
+                           matches_storage_class: nil,
+                           noncurrent_time_before: nil,
+                           num_newer_versions: nil
               @action = action
               @storage_class = storage_class
               @age = age
               @created_before = created_before
+              @custom_time_before = custom_time_before
+              @days_since_custom_time = days_since_custom_time
+              @days_since_noncurrent_time = days_since_noncurrent_time
               @is_live = is_live
               @matches_storage_class = Array(matches_storage_class)
+              @noncurrent_time_before = noncurrent_time_before
               @num_newer_versions = num_newer_versions
             end
 
             # @private
             # @return [Google::Apis::StorageV1::Bucket::Lifecycle]
             def to_gapi
-              condition = condition_gapi(age, created_before, is_live,
-                                         matches_storage_class,
-                                         num_newer_versions)
+              condition = condition_gapi(
+                age,
+                created_before,
+                custom_time_before,
+                days_since_custom_time,
+                days_since_noncurrent_time,
+                is_live,
+                matches_storage_class,
+                noncurrent_time_before,
+                num_newer_versions
+              )
               Google::Apis::StorageV1::Bucket::Lifecycle::Rule.new(
                 action: action_gapi(action, storage_class),
                 condition: condition
@@ -316,18 +431,30 @@ module Google
             # @private
             def action_gapi action, storage_class
               Google::Apis::StorageV1::Bucket::Lifecycle::Rule::Action.new(
-                type: action, storage_class: storage_class
+                type: action,
+                storage_class: storage_class
               )
             end
 
             # @private
-            def condition_gapi age, created_before, is_live,
-                               matches_storage_class, num_newer_versions
+            def condition_gapi age,
+                               created_before,
+                               custom_time_before,
+                               days_since_custom_time,
+                               days_since_noncurrent_time,
+                               is_live,
+                               matches_storage_class,
+                               noncurrent_time_before,
+                               num_newer_versions
               Google::Apis::StorageV1::Bucket::Lifecycle::Rule::Condition.new(
                 age: age,
                 created_before: created_before,
+                custom_time_before: custom_time_before,
+                days_since_custom_time: days_since_custom_time,
+                days_since_noncurrent_time: days_since_noncurrent_time,
                 is_live: is_live,
                 matches_storage_class: Array(matches_storage_class),
+                noncurrent_time_before: noncurrent_time_before,
                 num_newer_versions: num_newer_versions
               )
             end
@@ -337,12 +464,19 @@ module Google
             def self.from_gapi gapi
               action = gapi.action
               c = gapi.condition
-              new action.type, storage_class: action.storage_class,
-                               age: c.age,
-                               created_before: c.created_before,
-                               is_live: c.is_live,
-                               matches_storage_class: c.matches_storage_class,
-                               num_newer_versions: c.num_newer_versions
+              new(
+                action.type,
+                storage_class: action.storage_class,
+                age: c.age,
+                created_before: c.created_before,
+                custom_time_before: c.custom_time_before,
+                days_since_custom_time: c.days_since_custom_time,
+                days_since_noncurrent_time: c.days_since_noncurrent_time,
+                is_live: c.is_live,
+                matches_storage_class: c.matches_storage_class,
+                noncurrent_time_before: c.noncurrent_time_before,
+                num_newer_versions: c.num_newer_versions
+              )
             end
 
             # @private

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

@@ -355,6 +355,29 @@ module Google
           update_gapi! :content_type
         end
 
+        ##
+        # A custom time specified by the user for the file, or `nil`.
+        #
+        # @return [DateTime, nil]
+        #
+        def custom_time
+          @gapi.custom_time
+        end
+
+        ##
+        # Updates the custom time specified by the user for the file. Once set,
+        # custom_time can't be unset, and it can only be changed to a time in the
+        # future. If custom_time must be unset, you must either perform a rewrite
+        # operation, or upload the data again and create a new file.
+        #
+        # @param [DateTime] custom_time A custom time specified by the user
+        #   for the file.
+        #
+        def custom_time= custom_time
+          @gapi.custom_time = custom_time
+          update_gapi! :custom_time
+        end
+
         ##
         # A hash of custom, user-provided web-safe keys and arbitrary string
         # values that will returned with requests for the file as "x-goog-meta-"
@@ -746,8 +769,9 @@ module Google
         # Updates the file with changes made in the given block in a single
         # PATCH request. The following attributes may be set: {#cache_control=},
         # {#content_disposition=}, {#content_encoding=}, {#content_language=},
-        # {#content_type=}, and {#metadata=}. The {#metadata} hash accessible in
-        # the block is completely mutable and will be included in the request.
+        # {#content_type=}, {#custom_time=} and {#metadata=}. The {#metadata} hash
+        # accessible in the block is completely mutable and will be included in the
+        # request.
         #
         # @yield [file] a block yielding a delegate object for updating the file
         #
@@ -766,6 +790,7 @@ module Google
         #     f.content_encoding = "deflate"
         #     f.content_language = "de"
         #     f.content_type = "application/json"
+        #     f.custom_time = DateTime.new 2025, 12, 31
         #     f.metadata["player"] = "Bob"
         #     f.metadata["score"] = "10"
         #   end

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

@@ -292,12 +292,12 @@ module Google
         def insert_file bucket_name, source, path = nil, acl: nil,
                         cache_control: nil, content_disposition: nil,
                         content_encoding: nil, content_language: nil,
-                        content_type: nil, crc32c: nil, md5: nil, metadata: nil,
+                        content_type: nil, custom_time: nil, crc32c: nil, md5: nil, metadata: nil,
                         storage_class: nil, key: nil, kms_key: nil,
                         temporary_hold: nil, event_based_hold: nil,
                         user_project: nil
           params =
-            { cache_control: cache_control, content_type: content_type,
+            { cache_control: cache_control, content_type: content_type, custom_time: custom_time,
               content_disposition: content_disposition, md5_hash: md5,
               content_encoding: content_encoding, crc32c: crc32c,
               content_language: content_language, metadata: metadata,

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

@@ -16,7 +16,7 @@
 module Google
   module Cloud
     module Storage
-      VERSION = "1.27.0".freeze
+      VERSION = "1.28.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.27.0
+  version: 1.28.0
 platform: ruby
 authors:
 - Mike Moore
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-07-29 00:00:00.000000000 Z
+date: 2020-08-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-cloud-core
@@ -298,7 +298,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.3
+rubyforge_project: 
+rubygems_version: 2.6.14.4
 signing_key: 
 specification_version: 4
 summary: API Client library for Google Cloud Storage