google-cloud-pubsub 1.7.1 → 1.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 25d3602668077c7dee90a868dcc01353710ac3001ece8ebe92b7acc6c7bc1bb3
-  data.tar.gz: 2119781ea548d6e87d201bdb759643c7ac78b7ffab0a4ee7505f731c3c812670
+  metadata.gz: dfbd62e0e48c406ed08325e5a216f03a0afc4f8319c5ef144fbb6b1fa189e16c
+  data.tar.gz: 31995baf9d81c17e1c867efb5584da5d0be27e1baa3bfa256311e803d43cbfb9
 SHA512:
-  metadata.gz: ed1de151bbd790feb886162024dbe20e75825c7313de7f0349468d8adbdf0400ce0616f53925315a1a2558b2683fd9ac8b478b842b2008dae67990676c163a4b
-  data.tar.gz: 2247b98b5f04c936bd908c7a517d396e03af0f07030e7939282f750d8d2b9f569f428961c793f929d5595da60445a55948fe17864a1f25f1ab7d1746b06be9c0
+  metadata.gz: 8d50149459ec7bc696a15785ae7f0d77777d9f95edefb4da0775f9e005c25cd8cfe17d20899649fb17c6fc928eb9e0bbc0baddce26afc773d300c54728b04bd6
+  data.tar.gz: b599664094c01fc88030478e9076ad72a73ceb6bb3aa4b3a64240193694f0d47f6a34bbbd2ab8ce1188c45d6bbd6322d91e91f157362de0a8a6307c002e6084a

data/CHANGELOG.md

@@ -1,5 +1,17 @@
 # Release History
 
+### 1.9.0 / 2020-07-21
+
+#### Features
+
+* Add support for server-side flow control
+
+### 1.8.0 / 2020-06-29
+
+#### Features
+
+* Add Subscription#filter
+
 ### 1.7.1 / 2020-05-28
 
 #### Documentation

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

@@ -241,20 +241,17 @@ module Google
                             push_endpoint: options[:endpoint],
                             attributes:    (options[:attributes] || {}).to_h
                         end
-          deadline = options[:deadline]
-          retain_acked = options[:retain_acked]
           mrd = Convert.number_to_duration options[:retention]
-          labels = options[:labels]
-          message_ordering = options[:message_ordering]
           execute do
             subscriber.create_subscription \
               name, topic,
               push_config:                push_config,
-              ack_deadline_seconds:       deadline,
-              retain_acked_messages:      retain_acked,
+              ack_deadline_seconds:       options[:deadline],
+              retain_acked_messages:      options[:retain_acked],
               message_retention_duration: mrd,
-              labels:                     labels,
-              enable_message_ordering:    message_ordering,
+              labels:                     options[:labels],
+              enable_message_ordering:    options[:message_ordering],
+              filter:                     options[:filter],
               dead_letter_policy:         dead_letter_policy(options),
               retry_policy:               options[:retry_policy],
               options:                    default_options

data/lib/google/cloud/pubsub/subscriber/stream.rb

@@ -364,6 +364,8 @@ module Google
               req.modify_deadline_ack_ids += @inventory.ack_ids
               req.modify_deadline_seconds += @inventory.ack_ids.map { @subscriber.deadline }
               req.client_id = @subscriber.service.client_id
+              req.max_outstanding_messages = @inventory.limit
+              req.max_outstanding_bytes = @inventory.bytesize
             end
           end
 

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

@@ -353,6 +353,18 @@ module Google
           @resource_name = nil
         end
 
+        ##
+        # An expression written in the Cloud Pub/Sub filter language. If non-empty, then only {Message} instances whose
+        # `attributes` field matches the filter are delivered on this subscription. If empty, then no messages are
+        # filtered out.
+        #
+        # @return [String] The frozen filter string.
+        #
+        def filter
+          ensure_grpc!
+          @grpc.filter.freeze
+        end
+
         ##
         # Returns the {Topic} to which dead letter messages should be published if a dead letter policy is configured,
         # otherwise `nil`. Dead lettering is done on a best effort basis. The same message might be dead lettered

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

@@ -286,6 +286,9 @@ module Google
         #   Managing Labels](https://cloud.google.com/pubsub/docs/labels).
         # @param [Boolean] message_ordering Whether to enable message ordering
         #   on the subscription.
+        # @param [String] filter An expression written in the Cloud Pub/Sub filter language. If non-empty, then only
+        #   {Message} instances whose `attributes` field matches the filter are delivered on this subscription. If
+        #   empty, then no messages are filtered out. Optional.
         # @param [Topic] dead_letter_topic The {Topic} to which dead letter messages for the subscription should be
         #   published. Dead lettering is done on a best effort basis. The same message might be dead lettered multiple
         #   times. The Cloud Pub/Sub service account associated with the enclosing subscription's parent project (i.e.,
@@ -359,11 +362,11 @@ module Google
         #   sub = topic.subscribe "my-topic-sub", retry_policy: retry_policy
         #
         def subscribe subscription_name, deadline: nil, retain_acked: false, retention: nil, endpoint: nil, labels: nil,
-                      message_ordering: nil, dead_letter_topic: nil, dead_letter_max_delivery_attempts: nil,
-                      retry_policy: nil
+                      message_ordering: nil, filter: nil, dead_letter_topic: nil,
+                      dead_letter_max_delivery_attempts: nil, retry_policy: nil
           ensure_service!
           options = { deadline: deadline, retain_acked: retain_acked, retention: retention, endpoint: endpoint,
-                      labels: labels, message_ordering: message_ordering,
+                      labels: labels, message_ordering: message_ordering, filter: filter,
                       dead_letter_max_delivery_attempts: dead_letter_max_delivery_attempts }
           options[:dead_letter_topic_name] = dead_letter_topic.name if dead_letter_topic
           if options[:dead_letter_max_delivery_attempts] && !options[:dead_letter_topic_name]

data/lib/google/cloud/pubsub/v1/doc/google/pubsub/v1/pubsub.rb

@@ -17,6 +17,7 @@ module Google
   module Cloud
   module PubSub
     module V1
+      # A policy constraining the storage of messages published to the topic.
       # @!attribute [rw] allowed_persistence_regions
       #   @return [Array<String>]
       #     A list of IDs of GCP regions where messages that are published to the topic
@@ -67,7 +68,8 @@ module Google
       # @!attribute [rw] attributes
       #   @return [Hash{String => String}]
       #     Attributes for this message. If this field is empty, the message must
-      #     contain non-empty data.
+      #     contain non-empty data. This can be used to filter messages on the
+      #     subscription.
       # @!attribute [rw] message_id
       #   @return [String]
       #     ID of this message, assigned by the server when the message is published.
@@ -306,13 +308,11 @@ module Google
       #     value for `expiration_policy.ttl` is 1 day.
       # @!attribute [rw] filter
       #   @return [String]
-      #     An expression written in the Cloud Pub/Sub filter language. If non-empty,
+      #     An expression written in the Pub/Sub [filter
+      #     language](https://cloud.google.com/pubsub/docs/filtering). If non-empty,
       #     then only `PubsubMessage`s whose `attributes` field matches the filter are
       #     delivered on this subscription. If empty, then no messages are filtered
       #     out.
-      #     <b>EXPERIMENTAL:</b> This feature is part of a closed alpha release. This
-      #     API might be changed in backward-incompatible ways and is not recommended
-      #     for production use. It is not subject to any SLA or deprecation policy.
       # @!attribute [rw] dead_letter_policy
       #   @return [Google::Cloud::PubSub::V1::DeadLetterPolicy]
       #     A policy that specifies the conditions for dead lettering messages in
@@ -325,16 +325,20 @@ module Google
       #     permission to Acknowledge() messages on this subscription.
       # @!attribute [rw] retry_policy
       #   @return [Google::Cloud::PubSub::V1::RetryPolicy]
-      #     A policy that specifies how Cloud Pub/Sub retries message delivery for this
+      #     A policy that specifies how Pub/Sub retries message delivery for this
       #     subscription.
       #
       #     If not set, the default retry policy is applied. This generally implies
       #     that messages will be retried as soon as possible for healthy subscribers.
       #     RetryPolicy will be triggered on NACKs or acknowledgement deadline
       #     exceeded events for a given message.
-      #     <b>EXPERIMENTAL:</b> This API might be changed in backward-incompatible
-      #     ways and is not recommended for production use. It is not subject to any
-      #     SLA or deprecation policy.
+      # @!attribute [rw] detached
+      #   @return [true, false]
+      #     Indicates whether the subscription is detached from its topic. Detached
+      #     subscriptions don't receive messages from their topic and don't retain any
+      #     backlog. `Pull` and `StreamingPull` requests will return
+      #     FAILED_PRECONDITION. If the subscription is a push subscription, pushes to
+      #     the endpoint will not be made.
       class Subscription; end
 
       # A policy that specifies how Cloud Pub/Sub retries message delivery.
@@ -661,6 +665,28 @@ module Google
       #     to the same value so that state associated with the old stream can be
       #     transferred to the new stream. The same client_id should not be used for
       #     different client instances.
+      # @!attribute [rw] max_outstanding_messages
+      #   @return [Integer]
+      #     Flow control settings for the maximum number of outstanding messages. When
+      #     there are `max_outstanding_messages` or more currently sent to the
+      #     streaming pull client that have not yet been acked or nacked, the server
+      #     stops sending more messages. The sending of messages resumes once the
+      #     number of outstanding messages is less than this value. If the value is
+      #     <= 0, there is no limit to the number of outstanding messages. This
+      #     property can only be set on the initial StreamingPullRequest. If it is set
+      #     on a subsequent request, the stream will be aborted with status
+      #     `INVALID_ARGUMENT`.
+      # @!attribute [rw] max_outstanding_bytes
+      #   @return [Integer]
+      #     Flow control settings for the maximum number of outstanding bytes. When
+      #     there are `max_outstanding_bytes` or more worth of messages currently sent
+      #     to the streaming pull client that have not yet been acked or nacked, the
+      #     server will stop sending more messages. The sending of messages resumes
+      #     once the number of outstanding bytes is less than this value. If the value
+      #     is <= 0, there is no limit to the number of outstanding bytes. This
+      #     property can only be set on the initial StreamingPullRequest. If it is set
+      #     on a subsequent request, the stream will be aborted with status
+      #     `INVALID_ARGUMENT`.
       class StreamingPullRequest; end
 
       # Response for the `StreamingPull` method. This response is used to stream

data/lib/google/cloud/pubsub/v1/subscriber_client.rb

@@ -510,13 +510,11 @@ module Google
           #   A hash of the same form as `Google::Cloud::PubSub::V1::ExpirationPolicy`
           #   can also be provided.
           # @param filter [String]
-          #   An expression written in the Cloud Pub/Sub filter language. If non-empty,
+          #   An expression written in the Pub/Sub [filter
+          #   language](https://cloud.google.com/pubsub/docs/filtering). If non-empty,
           #   then only `PubsubMessage`s whose `attributes` field matches the filter are
           #   delivered on this subscription. If empty, then no messages are filtered
           #   out.
-          #   <b>EXPERIMENTAL:</b> This feature is part of a closed alpha release. This
-          #   API might be changed in backward-incompatible ways and is not recommended
-          #   for production use. It is not subject to any SLA or deprecation policy.
           # @param dead_letter_policy [Google::Cloud::PubSub::V1::DeadLetterPolicy | Hash]
           #   A policy that specifies the conditions for dead lettering messages in
           #   this subscription. If dead_letter_policy is not set, dead lettering
@@ -529,18 +527,21 @@ module Google
           #   A hash of the same form as `Google::Cloud::PubSub::V1::DeadLetterPolicy`
           #   can also be provided.
           # @param retry_policy [Google::Cloud::PubSub::V1::RetryPolicy | Hash]
-          #   A policy that specifies how Cloud Pub/Sub retries message delivery for this
+          #   A policy that specifies how Pub/Sub retries message delivery for this
           #   subscription.
           #
           #   If not set, the default retry policy is applied. This generally implies
           #   that messages will be retried as soon as possible for healthy subscribers.
           #   RetryPolicy will be triggered on NACKs or acknowledgement deadline
           #   exceeded events for a given message.
-          #   <b>EXPERIMENTAL:</b> This API might be changed in backward-incompatible
-          #   ways and is not recommended for production use. It is not subject to any
-          #   SLA or deprecation policy.
           #   A hash of the same form as `Google::Cloud::PubSub::V1::RetryPolicy`
           #   can also be provided.
+          # @param detached [true, false]
+          #   Indicates whether the subscription is detached from its topic. Detached
+          #   subscriptions don't receive messages from their topic and don't retain any
+          #   backlog. `Pull` and `StreamingPull` requests will return
+          #   FAILED_PRECONDITION. If the subscription is a push subscription, pushes to
+          #   the endpoint will not be made.
           # @param options [Google::Gax::CallOptions]
           #   Overrides the default settings for this call, e.g, timeout,
           #   retries, etc.
@@ -570,6 +571,7 @@ module Google
               filter: nil,
               dead_letter_policy: nil,
               retry_policy: nil,
+              detached: nil,
               options: nil,
               &block
             req = {
@@ -584,7 +586,8 @@ module Google
               expiration_policy: expiration_policy,
               filter: filter,
               dead_letter_policy: dead_letter_policy,
-              retry_policy: retry_policy
+              retry_policy: retry_policy,
+              detached: detached
             }.delete_if { |_, v| v.nil? }
             req = Google::Gax::to_proto(req, Google::Cloud::PubSub::V1::Subscription)
             @create_subscription.call(req, options, &block)

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

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

data/lib/google/pubsub/v1/pubsub_pb.rb

@@ -91,6 +91,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
     optional :filter, :string, 12
     optional :dead_letter_policy, :message, 13, "google.pubsub.v1.DeadLetterPolicy"
     optional :retry_policy, :message, 14, "google.pubsub.v1.RetryPolicy"
+    optional :detached, :bool, 15
   end
   add_message "google.pubsub.v1.RetryPolicy" do
     optional :minimum_backoff, :message, 1, "google.protobuf.Duration"
@@ -166,6 +167,8 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
     repeated :modify_deadline_ack_ids, :string, 4
     optional :stream_ack_deadline_seconds, :int32, 5
     optional :client_id, :string, 6
+    optional :max_outstanding_messages, :int64, 7
+    optional :max_outstanding_bytes, :int64, 8
   end
   add_message "google.pubsub.v1.StreamingPullResponse" do
     repeated :received_messages, :message, 1, "google.pubsub.v1.ReceivedMessage"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-pubsub
 version: !ruby/object:Gem::Version
-  version: 1.7.1
+  version: 1.9.0
 platform: ruby
 authors:
 - Mike Moore
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-05-28 00:00:00.000000000 Z
+date: 2020-07-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -330,7 +330,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
+rubygems_version: 3.1.3
 signing_key: 
 specification_version: 4
 summary: API Client library for Google Cloud Pub/Sub