google-cloud-pubsub 1.5.0 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c1306c932b52a6c12aa2aa1e6ba1100ca90ae78a364ce07d8c5844c517c547f4
-  data.tar.gz: f6b9413d4d64cebd698f02b7e7a169da5066c9f05d967432ac69737f1e8d76e5
+  metadata.gz: 350813891a25b960230adbe7a22dc40cd847065d368598650a0c663e81d66bc7
+  data.tar.gz: 881a92aec3d136aef23bee956241bf400a5dd203a7f6c0a100e162a4c22c97d0
 SHA512:
-  metadata.gz: ebd17aea2e53e2b4fbcaa7b5dd76954fe73aa6eb36402db2014e7d7904df0db022f49a7a2cac574567b9f58c70632f7d4360b12c9a96fed15e1f1f133e3a9df2
-  data.tar.gz: a1c0e15330824046f66db7ccb5105b16ee07984c36080338d38302ace2c1c5fded2c3e59ba4979c0d4e63c7becdc425a1b25587fda71508b86492cd03fadf8ba
+  metadata.gz: c364975f01a107d41f1282eecdbec83d25e1d3717abcb45252afebfb64c6d028b9651e9d054bfb5b1caeb6e179045505f79e5faf802c30071f202e7a42e576af
+  data.tar.gz: 7a9d23c2d74e734ad184d6dbb3acabad3868a6dd74b5836d7aa149c4c03edb7c80b414e4d52b2fe8bed9ae4e6794a0634c90c1919a5471196cda408c423f2610

data/CHANGELOG.md

@@ -1,5 +1,17 @@
 # Release History
 
+### 1.6.0 / 2020-04-06
+
+#### Features
+
+* Add list_topic_snapshots and get_snapshot
+  * Add PublisherClient#list_topic_snapshots
+  * Add SubscriberClient#get_snapshot
+
+#### Documentation
+
+* Remove a spurious link in the low-level interface documentation.
+
 ### 1.5.0 / 2020-03-25
 
 #### Features

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

@@ -399,7 +399,7 @@ module Google
       # @!attribute [rw] push_endpoint
       #   @return [String]
       #     A URL locating the endpoint to which messages should be pushed.
-      #     For example, a Webhook endpoint might use "https://example.com/push".
+      #     For example, a Webhook endpoint might use `https://example.com/push`.
       # @!attribute [rw] attributes
       #   @return [Hash{String => String}]
       #     Endpoint configuration attributes that can be used to control different

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

@@ -64,7 +64,11 @@ module Google
             "list_topic_subscriptions" => Google::Gax::PageDescriptor.new(
               "page_token",
               "next_page_token",
-              "subscriptions")
+              "subscriptions"),
+            "list_topic_snapshots" => Google::Gax::PageDescriptor.new(
+              "page_token",
+              "next_page_token",
+              "snapshots")
           }.freeze
 
           private_constant :PAGE_DESCRIPTORS
@@ -110,8 +114,6 @@ module Google
           end
 
           # Returns a fully-qualified topic resource name string.
-          # @deprecated Multi-pattern resource names will have unified creation and parsing helper functions.
-          # This helper function will be deleted in the next major version.
           # @param project [String]
           # @param topic [String]
           # @return [String]
@@ -294,6 +296,14 @@ module Google
                 {'topic' => request.topic}
               end
             )
+            @list_topic_snapshots = Google::Gax.create_api_call(
+              @publisher_stub.method(:list_topic_snapshots),
+              defaults["list_topic_snapshots"],
+              exception_transformer: exception_transformer,
+              params_extractor: proc do |request|
+                {'topic' => request.topic}
+              end
+            )
             @delete_topic = Google::Gax.create_api_call(
               @publisher_stub.method(:delete_topic),
               defaults["delete_topic"],
@@ -617,6 +627,66 @@ module Google
             @list_topic_subscriptions.call(req, options, &block)
           end
 
+          # Lists the names of the snapshots on this topic. Snapshots are used in
+          # <a href="https://cloud.google.com/pubsub/docs/replay-overview">Seek</a>
+          # operations, which allow
+          # you to manage message acknowledgments in bulk. That is, you can set the
+          # acknowledgment state of messages in an existing subscription to the state
+          # captured by a snapshot.
+          #
+          # @param topic [String]
+          #   Required. The name of the topic that snapshots are attached to.
+          #   Format is `projects/{project}/topics/{topic}`.
+          # @param page_size [Integer]
+          #   The maximum number of resources contained in the underlying API
+          #   response. If page streaming is performed per-resource, this
+          #   parameter does not affect the return value. If page streaming is
+          #   performed per-page, this determines the maximum number of
+          #   resources in a page.
+          # @param options [Google::Gax::CallOptions]
+          #   Overrides the default settings for this call, e.g, timeout,
+          #   retries, etc.
+          # @yield [result, operation] Access the result along with the RPC operation
+          # @yieldparam result [Google::Gax::PagedEnumerable<String>]
+          # @yieldparam operation [GRPC::ActiveCall::Operation]
+          # @return [Google::Gax::PagedEnumerable<String>]
+          #   An enumerable of String instances.
+          #   See Google::Gax::PagedEnumerable documentation for other
+          #   operations such as per-page iteration or access to the response
+          #   object.
+          # @raise [Google::Gax::GaxError] if the RPC is aborted.
+          # @example
+          #   require "google/cloud/pubsub"
+          #
+          #   publisher_client = Google::Cloud::PubSub::Publisher.new(version: :v1)
+          #   formatted_topic = Google::Cloud::PubSub::V1::PublisherClient.topic_path("[PROJECT]", "[TOPIC]")
+          #
+          #   # Iterate over all results.
+          #   publisher_client.list_topic_snapshots(formatted_topic).each do |element|
+          #     # Process element.
+          #   end
+          #
+          #   # Or iterate over results one page at a time.
+          #   publisher_client.list_topic_snapshots(formatted_topic).each_page do |page|
+          #     # Process each page at a time.
+          #     page.each do |element|
+          #       # Process element.
+          #     end
+          #   end
+
+          def list_topic_snapshots \
+              topic,
+              page_size: nil,
+              options: nil,
+              &block
+            req = {
+              topic: topic,
+              page_size: page_size
+            }.delete_if { |_, v| v.nil? }
+            req = Google::Gax::to_proto(req, Google::Cloud::PubSub::V1::ListTopicSnapshotsRequest)
+            @list_topic_snapshots.call(req, options, &block)
+          end
+
           # Deletes the topic with the given name. Returns `NOT_FOUND` if the topic
           # does not exist. After a topic is deleted, a new topic may be created with
           # the same name; this is an entirely new topic with none of the old

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

@@ -10,6 +10,10 @@
         "non_idempotent": [
           "UNAVAILABLE"
         ],
+        "idempotent2": [
+          "DEADLINE_EXCEEDED",
+          "UNAVAILABLE"
+        ],
         "none": [],
         "publish": [
           "ABORTED",
@@ -79,6 +83,11 @@
           "retry_codes_name": "idempotent",
           "retry_params_name": "default"
         },
+        "ListTopicSnapshots": {
+          "timeout_millis": 60000,
+          "retry_codes_name": "idempotent2",
+          "retry_params_name": "default"
+        },
         "DeleteTopic": {
           "timeout_millis": 60000,
           "retry_codes_name": "non_idempotent",

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

@@ -134,8 +134,6 @@ module Google
           end
 
           # Returns a fully-qualified topic resource name string.
-          # @deprecated Multi-pattern resource names will have unified creation and parsing helper functions.
-          # This helper function will be deleted in the next major version.
           # @param project [String]
           # @param topic [String]
           # @return [String]
@@ -309,6 +307,14 @@ module Google
                 {'subscription' => request.subscription}
               end
             )
+            @get_snapshot = Google::Gax.create_api_call(
+              @subscriber_stub.method(:get_snapshot),
+              defaults["get_snapshot"],
+              exception_transformer: exception_transformer,
+              params_extractor: proc do |request|
+                {'snapshot' => request.snapshot}
+              end
+            )
             @modify_ack_deadline = Google::Gax.create_api_call(
               @subscriber_stub.method(:modify_ack_deadline),
               defaults["modify_ack_deadline"],
@@ -752,6 +758,41 @@ module Google
             nil
           end
 
+          # Gets the configuration details of a snapshot. Snapshots are used in
+          # <a href="https://cloud.google.com/pubsub/docs/replay-overview">Seek</a>
+          # operations, which allow you to manage message acknowledgments in bulk. That
+          # is, you can set the acknowledgment state of messages in an existing
+          # subscription to the state captured by a snapshot.
+          #
+          # @param snapshot [String]
+          #   Required. The name of the snapshot to get.
+          #   Format is `projects/{project}/snapshots/{snap}`.
+          # @param options [Google::Gax::CallOptions]
+          #   Overrides the default settings for this call, e.g, timeout,
+          #   retries, etc.
+          # @yield [result, operation] Access the result along with the RPC operation
+          # @yieldparam result [Google::Cloud::PubSub::V1::Snapshot]
+          # @yieldparam operation [GRPC::ActiveCall::Operation]
+          # @return [Google::Cloud::PubSub::V1::Snapshot]
+          # @raise [Google::Gax::GaxError] if the RPC is aborted.
+          # @example
+          #   require "google/cloud/pubsub"
+          #
+          #   subscriber_client = Google::Cloud::PubSub::Subscriber.new(version: :v1)
+          #   formatted_snapshot = Google::Cloud::PubSub::V1::SubscriberClient.snapshot_path("[PROJECT]", "[SNAPSHOT]")
+          #   response = subscriber_client.get_snapshot(formatted_snapshot)
+
+          def get_snapshot \
+              snapshot,
+              options: nil,
+              &block
+            req = {
+              snapshot: snapshot
+            }.delete_if { |_, v| v.nil? }
+            req = Google::Gax::to_proto(req, Google::Cloud::PubSub::V1::GetSnapshotRequest)
+            @get_snapshot.call(req, options, &block)
+          end
+
           # Modifies the ack deadline for a specific message. This method is useful
           # to indicate that more time is needed to process a message by the
           # subscriber, or to make the message available for redelivery if the

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

@@ -10,6 +10,10 @@
         "non_idempotent": [
           "UNAVAILABLE"
         ],
+        "idempotent2": [
+          "DEADLINE_EXCEEDED",
+          "UNAVAILABLE"
+        ],
         "streaming_pull": [
           "ABORTED",
           "DEADLINE_EXCEEDED",
@@ -73,6 +77,11 @@
           "retry_codes_name": "non_idempotent",
           "retry_params_name": "default"
         },
+        "GetSnapshot": {
+          "timeout_millis": 60000,
+          "retry_codes_name": "idempotent2",
+          "retry_params_name": "default"
+        },
         "ModifyAckDeadline": {
           "timeout_millis": 60000,
           "retry_codes_name": "non_idempotent",

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

@@ -16,7 +16,7 @@
 module Google
   module Cloud
     module PubSub
-      VERSION = "1.5.0".freeze
+      VERSION = "1.6.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: 1.5.0
+  version: 1.6.0
 platform: ruby
 authors:
 - Mike Moore
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-03-25 00:00:00.000000000 Z
+date: 2020-04-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby