google-cloud-pubsub 1.3.1 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f26c2a38c13ef273ff8229e9dadb5d8aba0801d5c29b48259565034a047f8aed
-  data.tar.gz: de65d5a0bc5f33f08e59746c355ede1aa56ecccddcfc316450008a9f4f2803d9
+  metadata.gz: 2ba8847f393a5fc464ab63f9d6bca1a7e501c8457afa477486a9bd9c44e6d126
+  data.tar.gz: '034684fa844d264673c7e79ea17deeea9edc329de16376863e736a5f0825c256'
 SHA512:
-  metadata.gz: d97089f6027ead3a45ef47f728b6f9453be23b22edba0e01419a89d549045b262f2ea6ba5c10faa49d4743a33b36dcb2f556bdfd57e307f8bb41499c2a23f030
-  data.tar.gz: dc4246d15947e550dc362e68ef7713fed3a272d7eb2ac86e0642f6b717a1143c41f9c23069536176ede2668a93eaeea6496c6bf4224f7d7586a3df29e3b234a4
+  metadata.gz: 8a0e87a57f3fbb1522fd4cf5d93d1c0e03e10ecc5cd2c65b2f0ecfc8aabda230370f6118e9f52c9aadc4763ada09ff6bd0128539fa6469f68d22a327292f3403
+  data.tar.gz: b18e4d310dbfa486b4b40ed4a6bd657c484c4416517b890bc65889644f928d523b8c447b9b0d3b15980cc80673a9fc2ec3927a6eaff9dd742038f999ac51cee0

data/CHANGELOG.md

@@ -1,5 +1,20 @@
 # Release History
 
+### 1.4.0 / 2020-03-11
+
+#### Features
+
+*  Rename Subscriber inventory methods and params
+  * Rename Subscriber#inventory_limit to #max_outstanding_messages
+  * Rename Subscriber#bytesize to #max_outstanding_bytes
+  * Rename Subscriber#extension to #max_total_lease_duration
+  * Add deprecated aliases for the original methods
+* Support separate project setting for quota/billing
+
+#### Documentation
+
+* Update documentation in the lower-level client
+
 ### 1.3.1 / 2020-02-18
 
 #### Bug Fixes

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

@@ -82,11 +82,7 @@ module Google
           @subscription_name = subscription_name
           @deadline = deadline || 60
           @streams = streams || 2
-          @inventory = inventory
-          @inventory = { limit: @inventory } unless inventory.is_a? Hash
-          @inventory[:limit] = Integer(@inventory[:limit] || 1000)
-          @inventory[:bytesize] = Integer(@inventory[:bytesize] || 100_000_000)
-          @inventory[:extension] = Integer(@inventory[:extension] || 3600)
+          coerce_inventory inventory
           @message_ordering = message_ordering
           @callback_threads = Integer(threads[:callback] || 8)
           @push_threads = Integer(threads[:push] || 4)
@@ -283,31 +279,37 @@ module Google
 
         ##
         # The number of received messages to be collected by subscriber. Default is 1,000.
-        def inventory_limit
-          @inventory[:limit]
+        def max_outstanding_messages
+          @inventory[:max_outstanding_messages]
         end
-        # @deprecated Use {#inventory_limit}.
-        alias inventory inventory_limit
+        # @deprecated Use {#max_outstanding_messages}.
+        alias inventory_limit max_outstanding_messages
+        # @deprecated Use {#max_outstanding_messages}.
+        alias inventory max_outstanding_messages
 
         ##
-        # The total bytesize of received messages to be collected by subscriber. Default is 100,000,000 (100MB).
-        def inventory_bytesize
-          @inventory[:bytesize]
+        # The total byte size of received messages to be collected by subscriber. Default is 100,000,000 (100MB).
+        def max_outstanding_bytes
+          @inventory[:max_outstanding_bytes]
         end
+        # @deprecated Use {#max_outstanding_bytes}.
+        alias inventory_bytesize max_outstanding_bytes
 
         ##
         # The number of seconds that received messages can be held awaiting processing. Default is 3,600 (1 hour).
-        def inventory_extension
-          @inventory[:extension]
+        def max_total_lease_duration
+          @inventory[:max_total_lease_duration]
         end
+        # @deprecated Use {#max_total_lease_duration}.
+        alias inventory_extension max_total_lease_duration
 
         ##
         # @private
         def stream_inventory
           {
-            limit:     @inventory[:limit].fdiv(@streams).ceil,
-            bytesize:  @inventory[:bytesize].fdiv(@streams).ceil,
-            extension: @inventory[:extension]
+            limit:     @inventory[:max_outstanding_messages].fdiv(@streams).ceil,
+            bytesize:  @inventory[:max_outstanding_bytes].fdiv(@streams).ceil,
+            extension: @inventory[:max_total_lease_duration]
           }
         end
 
@@ -335,6 +337,22 @@ module Google
 
         protected
 
+        def coerce_inventory inventory
+          @inventory = inventory
+          if @inventory.is_a? Hash
+            @inventory = @inventory.dup
+            # Support deprecated field names
+            @inventory[:max_outstanding_messages] ||= @inventory.delete :limit
+            @inventory[:max_outstanding_bytes] ||= @inventory.delete :bytesize
+            @inventory[:max_total_lease_duration] ||= @inventory.delete :extension
+          else
+            @inventory = { max_outstanding_messages: @inventory }
+          end
+          @inventory[:max_outstanding_messages] = Integer(@inventory[:max_outstanding_messages] || 1000)
+          @inventory[:max_outstanding_bytes] = Integer(@inventory[:max_outstanding_bytes] || 100_000_000)
+          @inventory[:max_total_lease_duration] = Integer(@inventory[:max_total_lease_duration] || 3600)
+        end
+
         def default_error_callbacks
           # This is memoized to reduce calls to the configuration.
           @default_error_callbacks ||= begin

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

@@ -693,11 +693,12 @@ module Google
         #
         #   Hash keys and values may include the following:
         #
-        #     * `:limit` (Integer) The number of received messages to be collected by subscriber. Default is 1,000.
-        #     * `:bytesize` (Integer) The total bytesize of received messages to be collected by subscriber. Default is
-        #       100,000,000 (100MB).
-        #     * `:extension` (Integer) The number of seconds that received messages can be held awaiting processing.
-        #       Default is 3,600 (1 hour).
+        #     * `:max_outstanding_messages` [Integer] The number of received messages to be collected by subscriber.
+        #       Default is 1,000. (Note: replaces `:limit`, which is deprecated.)
+        #     * `:max_outstanding_bytes` [Integer] The total byte size of received messages to be collected by
+        #       subscriber. Default is 100,000,000 (100MB). (Note: replaces `:bytesize`, which is deprecated.)
+        #     * `:max_total_lease_duration` [Integer] The number of seconds that received messages can be held awaiting
+        #       processing. Default is 3,600 (1 hour). (Note: replaces `:extension`, which is deprecated.)
         # @param [Hash] threads The number of threads to create to handle
         #   concurrent calls by each stream opened by the subscriber. Optional.
         #

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

@@ -105,8 +105,8 @@ module Google
       #     Required. The updated topic object.
       # @!attribute [rw] update_mask
       #   @return [Google::Protobuf::FieldMask]
-      #     Required. Indicates which fields in the provided topic to update. Must be specified
-      #     and non-empty. Note that if `update_mask` contains
+      #     Required. Indicates which fields in the provided topic to update. Must be
+      #     specified and non-empty. Note that if `update_mask` contains
       #     "message_storage_policy" then the new value will be determined based on the
       #     policy configured at the project or organization level. The
       #     `message_storage_policy` must not be set in the `topic` provided above.
@@ -184,7 +184,7 @@ module Google
       # Request for the `ListTopicSnapshots` method.
       # @!attribute [rw] topic
       #   @return [String]
-      #     The name of the topic that snapshots are attached to.
+      #     Required. The name of the topic that snapshots are attached to.
       #     Format is `projects/{project}/topics/{topic}`.
       # @!attribute [rw] page_size
       #   @return [Integer]
@@ -225,10 +225,9 @@ module Google
       #     in length, and it must not start with `"goog"`.
       # @!attribute [rw] topic
       #   @return [String]
-      #     Required. The name of the topic from which this subscription is receiving messages.
-      #     Format is `projects/{project}/topics/{topic}`.
-      #     The value of this field will be `_deleted-topic_` if the topic has been
-      #     deleted.
+      #     Required. The name of the topic from which this subscription is receiving
+      #     messages. Format is `projects/{project}/topics/{topic}`. The value of this
+      #     field will be `_deleted-topic_` if the topic has been deleted.
       # @!attribute [rw] push_config
       #   @return [Google::Cloud::PubSub::V1::PushConfig]
       #     If push delivery is used with this subscription, this field is
@@ -507,14 +506,17 @@ module Google
       #     Format is `projects/{project}/subscriptions/{sub}`.
       # @!attribute [rw] return_immediately
       #   @return [true, false]
-      #     If this field set to true, the system will respond immediately even if
-      #     it there are no messages available to return in the `Pull` response.
-      #     Otherwise, the system may wait (for a bounded amount of time) until at
-      #     least one message is available, rather than returning no messages.
+      #     Optional. If this field set to true, the system will respond immediately
+      #     even if it there are no messages available to return in the `Pull`
+      #     response. Otherwise, the system may wait (for a bounded amount of time)
+      #     until at least one message is available, rather than returning no messages.
+      #     Warning: setting this field to `true` is discouraged because it adversely
+      #     impacts the performance of `Pull` operations. We recommend that users do
+      #     not set this field.
       # @!attribute [rw] max_messages
       #   @return [Integer]
-      #     Required. The maximum number of messages to return for this request. Must be a
-      #     positive integer. The Pub/Sub system may return fewer than the number
+      #     Required. The maximum number of messages to return for this request. Must
+      #     be a positive integer. The Pub/Sub system may return fewer than the number
       #     specified.
       class PullRequest; end
 
@@ -537,10 +539,10 @@ module Google
       #     Required. List of acknowledgment IDs.
       # @!attribute [rw] ack_deadline_seconds
       #   @return [Integer]
-      #     Required. The new ack deadline with respect to the time this request was sent to
-      #     the Pub/Sub system. For example, if the value is 10, the new
-      #     ack deadline will expire 10 seconds after the `ModifyAckDeadline` call
-      #     was made. Specifying zero might immediately make the message available for
+      #     Required. The new ack deadline with respect to the time this request was
+      #     sent to the Pub/Sub system. For example, if the value is 10, the new ack
+      #     deadline will expire 10 seconds after the `ModifyAckDeadline` call was
+      #     made. Specifying zero might immediately make the message available for
       #     delivery to another subscriber client. This typically results in an
       #     increase in the rate of message redeliveries (that is, duplicates).
       #     The minimum deadline you can specify is 0 seconds.
@@ -554,8 +556,9 @@ module Google
       #     Format is `projects/{project}/subscriptions/{sub}`.
       # @!attribute [rw] ack_ids
       #   @return [Array<String>]
-      #     Required. The acknowledgment ID for the messages being acknowledged that was returned
-      #     by the Pub/Sub system in the `Pull` response. Must not be empty.
+      #     Required. The acknowledgment ID for the messages being acknowledged that
+      #     was returned by the Pub/Sub system in the `Pull` response. Must not be
+      #     empty.
       class AcknowledgeRequest; end
 
       # Request for the `StreamingPull` streaming RPC method. This request is used to
@@ -563,8 +566,8 @@ module Google
       # deadline modifications from the client to the server.
       # @!attribute [rw] subscription
       #   @return [String]
-      #     Required. The subscription for which to initialize the new stream. This must be
-      #     provided in the first request on the stream, and must not be set in
+      #     Required. The subscription for which to initialize the new stream. This
+      #     must be provided in the first request on the stream, and must not be set in
       #     subsequent requests from client to server.
       #     Format is `projects/{project}/subscriptions/{sub}`.
       # @!attribute [rw] ack_ids
@@ -596,8 +599,8 @@ module Google
       #     processing was interrupted.
       # @!attribute [rw] stream_ack_deadline_seconds
       #   @return [Integer]
-      #     Required. The ack deadline to use for the stream. This must be provided in the
-      #     first request on the stream, but it can also be updated on subsequent
+      #     Required. The ack deadline to use for the stream. This must be provided in
+      #     the first request on the stream, but it can also be updated on subsequent
       #     requests from client to server. The minimum deadline you can specify is 10
       #     seconds. The maximum deadline you can specify is 600 seconds (10 minutes).
       # @!attribute [rw] client_id
@@ -620,10 +623,10 @@ module Google
       # Request for the `CreateSnapshot` method.
       # @!attribute [rw] name
       #   @return [String]
-      #     Required. User-provided name for this snapshot. If the name is not provided in the
-      #     request, the server will assign a random name for this snapshot on the same
-      #     project as the subscription. Note that for REST API requests, you must
-      #     specify a name.  See the <a
+      #     Required. User-provided name for this snapshot. If the name is not provided
+      #     in the request, the server will assign a random name for this snapshot on
+      #     the same project as the subscription. Note that for REST API requests, you
+      #     must specify a name.  See the <a
       #     href="https://cloud.google.com/pubsub/docs/admin#resource_names"> resource
       #     name rules</a>. Format is `projects/{project}/snapshots/{snap}`.
       # @!attribute [rw] subscription

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

@@ -198,6 +198,9 @@ module Google
             google_api_client.freeze
 
             headers = { :"x-goog-api-client" => google_api_client }
+            if credentials.respond_to?(:quota_project_id) && credentials.quota_project_id
+              headers[:"x-goog-user-project"] = credentials.quota_project_id
+            end
             headers.merge!(metadata) unless metadata.nil?
             client_config_file = Pathname.new(__dir__).join(
               "publisher_client_config.json"
@@ -390,8 +393,8 @@ module Google
           #   A hash of the same form as `Google::Cloud::PubSub::V1::Topic`
           #   can also be provided.
           # @param update_mask [Google::Protobuf::FieldMask | Hash]
-          #   Required. Indicates which fields in the provided topic to update. Must be specified
-          #   and non-empty. Note that if `update_mask` contains
+          #   Required. Indicates which fields in the provided topic to update. Must be
+          #   specified and non-empty. Note that if `update_mask` contains
           #   "message_storage_policy" then the new value will be determined based on the
           #   policy configured at the project or organization level. The
           #   `message_storage_policy` must not be set in the `topic` provided above.

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

@@ -222,6 +222,9 @@ module Google
             google_api_client.freeze
 
             headers = { :"x-goog-api-client" => google_api_client }
+            if credentials.respond_to?(:quota_project_id) && credentials.quota_project_id
+              headers[:"x-goog-user-project"] = credentials.quota_project_id
+            end
             headers.merge!(metadata) unless metadata.nil?
             client_config_file = Pathname.new(__dir__).join(
               "subscriber_client_config.json"
@@ -431,10 +434,9 @@ module Google
           #   plus (`+`) or percent signs (`%`). It must be between 3 and 255 characters
           #   in length, and it must not start with `"goog"`.
           # @param topic [String]
-          #   Required. The name of the topic from which this subscription is receiving messages.
-          #   Format is `projects/{project}/topics/{topic}`.
-          #   The value of this field will be `_deleted-topic_` if the topic has been
-          #   deleted.
+          #   Required. The name of the topic from which this subscription is receiving
+          #   messages. Format is `projects/{project}/topics/{topic}`. The value of this
+          #   field will be `_deleted-topic_` if the topic has been deleted.
           # @param push_config [Google::Cloud::PubSub::V1::PushConfig | Hash]
           #   If push delivery is used with this subscription, this field is
           #   used to configure it. An empty `pushConfig` signifies that the subscriber
@@ -735,10 +737,10 @@ module Google
           # @param ack_ids [Array<String>]
           #   Required. List of acknowledgment IDs.
           # @param ack_deadline_seconds [Integer]
-          #   Required. The new ack deadline with respect to the time this request was sent to
-          #   the Pub/Sub system. For example, if the value is 10, the new
-          #   ack deadline will expire 10 seconds after the `ModifyAckDeadline` call
-          #   was made. Specifying zero might immediately make the message available for
+          #   Required. The new ack deadline with respect to the time this request was
+          #   sent to the Pub/Sub system. For example, if the value is 10, the new ack
+          #   deadline will expire 10 seconds after the `ModifyAckDeadline` call was
+          #   made. Specifying zero might immediately make the message available for
           #   delivery to another subscriber client. This typically results in an
           #   increase in the rate of message redeliveries (that is, duplicates).
           #   The minimum deadline you can specify is 0 seconds.
@@ -791,8 +793,9 @@ module Google
           #   Required. The subscription whose message is being acknowledged.
           #   Format is `projects/{project}/subscriptions/{sub}`.
           # @param ack_ids [Array<String>]
-          #   Required. The acknowledgment ID for the messages being acknowledged that was returned
-          #   by the Pub/Sub system in the `Pull` response. Must not be empty.
+          #   Required. The acknowledgment ID for the messages being acknowledged that
+          #   was returned by the Pub/Sub system in the `Pull` response. Must not be
+          #   empty.
           # @param options [Google::Gax::CallOptions]
           #   Overrides the default settings for this call, e.g, timeout,
           #   retries, etc.
@@ -832,14 +835,17 @@ module Google
           #   Required. The subscription from which messages should be pulled.
           #   Format is `projects/{project}/subscriptions/{sub}`.
           # @param max_messages [Integer]
-          #   Required. The maximum number of messages to return for this request. Must be a
-          #   positive integer. The Pub/Sub system may return fewer than the number
+          #   Required. The maximum number of messages to return for this request. Must
+          #   be a positive integer. The Pub/Sub system may return fewer than the number
           #   specified.
           # @param return_immediately [true, false]
-          #   If this field set to true, the system will respond immediately even if
-          #   it there are no messages available to return in the `Pull` response.
-          #   Otherwise, the system may wait (for a bounded amount of time) until at
-          #   least one message is available, rather than returning no messages.
+          #   Optional. If this field set to true, the system will respond immediately
+          #   even if it there are no messages available to return in the `Pull`
+          #   response. Otherwise, the system may wait (for a bounded amount of time)
+          #   until at least one message is available, rather than returning no messages.
+          #   Warning: setting this field to `true` is discouraged because it adversely
+          #   impacts the performance of `Pull` operations. We recommend that users do
+          #   not set this field.
           # @param options [Google::Gax::CallOptions]
           #   Overrides the default settings for this call, e.g, timeout,
           #   retries, etc.
@@ -1047,10 +1053,10 @@ module Google
           # REST API requests, you must specify a name in the request.
           #
           # @param name [String]
-          #   Required. User-provided name for this snapshot. If the name is not provided in the
-          #   request, the server will assign a random name for this snapshot on the same
-          #   project as the subscription. Note that for REST API requests, you must
-          #   specify a name.  See the <a
+          #   Required. User-provided name for this snapshot. If the name is not provided
+          #   in the request, the server will assign a random name for this snapshot on
+          #   the same project as the subscription. Note that for REST API requests, you
+          #   must specify a name.  See the <a
           #   href="https://cloud.google.com/pubsub/docs/admin#resource_names"> resource
           #   name rules</a>. Format is `projects/{project}/snapshots/{snap}`.
           # @param subscription [String]

data/lib/google/cloud/pubsub/v1/subscriber_client_config.json

@@ -32,9 +32,9 @@
           "initial_retry_delay_millis": 100,
           "retry_delay_multiplier": 1.3,
           "max_retry_delay_millis": 60000,
-          "initial_rpc_timeout_millis": 5000,
-          "rpc_timeout_multiplier": 1.3,
-          "max_rpc_timeout_millis": 600000,
+          "initial_rpc_timeout_millis": 25000,
+          "rpc_timeout_multiplier": 1.0,
+          "max_rpc_timeout_millis": 25000,
           "total_timeout_millis": 600000
         },
         "streaming_messaging": {

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

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

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

@@ -4,6 +4,7 @@
 
 require 'google/protobuf'
 
+require 'google/api/annotations_pb'
 require 'google/api/client_pb'
 require 'google/api/field_behavior_pb'
 require 'google/api/resource_pb'
@@ -11,7 +12,6 @@ require 'google/protobuf/duration_pb'
 require 'google/protobuf/empty_pb'
 require 'google/protobuf/field_mask_pb'
 require 'google/protobuf/timestamp_pb'
-require 'google/api/annotations_pb'
 Google::Protobuf::DescriptorPool.generated_pool.build do
   add_message "google.pubsub.v1.MessageStoragePolicy" do
     repeated :allowed_persistence_regions, :string, 1

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

@@ -1,7 +1,7 @@
 # Generated by the protocol buffer compiler.  DO NOT EDIT!
 # Source: google/pubsub/v1/pubsub.proto for package 'Google::Cloud::PubSub::V1'
 # Original file comments:
-# Copyright 2019 Google LLC.
+# Copyright 2020 Google LLC
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -15,7 +15,6 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
-#
 
 
 require 'grpc'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-pubsub
 version: !ruby/object:Gem::Version
-  version: 1.3.1
+  version: 1.4.0
 platform: ruby
 authors:
 - Mike Moore
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-02-18 00:00:00.000000000 Z
+date: 2020-03-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby