google-cloud-pubsub 2.4.0 → 2.7.1

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

@@ -733,19 +733,28 @@ module Google
         end
 
         ##
-        # Pulls messages from the server. Returns an empty list if there are no
-        # messages available in the backlog. Raises an ApiError with status
-        # `UNAVAILABLE` if there are too many concurrent pull requests pending
-        # for the given subscription.
+        # Pulls messages from the server, blocking until messages are available
+        # when called with the `immediate: false` option, which is recommended
+        # to avoid adverse impacts on the performance of pull operations.
+        #
+        # Raises an API error with status `UNAVAILABLE` if there are too many
+        # concurrent pull requests pending for the given subscription.
         #
         # See also {#listen} for the preferred way to process messages as they
         # become available.
         #
-        # @param [Boolean] immediate When `true` the system will respond
-        #   immediately even if it is not able to return messages. When `false`
-        #   the system is allowed to wait until it can return least one message.
-        #   No messages are returned when a request times out. The default value
-        #   is `true`.
+        # @param [Boolean] immediate Whether to return immediately or block until
+        #   messages are available.
+        #
+        #   **Warning:** The default value of this field is `true`. However, sending
+        #   `true` is discouraged because it adversely impacts the performance of
+        #   pull operations. We recommend that users always explicitly set this field
+        #   to `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.
         #
         #   See also {#listen} for the preferred way to process messages as they
         #   become available.
@@ -755,31 +764,24 @@ module Google
         #
         # @return [Array<Google::Cloud::PubSub::ReceivedMessage>]
         #
-        # @example
+        # @example The `immediate: false` option is now recommended to avoid adverse impacts on pull operations:
         #   require "google/cloud/pubsub"
         #
         #   pubsub = Google::Cloud::PubSub.new
         #
         #   sub = pubsub.subscription "my-topic-sub"
-        #   sub.pull.each { |received_message| received_message.acknowledge! }
-        #
-        # @example A maximum number of messages returned can also be specified:
-        #   require "google/cloud/pubsub"
-        #
-        #   pubsub = Google::Cloud::PubSub.new
-        #
-        #   sub = pubsub.subscription "my-topic-sub"
-        #   sub.pull(max: 10).each do |received_message|
+        #   received_messages = sub.pull immediate: false
+        #   received_messages.each do |received_message|
         #     received_message.acknowledge!
         #   end
         #
-        # @example The call can block until messages are available:
+        # @example A maximum number of messages returned can also be specified:
         #   require "google/cloud/pubsub"
         #
         #   pubsub = Google::Cloud::PubSub.new
         #
         #   sub = pubsub.subscription "my-topic-sub"
-        #   received_messages = sub.pull immediate: false
+        #   received_messages = sub.pull immediate: false, max: 10
         #   received_messages.each do |received_message|
         #     received_message.acknowledge!
         #   end
@@ -1010,7 +1012,7 @@ module Google
         #   pubsub = Google::Cloud::PubSub.new
         #
         #   sub = pubsub.subscription "my-topic-sub"
-        #   received_messages = sub.pull
+        #   received_messages = sub.pull immediate: false
         #   sub.acknowledge received_messages
         #
         def acknowledge *messages
@@ -1045,7 +1047,7 @@ module Google
         #   pubsub = Google::Cloud::PubSub.new
         #
         #   sub = pubsub.subscription "my-topic-sub"
-        #   received_messages = sub.pull
+        #   received_messages = sub.pull immediate: false
         #   sub.modify_ack_deadline 120, received_messages
         #
         def modify_ack_deadline new_deadline, *messages
@@ -1143,7 +1145,7 @@ module Google
         #
         #   snapshot = sub.create_snapshot
         #
-        #   received_messages = sub.pull
+        #   received_messages = sub.pull immediate: false
         #   sub.acknowledge received_messages
         #
         #   sub.seek snapshot
@@ -1156,7 +1158,7 @@ module Google
         #
         #   time = Time.now
         #
-        #   received_messages = sub.pull
+        #   received_messages = sub.pull immediate: false
         #   sub.acknowledge received_messages
         #
         #   sub.seek time

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

@@ -233,6 +233,78 @@ module Google
           @resource_name = nil
         end
 
+        ##
+        # The name of the schema that messages published should be validated against, if schema settings are configured
+        # for the topic. The value is a fully-qualified schema name in the form
+        # `projects/{project_id}/schemas/{schema_id}`. If present, {#message_encoding} should also be present. The value
+        # of this field will be `_deleted-schema_` if the schema has been deleted.
+        #
+        # Makes an API call to retrieve the schema settings when called on a reference object. See {#reference?}.
+        #
+        # @return [String, nil] The schema name, or `nil` if schema settings are not configured for the topic.
+        #
+        # @example
+        #   require "google/cloud/pubsub"
+        #
+        #   pubsub = Google::Cloud::PubSub.new
+        #
+        #   topic = pubsub.topic "my-topic"
+        #
+        #   topic.schema_name #=> "projects/my-project/schemas/my-schema"
+        #
+        def schema_name
+          ensure_grpc!
+          @grpc.schema_settings&.schema
+        end
+
+        ##
+        # The encoding of messages validated against the schema identified by {#schema_name}. If present, {#schema_name}
+        # should also be present. Values include:
+        #
+        # * `JSON` - JSON encoding.
+        # * `BINARY` - Binary encoding, as defined by the schema type. For some schema types, binary encoding may not be
+        #   available.
+        #
+        # Makes an API call to retrieve the schema settings when called on a reference object. See {#reference?}.
+        #
+        # @return [Symbol, nil] The schema encoding, or `nil` if schema settings are not configured for the topic.
+        #
+        # @example
+        #   require "google/cloud/pubsub"
+        #
+        #   pubsub = Google::Cloud::PubSub.new
+        #
+        #   topic = pubsub.topic "my-topic"
+        #
+        #   topic.message_encoding #=> :JSON
+        #
+        def message_encoding
+          ensure_grpc!
+          @grpc.schema_settings&.encoding
+        end
+
+        ##
+        # Checks if the encoding of messages in the schema settings is `BINARY`. See {#message_encoding}.
+        #
+        # Makes an API call to retrieve the schema settings when called on a reference object. See {#reference?}.
+        #
+        # @return [Boolean] `true` when `BINARY`, `false` if not `BINARY` or schema settings is not set.
+        #
+        def message_encoding_binary?
+          message_encoding.to_s.upcase == "BINARY"
+        end
+
+        ##
+        # Checks if the encoding of messages in the schema settings is `JSON`. See {#message_encoding}.
+        #
+        # Makes an API call to retrieve the schema settings when called on a reference object. See {#reference?}.
+        #
+        # @return [Boolean] `true` when `JSON`, `false` if not `JSON` or schema settings is not set.
+        #
+        def message_encoding_json?
+          message_encoding.to_s.upcase == "JSON"
+        end
+
         ##
         # Permanently deletes the topic.
         #
@@ -516,6 +588,8 @@ module Google
         # @param [String, File] data The message payload. This will be converted
         #   to bytes encoded as ASCII-8BIT.
         # @param [Hash] attributes Optional attributes for the message.
+        # @param [String] ordering_key Identifies related messages for which
+        #   publish order should be respected.
         # @yield [batch] a block for publishing multiple messages in one
         #   request
         # @yieldparam [BatchPublisher] batch the topic batch publisher
@@ -564,10 +638,24 @@ module Google
         #     t.publish "task 3 completed", foo: :bif
         #   end
         #
-        def publish data = nil, attributes = {}
+        # @example Ordered messages are supported using ordering_key:
+        #   require "google/cloud/pubsub"
+        #
+        #   pubsub = Google::Cloud::PubSub.new
+        #
+        #   topic = pubsub.topic "my-ordered-topic"
+        #
+        #   # Ensure that message ordering is enabled.
+        #   topic.enable_message_ordering!
+        #
+        #   # Publish an ordered message with an ordering key.
+        #   topic.publish "task completed",
+        #                 ordering_key: "task-key"
+        #
+        def publish data = nil, attributes = nil, ordering_key: nil, **extra_attrs, &block
           ensure_service!
-          batch = BatchPublisher.new data, attributes
-          yield batch if block_given?
+          batch = BatchPublisher.new data, attributes, ordering_key, extra_attrs
+          block&.call batch
           return nil if batch.messages.count.zero?
           publish_batch_messages batch
         end
@@ -596,6 +684,11 @@ module Google
         # @note At the time of this release, ordering keys are not yet publicly
         #   enabled and requires special project enablements.
         #
+        # Publisher flow control limits the number of outstanding messages that
+        # are allowed to wait to be published. See the `flow_control` key in the
+        # `async` parameter in {Project#topic} for more information about publisher
+        # flow control settings.
+        #
         # @param [String, File] data The message payload. This will be converted
         #   to bytes encoded as ASCII-8BIT.
         # @param [Hash] attributes Optional attributes for the message.
@@ -615,6 +708,13 @@ module Google
         #   message with an `ordering_key` that has already failed when
         #   publishing. Use {#resume_publish} to allow this `ordering_key` to be
         #   published again.
+        # @raise [Google::Cloud::PubSub::FlowControlLimitError] when publish flow
+        #   control limits are exceeded, and the `async` parameter key
+        #   `flow_control.limit_exceeded_behavior` is set to `:error` or `:block`.
+        #   If `flow_control.limit_exceeded_behavior` is set to `:block`, this error
+        #   will be raised only when a limit would be exceeded by a single message.
+        #   See the `async` parameter in {Project#topic} for more information about
+        #   `flow_control` settings.
         #
         # @example
         #   require "google/cloud/pubsub"

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

@@ -16,7 +16,7 @@
 module Google
   module Cloud
     module PubSub
-      VERSION = "2.4.0".freeze
+      VERSION = "2.7.1".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.4.0
+  version: 2.7.1
 platform: ruby
 authors:
 - Mike Moore
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-03-11 00:00:00.000000000 Z
+date: 2021-07-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -67,6 +67,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: avro
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
 - !ruby/object:Gem::Dependency
   name: google-style
   requirement: !ruby/object:Gem::Requirement
@@ -219,12 +233,15 @@ files:
 - lib/google/cloud/pubsub/convert.rb
 - lib/google/cloud/pubsub/credentials.rb
 - lib/google/cloud/pubsub/errors.rb
+- lib/google/cloud/pubsub/flow_controller.rb
 - lib/google/cloud/pubsub/message.rb
 - lib/google/cloud/pubsub/policy.rb
 - lib/google/cloud/pubsub/project.rb
 - lib/google/cloud/pubsub/publish_result.rb
 - lib/google/cloud/pubsub/received_message.rb
 - lib/google/cloud/pubsub/retry_policy.rb
+- lib/google/cloud/pubsub/schema.rb
+- lib/google/cloud/pubsub/schema/list.rb
 - lib/google/cloud/pubsub/service.rb
 - lib/google/cloud/pubsub/snapshot.rb
 - lib/google/cloud/pubsub/snapshot/list.rb
@@ -259,7 +276,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.13
+rubygems_version: 3.2.17
 signing_key: 
 specification_version: 4
 summary: API Client library for Google Cloud Pub/Sub