Add DetachSubscription RPC

PiperOrigin-RevId: 313276022

Source-Author: Google APIs <noreply@google.com>
Source-Date: Tue May 26 15:11:32 2020 -0700
Source-Repo: googleapis/googleapis
Source-Sha: f5f268f5293e60143ac742a4eeb7dd6306ebf505
Source-Link: googleapis/googleapis@f5f268f

google/cloud/pubsub_v1/gapic/publisher_client.py

@@ -678,7 +678,7 @@ def list_topic_subscriptions(
         metadata=None,
     ):
         """
-        Lists the names of the subscriptions on this topic.
+        Lists the names of the attached subscriptions on this topic.
 
         Example:
             >>> from google.cloud import pubsub_v1
@@ -1204,3 +1204,76 @@ def test_iam_permissions(
         return self._inner_api_calls["test_iam_permissions"](
             request, retry=retry, timeout=timeout, metadata=metadata
         )
+
+    def detach_subscription(
+        self,
+        subscription,
+        retry=google.api_core.gapic_v1.method.DEFAULT,
+        timeout=google.api_core.gapic_v1.method.DEFAULT,
+        metadata=None,
+    ):
+        """
+        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.
+
+        Example:
+            >>> from google.cloud import pubsub_v1
+            >>>
+            >>> client = pubsub_v1.PublisherClient()
+            >>>
+            >>> subscription = client.topic_path('[PROJECT]', '[TOPIC]')
+            >>>
+            >>> response = client.detach_subscription(subscription)
+
+        Args:
+            subscription (str): Required. The subscription to detach. Format is
+                ``projects/{project}/subscriptions/{subscription}``.
+            retry (Optional[google.api_core.retry.Retry]):  A retry object used
+                to retry requests. If ``None`` is specified, requests will
+                be retried using a default configuration.
+            timeout (Optional[float]): The amount of time, in seconds, to wait
+                for the request to complete. Note that if ``retry`` is
+                specified, the timeout applies to each individual attempt.
+            metadata (Optional[Sequence[Tuple[str, str]]]): Additional metadata
+                that is provided to the method.
+
+        Returns:
+            A :class:`~google.cloud.pubsub_v1.types.DetachSubscriptionResponse` instance.
+
+        Raises:
+            google.api_core.exceptions.GoogleAPICallError: If the request
+                    failed for any reason.
+            google.api_core.exceptions.RetryError: If the request failed due
+                    to a retryable error and retry attempts failed.
+            ValueError: If the parameters are invalid.
+        """
+        # Wrap the transport method to add retry and timeout logic.
+        if "detach_subscription" not in self._inner_api_calls:
+            self._inner_api_calls[
+                "detach_subscription"
+            ] = google.api_core.gapic_v1.method.wrap_method(
+                self.transport.detach_subscription,
+                default_retry=self._method_configs["DetachSubscription"].retry,
+                default_timeout=self._method_configs["DetachSubscription"].timeout,
+                client_info=self._client_info,
+            )
+
+        request = pubsub_pb2.DetachSubscriptionRequest(subscription=subscription)
+        if metadata is None:
+            metadata = []
+        metadata = list(metadata)
+        try:
+            routing_header = [("subscription", subscription)]
+        except AttributeError:
+            pass
+        else:
+            routing_metadata = google.api_core.gapic_v1.routing_header.to_grpc_metadata(
+                routing_header
+            )
+            metadata.append(routing_metadata)
+
+        return self._inner_api_calls["detach_subscription"](
+            request, retry=retry, timeout=timeout, metadata=metadata
+        )

google/cloud/pubsub_v1/gapic/publisher_client_config.py

@@ -3,6 +3,7 @@
         "google.pubsub.v1.Publisher": {
             "retry_codes": {
                 "idempotent": ["ABORTED", "UNAVAILABLE", "UNKNOWN"],
+                "non_idempotent2": [],
                 "non_idempotent": ["UNAVAILABLE"],
                 "idempotent2": ["DEADLINE_EXCEEDED", "UNAVAILABLE"],
                 "none": [],
@@ -99,6 +100,11 @@
                     "retry_codes_name": "non_idempotent",
                     "retry_params_name": "default",
                 },
+                "DetachSubscription": {
+                    "timeout_millis": 60000,
+                    "retry_codes_name": "non_idempotent2",
+                    "retry_params_name": "default",
+                },
             },
         }
     }

google/cloud/pubsub_v1/gapic/transports/publisher_grpc_transport.py

@@ -184,7 +184,7 @@ def list_topics(self):
     def list_topic_subscriptions(self):
         """Return the gRPC stub for :meth:`PublisherClient.list_topic_subscriptions`.
 
-        Lists the names of the subscriptions on this topic.
+        Lists the names of the attached subscriptions on this topic.
 
         Returns:
             Callable: A callable which accepts the appropriate
@@ -278,3 +278,19 @@ def test_iam_permissions(self):
                 deserialized response object.
         """
         return self._stubs["iam_policy_stub"].TestIamPermissions
+
+    @property
+    def detach_subscription(self):
+        """Return the gRPC stub for :meth:`PublisherClient.detach_subscription`.
+
+        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.
+
+        Returns:
+            Callable: A callable which accepts the appropriate
+                deserialized request object and returns a
+                deserialized response object.
+        """
+        return self._stubs["publisher_stub"].DetachSubscription

google/cloud/pubsub_v1/proto/pubsub.proto

@@ -88,7 +88,7 @@ service Publisher {
     option (google.api.method_signature) = "project";
   }
 
-  // Lists the names of the subscriptions on this topic.
+  // Lists the names of the attached subscriptions on this topic.
   rpc ListTopicSubscriptions(ListTopicSubscriptionsRequest)
       returns (ListTopicSubscriptionsResponse) {
     option (google.api.http) = {
@@ -122,6 +122,17 @@ service Publisher {
     };
     option (google.api.method_signature) = "topic";
   }
+
+  // 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.
+  rpc DetachSubscription(DetachSubscriptionRequest)
+      returns (DetachSubscriptionResponse) {
+    option (google.api.http) = {
+      post: "/v1/{subscription=projects/*/subscriptions/*}:detach"
+    };
+  }
 }
 
 message MessageStoragePolicy {
@@ -300,7 +311,7 @@ message ListTopicSubscriptionsRequest {
 
 // Response for the `ListTopicSubscriptions` method.
 message ListTopicSubscriptionsResponse {
-  // The names of the subscriptions that match the request.
+  // The names of subscriptions attached to the topic specified in the request.
   repeated string subscriptions = 1 [(google.api.resource_reference) = {
     type: "pubsub.googleapis.com/Subscription"
   }];
@@ -350,6 +361,20 @@ message DeleteTopicRequest {
   ];
 }
 
+// Request for the DetachSubscription method.
+message DetachSubscriptionRequest {
+  // Required. The subscription to detach.
+  // Format is `projects/{project}/subscriptions/{subscription}`.
+  string subscription = 1 [
+    (google.api.field_behavior) = REQUIRED,
+    (google.api.resource_reference) = { type: "pubsub.googleapis.com/Topic" }
+  ];
+}
+
+// Response for the DetachSubscription method.
+// Reserved for future use.
+message DetachSubscriptionResponse {}
+
 // The service that an application uses to manipulate subscriptions and to
 // consume messages from a subscription via the `Pull` method or by
 // establishing a bi-directional stream using the `StreamingPull` method.