google-cloud-pubsub 1.1.3 → 1.10.0

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

@@ -1,4 +1,4 @@
-# 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.
@@ -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
@@ -94,6 +98,12 @@ module Google
 
           private_constant :PROJECT_PATH_TEMPLATE
 
+          SUBSCRIPTION_PATH_TEMPLATE = Google::Gax::PathTemplate.new(
+            "projects/{project}/subscriptions/{subscription}"
+          )
+
+          private_constant :SUBSCRIPTION_PATH_TEMPLATE
+
           TOPIC_PATH_TEMPLATE = Google::Gax::PathTemplate.new(
             "projects/{project}/topics/{topic}"
           )
@@ -109,6 +119,17 @@ module Google
             )
           end
 
+          # Returns a fully-qualified subscription resource name string.
+          # @param project [String]
+          # @param subscription [String]
+          # @return [String]
+          def self.subscription_path project, subscription
+            SUBSCRIPTION_PATH_TEMPLATE.render(
+              :"project" => project,
+              :"subscription" => subscription
+            )
+          end
+
           # Returns a fully-qualified topic resource name string.
           # @param project [String]
           # @param topic [String]
@@ -198,6 +219,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"
@@ -289,6 +313,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"],
@@ -321,6 +353,14 @@ module Google
                 {'resource' => request.resource}
               end
             )
+            @detach_subscription = Google::Gax.create_api_call(
+              @publisher_stub.method(:detach_subscription),
+              defaults["detach_subscription"],
+              exception_transformer: exception_transformer,
+              params_extractor: proc do |request|
+                {'subscription' => request.subscription}
+              end
+            )
           end
 
           # Service calls
@@ -330,7 +370,7 @@ module Google
           # resource name rules</a>.
           #
           # @param name [String]
-          #   The name of the topic. It must have the format
+          #   Required. The name of the topic. It must have the format
           #   `"projects/{project}/topics/{topic}"`. `{topic}` must start with a letter,
           #   and contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`),
           #   underscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent
@@ -386,15 +426,15 @@ module Google
           # topic are not modifiable.
           #
           # @param topic [Google::Cloud::PubSub::V1::Topic | Hash]
-          #   The updated topic object.
+          #   Required. The updated topic object.
           #   A hash of the same form as `Google::Cloud::PubSub::V1::Topic`
           #   can also be provided.
           # @param update_mask [Google::Protobuf::FieldMask | Hash]
-          #   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.
+          #   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" but the `message_storage_policy` is not set in
+          #   the `topic` provided above, then the updated value is determined by the
+          #   policy configured at the project or organization level.
           #   A hash of the same form as `Google::Protobuf::FieldMask`
           #   can also be provided.
           # @param options [Google::Gax::CallOptions]
@@ -434,10 +474,10 @@ module Google
           # does not exist.
           #
           # @param topic [String]
-          #   The messages in the request will be published on this topic.
+          #   Required. The messages in the request will be published on this topic.
           #   Format is `projects/{project}/topics/{topic}`.
           # @param messages [Array<Google::Cloud::PubSub::V1::PubsubMessage | Hash>]
-          #   The messages to publish.
+          #   Required. The messages to publish.
           #   A hash of the same form as `Google::Cloud::PubSub::V1::PubsubMessage`
           #   can also be provided.
           # @param options [Google::Gax::CallOptions]
@@ -474,7 +514,7 @@ module Google
           # Gets the configuration of a topic.
           #
           # @param topic [String]
-          #   The name of the topic to get.
+          #   Required. The name of the topic to get.
           #   Format is `projects/{project}/topics/{topic}`.
           # @param options [Google::Gax::CallOptions]
           #   Overrides the default settings for this call, e.g, timeout,
@@ -505,7 +545,7 @@ module Google
           # Lists matching topics.
           #
           # @param project [String]
-          #   The name of the project in which to list topics.
+          #   Required. The name of the project in which to list topics.
           #   Format is `projects/{project-id}`.
           # @param page_size [Integer]
           #   The maximum number of resources contained in the underlying API
@@ -557,10 +597,10 @@ module Google
             @list_topics.call(req, options, &block)
           end
 
-          # Lists the names of the subscriptions on this topic.
+          # Lists the names of the attached subscriptions on this topic.
           #
           # @param topic [String]
-          #   The name of the topic that subscriptions are attached to.
+          #   Required. The name of the topic that subscriptions are attached to.
           #   Format is `projects/{project}/topics/{topic}`.
           # @param page_size [Integer]
           #   The maximum number of resources contained in the underlying API
@@ -612,6 +652,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
@@ -619,7 +719,7 @@ module Google
           # not deleted, but their `topic` field is set to `_deleted-topic_`.
           #
           # @param topic [String]
-          #   Name of the topic to delete.
+          #   Required. Name of the topic to delete.
           #   Format is `projects/{project}/topics/{topic}`.
           # @param options [Google::Gax::CallOptions]
           #   Overrides the default settings for this call, e.g, timeout,
@@ -647,8 +747,11 @@ module Google
             nil
           end
 
-          # Sets the access control policy on the specified resource. Replaces any
-          # existing policy.
+          # Sets the access control policy on the specified resource. Replaces
+          # any existing policy.
+          #
+          # Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED`
+          # errors.
           #
           # @param resource [String]
           #   REQUIRED: The resource for which the policy is being specified.
@@ -672,11 +775,13 @@ module Google
           #   require "google/cloud/pubsub"
           #
           #   publisher_client = Google::Cloud::PubSub::Publisher.new(version: :v1)
-          #   formatted_resource = Google::Cloud::PubSub::V1::PublisherClient.topic_path("[PROJECT]", "[TOPIC]")
+          #
+          #   # TODO: Initialize `resource`:
+          #   resource = ''
           #
           #   # TODO: Initialize `policy`:
           #   policy = {}
-          #   response = publisher_client.set_iam_policy(formatted_resource, policy)
+          #   response = publisher_client.set_iam_policy(resource, policy)
 
           def set_iam_policy \
               resource,
@@ -691,9 +796,8 @@ module Google
             @set_iam_policy.call(req, options, &block)
           end
 
-          # Gets the access control policy for a resource.
-          # Returns an empty policy if the resource exists and does not have a policy
-          # set.
+          # Gets the access control policy for a resource. Returns an empty policy
+          # if the resource exists and does not have a policy set.
           #
           # @param resource [String]
           #   REQUIRED: The resource for which the policy is being requested.
@@ -715,8 +819,10 @@ module Google
           #   require "google/cloud/pubsub"
           #
           #   publisher_client = Google::Cloud::PubSub::Publisher.new(version: :v1)
-          #   formatted_resource = Google::Cloud::PubSub::V1::PublisherClient.topic_path("[PROJECT]", "[TOPIC]")
-          #   response = publisher_client.get_iam_policy(formatted_resource)
+          #
+          #   # TODO: Initialize `resource`:
+          #   resource = ''
+          #   response = publisher_client.get_iam_policy(resource)
 
           def get_iam_policy \
               resource,
@@ -731,13 +837,13 @@ module Google
             @get_iam_policy.call(req, options, &block)
           end
 
-          # Returns permissions that a caller has on the specified resource.
-          # If the resource does not exist, this will return an empty set of
-          # permissions, not a NOT_FOUND error.
+          # Returns permissions that a caller has on the specified resource. If the
+          # resource does not exist, this will return an empty set of
+          # permissions, not a `NOT_FOUND` error.
           #
-          # Note: This operation is designed to be used for building permission-aware
-          # UIs and command-line tools, not for authorization checking. This operation
-          # may "fail open" without warning.
+          # Note: This operation is designed to be used for building
+          # permission-aware UIs and command-line tools, not for authorization
+          # checking. This operation may "fail open" without warning.
           #
           # @param resource [String]
           #   REQUIRED: The resource for which the policy detail is being requested.
@@ -759,11 +865,13 @@ module Google
           #   require "google/cloud/pubsub"
           #
           #   publisher_client = Google::Cloud::PubSub::Publisher.new(version: :v1)
-          #   formatted_resource = Google::Cloud::PubSub::V1::PublisherClient.topic_path("[PROJECT]", "[TOPIC]")
+          #
+          #   # TODO: Initialize `resource`:
+          #   resource = ''
           #
           #   # TODO: Initialize `permissions`:
           #   permissions = []
-          #   response = publisher_client.test_iam_permissions(formatted_resource, permissions)
+          #   response = publisher_client.test_iam_permissions(resource, permissions)
 
           def test_iam_permissions \
               resource,
@@ -777,6 +885,40 @@ module Google
             req = Google::Gax::to_proto(req, Google::Iam::V1::TestIamPermissionsRequest)
             @test_iam_permissions.call(req, options, &block)
           end
+
+          # Detaches a subscription from this topic. All messages retained in the
+          # subscription are dropped. Subsequent `Pull` and `StreamingPull` requests
+          # will return FAILED_PRECONDITION. If the subscription is a push
+          # subscription, pushes to the endpoint will stop.
+          #
+          # @param subscription [String]
+          #   Required. The subscription to detach.
+          #   Format is `projects/{project}/subscriptions/{subscription}`.
+          # @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::DetachSubscriptionResponse]
+          # @yieldparam operation [GRPC::ActiveCall::Operation]
+          # @return [Google::Cloud::PubSub::V1::DetachSubscriptionResponse]
+          # @raise [Google::Gax::GaxError] if the RPC is aborted.
+          # @example
+          #   require "google/cloud/pubsub"
+          #
+          #   publisher_client = Google::Cloud::PubSub::Publisher.new(version: :v1)
+          #   formatted_subscription = Google::Cloud::PubSub::V1::PublisherClient.subscription_path("[PROJECT]", "[SUBSCRIPTION]")
+          #   response = publisher_client.detach_subscription(formatted_subscription)
+
+          def detach_subscription \
+              subscription,
+              options: nil,
+              &block
+            req = {
+              subscription: subscription
+            }.delete_if { |_, v| v.nil? }
+            req = Google::Gax::to_proto(req, Google::Cloud::PubSub::V1::DetachSubscriptionRequest)
+            @detach_subscription.call(req, options, &block)
+          end
         end
       end
     end

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

@@ -7,9 +7,14 @@
           "UNAVAILABLE",
           "UNKNOWN"
         ],
+        "non_idempotent2": [],
         "non_idempotent": [
           "UNAVAILABLE"
         ],
+        "idempotent2": [
+          "DEADLINE_EXCEEDED",
+          "UNAVAILABLE"
+        ],
         "none": [],
         "publish": [
           "ABORTED",
@@ -53,7 +58,7 @@
           "retry_params_name": "default"
         },
         "Publish": {
-          "timeout_millis": 60000,
+          "timeout_millis": 20000,
           "retry_codes_name": "publish",
           "retry_params_name": "messaging",
           "bundling": {
@@ -79,6 +84,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",
@@ -98,6 +108,11 @@
           "timeout_millis": 60000,
           "retry_codes_name": "non_idempotent",
           "retry_params_name": "default"
+        },
+        "DetachSubscription": {
+          "timeout_millis": 60000,
+          "retry_codes_name": "non_idempotent2",
+          "retry_params_name": "default"
         }
       }
     }