google-cloud-pubsub 2.7.1 → 2.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 55eb80f365cf82b22f7cb9383a88155e0c79e0d5c1e897f2c7ee6cb974e2989b
-  data.tar.gz: 4417a272576757638dbe5b122e832412303f55761fb6d4d9ae24706ecdc9842f
+  metadata.gz: 5d702b4f68714fc0deb23b437d1df3f6a9f7d1d13c0e7b4f4fe40dcf7a48cae2
+  data.tar.gz: 1cd4c417d8e44532b10a69c1f6cb824b402ede9ba38731a29315c9b1a2743e16
 SHA512:
-  metadata.gz: 8c1a8a9c9e62d737a468fbaca9c3909be1c608ec64d223f7ade2a478870c4e275cfad10e8c743dd213ce2f3d9084271f29cca6ba91205cda224177897d174016
-  data.tar.gz: 96cd5e4e593894f6c98401c9dff2ca99d7be2acdbb37504f5f53ab72cda2c9e29bde031facd7d779947deb892454716bc151f31d67eddf58b3f8944e46e66018
+  metadata.gz: 6a4b139e6a3170baeb92a8aea0e93196ebc39843deede789ad33545ef149aa2c789e49d5976b98b70954073f29dbfd29079067b6924797e3228f7b5a6fdfc77f
+  data.tar.gz: ca7cdcf23e8121cc27a0f1876dcccc74013adeec27995a95b342b821fc94cae09586f444b7f80e69991ebb01461f4f3a43364b15e54907972f5cde09582388e8

data/CHANGELOG.md

@@ -1,5 +1,15 @@
 # Release History
 
+### 2.8.0 / 2021-08-30
+
+#### Features
+
+* Add Pub/Sub topic retention fields
+  * Add retention to Project#create_topic
+  * Add Topic#retention
+  * Add Topic#retention=
+  * Add Subscription#topic_retention
+
 ### 2.7.1 / 2021-07-08
 
 #### Documentation

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

@@ -238,6 +238,14 @@ module Google
         #   * `JSON` - JSON encoding.
         #   * `BINARY` - Binary encoding, as defined by the schema type. For some
         #     schema types, binary encoding may not be available.
+        # @param [Numeric] retention Indicates the minimum number of seconds to retain a message
+        #   after it is published to the topic. If this field is set, messages published
+        #   to the topic within the `retention` number of seconds are always available to
+        #   subscribers. For instance, it allows any attached subscription to [seek to a
+        #   timestamp](https://cloud.google.com/pubsub/docs/replay-overview#seek_to_a_time)
+        #   that is up to `retention` number of seconds in the past. If this field is
+        #   not set, message retention is controlled by settings on individual
+        #   subscriptions. Cannot be less than 600 (10 minutes) or more than 604,800 (7 days).
         #
         # @return [Google::Cloud::PubSub::Topic]
         #
@@ -253,14 +261,16 @@ module Google
                          persistence_regions: nil,
                          async: nil,
                          schema_name: nil,
-                         message_encoding: nil
+                         message_encoding: nil,
+                         retention: nil
           ensure_service!
           grpc = service.create_topic topic_name,
                                       labels:              labels,
                                       kms_key_name:        kms_key,
                                       persistence_regions: persistence_regions,
                                       schema_name:         schema_name,
-                                      message_encoding:    message_encoding
+                                      message_encoding:    message_encoding,
+                                      retention:           retention
           Topic.from_grpc grpc, service, async: async
         end
         alias new_topic create_topic

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

@@ -127,6 +127,7 @@ module Google
                          persistence_regions: nil,
                          schema_name: nil,
                          message_encoding: nil,
+                         retention: nil,
                          options: {}
           if persistence_regions
             message_storage_policy = Google::Cloud::PubSub::V1::MessageStoragePolicy.new(
@@ -145,11 +146,12 @@ module Google
           end
 
           publisher.create_topic \
-            name:                   topic_path(topic_name, options),
-            labels:                 labels,
-            kms_key_name:           kms_key_name,
-            message_storage_policy: message_storage_policy,
-            schema_settings:        schema_settings
+            name:                       topic_path(topic_name, options),
+            labels:                     labels,
+            kms_key_name:               kms_key_name,
+            message_storage_policy:     message_storage_policy,
+            schema_settings:            schema_settings,
+            message_retention_duration: Convert.number_to_duration(retention)
         end
 
         def update_topic topic_obj, *fields

data/lib/google/cloud/pubsub/subscription.rb

@@ -168,9 +168,8 @@ module Google
         # backlog, from the moment a message is published. If
         # {#retain_acked} is `true`, then this also configures the retention of
         # acknowledged messages, and thus configures how far back in time a
-        # {#seek} can be done. Cannot be more than 604,800 seconds (7 days) or
-        # less than 600 seconds (10 minutes). Default is 604,800 seconds (7
-        # days).
+        # {#seek} can be done. Cannot be less than 600 (10 minutes) or more
+        # than 604,800 (7 days). Default is 604,800 seconds (7 days).
         #
         # Makes an API call to retrieve the retention value when called on a
         # reference object. See {#reference?}.
@@ -195,6 +194,24 @@ module Google
           @resource_name = nil
         end
 
+        ##
+        # Indicates the minimum duration for which a message is retained after
+        # it is published to the subscription's topic. If this field is set,
+        # messages published to the subscription's topic in the last
+        # `topic_message_retention_duration` are always available to subscribers.
+        # Output only. See {Topic#retention}.
+        #
+        # Makes an API call to retrieve the retention value when called on a
+        # reference object. See {#reference?}.
+        #
+        # @return [Numeric, nil] The topic message retention duration in seconds,
+        #   or `nil` if not set.
+        #
+        def topic_retention
+          ensure_grpc!
+          Convert.duration_to_number @grpc.topic_message_retention_duration
+        end
+
         ##
         # Returns the URL locating the endpoint to which messages should be
         # pushed. For example, a Webhook endpoint might use

data/lib/google/cloud/pubsub/topic.rb

@@ -305,6 +305,43 @@ module Google
           message_encoding.to_s.upcase == "JSON"
         end
 
+        ##
+        # Indicates the minimum number of seconds to retain a message after it is
+        # published to the topic. If this field is set, messages published to the topic
+        # within the `retention` number of seconds are always available to subscribers.
+        # For instance, it allows any attached subscription to [seek to a
+        # timestamp](https://cloud.google.com/pubsub/docs/replay-overview#seek_to_a_time)
+        # that is up to `retention` number of seconds in the past. If this field is
+        # not set, message retention is controlled by settings on individual
+        # subscriptions. Cannot be less than 600 (10 minutes) or more than 604,800 (7 days).
+        # See {#retention=}.
+        #
+        # Makes an API call to retrieve the retention value when called on a
+        # reference object. See {#reference?}.
+        #
+        # @return [Numeric, nil] The message retention duration in seconds, or `nil` if not set.
+        #
+        def retention
+          ensure_grpc!
+          Convert.duration_to_number @grpc.message_retention_duration
+        end
+
+        ##
+        # Sets the message retention duration in seconds. If set to a positive duration
+        # between 600 (10 minutes) and 604,800 (7 days), inclusive, the message retention
+        # duration is changed. If set to `nil`, this clears message retention duration
+        # from the topic. See {#retention}.
+        #
+        # @param [Numeric, nil] new_retention The new message retention duration value.
+        #
+        def retention= new_retention
+          new_retention_duration = Convert.number_to_duration new_retention
+          update_grpc = Google::Cloud::PubSub::V1::Topic.new name: name,
+                                                             message_retention_duration: new_retention_duration
+          @grpc = service.update_topic update_grpc, :message_retention_duration
+          @resource_name = nil
+        end
+
         ##
         # Permanently deletes the topic.
         #

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

@@ -16,7 +16,7 @@
 module Google
   module Cloud
     module PubSub
-      VERSION = "2.7.1".freeze
+      VERSION = "2.8.0".freeze
     end
 
     Pubsub = PubSub unless const_defined? :Pubsub

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-pubsub
 version: !ruby/object:Gem::Version
-  version: 2.7.1
+  version: 2.8.0
 platform: ruby
 authors:
 - Mike Moore
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-07-08 00:00:00.000000000 Z
+date: 2021-08-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby