feat: add push config wrapper fields (#925)

gcf-owl-bot[bot] · web-flow · commit 8e803cf4ab13 · 2023-05-25T10:27:35.000-04:00
* feat: add push config wrapper fields PiperOrigin-RevId: 534994946 Source-Link: googleapis/googleapis@64ecfeb Source-Link: googleapis/googleapis-gen@03534b3 Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiMDM1MzRiM2RkNGM5MjZmNzA2NzI5ZDk3OWQ4OTM0NThkYjdlMTc0ZCJ9 * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md --------- Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com>
diff --git a/google/pubsub_v1/types/pubsub.py b/google/pubsub_v1/types/pubsub.py
@@ -959,6 +959,11 @@ class ExpirationPolicy(proto.Message):
 class PushConfig(proto.Message):
     r"""Configuration for a push delivery endpoint.
 
+    This message has `oneof`_ fields (mutually exclusive fields).
+    For each oneof, at most one member field can be set at the same time.
+    Setting any member of the oneof automatically clears all other
+    members.
+
     .. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
 
     Attributes:
@@ -998,6 +1003,18 @@ class PushConfig(proto.Message):
             every pushed message.
 
             This field is a member of `oneof`_ ``authentication_method``.
+        pubsub_wrapper (google.pubsub_v1.types.PushConfig.PubsubWrapper):
+            When set, the payload to the push endpoint is
+            in the form of the JSON representation of a
+            PubsubMessage
+            (https://cloud.google.com/pubsub/docs/reference/rpc/google.pubsub.v1#pubsubmessage).
+
+            This field is a member of `oneof`_ ``wrapper``.
+        no_wrapper (google.pubsub_v1.types.PushConfig.NoWrapper):
+            When set, the payload to the push endpoint is
+            not wrapped.
+
+            This field is a member of `oneof`_ ``wrapper``.
     """
 
     class OidcToken(proto.Message):
@@ -1033,6 +1050,29 @@ class OidcToken(proto.Message):
             number=2,
         )
 
+    class PubsubWrapper(proto.Message):
+        r"""The payload to the push endpoint is in the form of the JSON
+        representation of a PubsubMessage
+        (https://cloud.google.com/pubsub/docs/reference/rpc/google.pubsub.v1#pubsubmessage).
+
+        """
+
+    class NoWrapper(proto.Message):
+        r"""Sets the ``data`` field as the HTTP body for delivery.
+
+        Attributes:
+            write_metadata (bool):
+                When true, writes the Pub/Sub message metadata to
+                ``x-goog-pubsub-<KEY>:<VAL>`` headers of the HTTP request.
+                Writes the Pub/Sub message attributes to ``<KEY>:<VAL>``
+                headers of the HTTP request.
+        """
+
+        write_metadata: bool = proto.Field(
+            proto.BOOL,
+            number=1,
+        )
+
     push_endpoint: str = proto.Field(
         proto.STRING,
         number=1,
@@ -1048,6 +1088,18 @@ class OidcToken(proto.Message):
         oneof="authentication_method",
         message=OidcToken,
     )
+    pubsub_wrapper: PubsubWrapper = proto.Field(
+        proto.MESSAGE,
+        number=4,
+        oneof="wrapper",
+        message=PubsubWrapper,
+    )
+    no_wrapper: NoWrapper = proto.Field(
+        proto.MESSAGE,
+        number=5,
+        oneof="wrapper",
+        message=NoWrapper,
+    )
 
 
 class BigQueryConfig(proto.Message):
diff --git a/samples/generated_samples/snippet_metadata_google.pubsub.v1.json b/samples/generated_samples/snippet_metadata_google.pubsub.v1.json
@@ -8,7 +8,7 @@
     ],
     "language": "PYTHON",
     "name": "google-cloud-pubsub",
-    "version": "2.17.1"
+    "version": "0.1.0"
   },
   "snippets": [
     {

Original file line number	Diff line number	Diff line change
`@@ -8,7 +8,7 @@`
`8`	`8`	`],`
`9`	`9`	`"language": "PYTHON",`
`10`	`10`	`"name": "google-cloud-pubsub",`
`11`		`- "version": "2.17.1"`
	`11`	`+ "version": "0.1.0"`
`12`	`12`	`},`
`13`	`13`	`"snippets": [`
`14`	`14`	`{`