From 462746cfbf9b712118b67349f2f4f4cebf45932a Mon Sep 17 00:00:00 2001
From: "gcf-owl-bot[bot]" <78513119+gcf-owl-bot[bot]@users.noreply.github.com>
Date: Wed, 26 Jul 2023 14:22:54 -0400
Subject: [PATCH] docs: clarified where ordering_key will be written if
 write_metadata is set (#1675)
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

* docs: clarified where ordering_key will be written if write_metadata is set

PiperOrigin-RevId: 551210991

Source-Link: https://github.com/googleapis/googleapis/commit/7c762d770a82da397956b80379a6fb73505835af

Source-Link: https://github.com/googleapis/googleapis-gen/commit/15fe4c5ff5ebd52911b429b05b992e232f53351e
Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiMTVmZTRjNWZmNWViZDUyOTExYjQyOWIwNWI5OTJlMjMyZjUzMzUxZSJ9

* 🦉 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>
---
 .../google/pubsub/v1/CloudStorageConfig.java  | 30 +++++++++++++++----
 .../com/google/pubsub/v1/PullRequest.java     |  8 ++---
 .../pubsub/v1/PullRequestOrBuilder.java       |  2 +-
 .../main/proto/google/pubsub/v1/pubsub.proto  |  6 +++-
 4 files changed, 35 insertions(+), 11 deletions(-)

diff --git a/proto-google-cloud-pubsub-v1/src/main/java/com/google/pubsub/v1/CloudStorageConfig.java b/proto-google-cloud-pubsub-v1/src/main/java/com/google/pubsub/v1/CloudStorageConfig.java
index 8fb85ab64..a4532a62f 100644
--- a/proto-google-cloud-pubsub-v1/src/main/java/com/google/pubsub/v1/CloudStorageConfig.java
+++ b/proto-google-cloud-pubsub-v1/src/main/java/com/google/pubsub/v1/CloudStorageConfig.java
@@ -682,7 +682,11 @@ public interface AvroConfigOrBuilder
      *
      * <pre>
      * When true, write the subscription name, message_id, publish_time,
-     * attributes, and ordering_key as additional fields in the output.
+     * attributes, and ordering_key as additional fields in the output. The
+     * subscription name, message_id, and publish_time fields are put in their
+     * own fields while all other message properties other than data (for
+     * example, an ordering_key, if present) are added as entries in the
+     * attributes map.
      * </pre>
      *
      * <code>bool write_metadata = 1;</code>
@@ -741,7 +745,11 @@ public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() {
      *
      * <pre>
      * When true, write the subscription name, message_id, publish_time,
-     * attributes, and ordering_key as additional fields in the output.
+     * attributes, and ordering_key as additional fields in the output. The
+     * subscription name, message_id, and publish_time fields are put in their
+     * own fields while all other message properties other than data (for
+     * example, an ordering_key, if present) are added as entries in the
+     * attributes map.
      * </pre>
      *
      * <code>bool write_metadata = 1;</code>
@@ -1104,7 +1112,11 @@ public Builder mergeFrom(
        *
        * <pre>
        * When true, write the subscription name, message_id, publish_time,
-       * attributes, and ordering_key as additional fields in the output.
+       * attributes, and ordering_key as additional fields in the output. The
+       * subscription name, message_id, and publish_time fields are put in their
+       * own fields while all other message properties other than data (for
+       * example, an ordering_key, if present) are added as entries in the
+       * attributes map.
        * </pre>
        *
        * <code>bool write_metadata = 1;</code>
@@ -1120,7 +1132,11 @@ public boolean getWriteMetadata() {
        *
        * <pre>
        * When true, write the subscription name, message_id, publish_time,
-       * attributes, and ordering_key as additional fields in the output.
+       * attributes, and ordering_key as additional fields in the output. The
+       * subscription name, message_id, and publish_time fields are put in their
+       * own fields while all other message properties other than data (for
+       * example, an ordering_key, if present) are added as entries in the
+       * attributes map.
        * </pre>
        *
        * <code>bool write_metadata = 1;</code>
@@ -1140,7 +1156,11 @@ public Builder setWriteMetadata(boolean value) {
        *
        * <pre>
        * When true, write the subscription name, message_id, publish_time,
-       * attributes, and ordering_key as additional fields in the output.
+       * attributes, and ordering_key as additional fields in the output. The
+       * subscription name, message_id, and publish_time fields are put in their
+       * own fields while all other message properties other than data (for
+       * example, an ordering_key, if present) are added as entries in the
+       * attributes map.
        * </pre>
        *
        * <code>bool write_metadata = 1;</code>
diff --git a/proto-google-cloud-pubsub-v1/src/main/java/com/google/pubsub/v1/PullRequest.java b/proto-google-cloud-pubsub-v1/src/main/java/com/google/pubsub/v1/PullRequest.java
index fac062007..8dd269745 100644
--- a/proto-google-cloud-pubsub-v1/src/main/java/com/google/pubsub/v1/PullRequest.java
+++ b/proto-google-cloud-pubsub-v1/src/main/java/com/google/pubsub/v1/PullRequest.java
@@ -136,7 +136,7 @@ public com.google.protobuf.ByteString getSubscriptionBytes() {
    * </code>
    *
    * @deprecated google.pubsub.v1.PullRequest.return_immediately is deprecated. See
-   *     google/pubsub/v1/pubsub.proto;l=1222
+   *     google/pubsub/v1/pubsub.proto;l=1226
    * @return The returnImmediately.
    */
   @java.lang.Override
@@ -687,7 +687,7 @@ public Builder setSubscriptionBytes(com.google.protobuf.ByteString value) {
      * </code>
      *
      * @deprecated google.pubsub.v1.PullRequest.return_immediately is deprecated. See
-     *     google/pubsub/v1/pubsub.proto;l=1222
+     *     google/pubsub/v1/pubsub.proto;l=1226
      * @return The returnImmediately.
      */
     @java.lang.Override
@@ -713,7 +713,7 @@ public boolean getReturnImmediately() {
      * </code>
      *
      * @deprecated google.pubsub.v1.PullRequest.return_immediately is deprecated. See
-     *     google/pubsub/v1/pubsub.proto;l=1222
+     *     google/pubsub/v1/pubsub.proto;l=1226
      * @param value The returnImmediately to set.
      * @return This builder for chaining.
      */
@@ -743,7 +743,7 @@ public Builder setReturnImmediately(boolean value) {
      * </code>
      *
      * @deprecated google.pubsub.v1.PullRequest.return_immediately is deprecated. See
-     *     google/pubsub/v1/pubsub.proto;l=1222
+     *     google/pubsub/v1/pubsub.proto;l=1226
      * @return This builder for chaining.
      */
     @java.lang.Deprecated
diff --git a/proto-google-cloud-pubsub-v1/src/main/java/com/google/pubsub/v1/PullRequestOrBuilder.java b/proto-google-cloud-pubsub-v1/src/main/java/com/google/pubsub/v1/PullRequestOrBuilder.java
index 5cb9c98a3..963c7f799 100644
--- a/proto-google-cloud-pubsub-v1/src/main/java/com/google/pubsub/v1/PullRequestOrBuilder.java
+++ b/proto-google-cloud-pubsub-v1/src/main/java/com/google/pubsub/v1/PullRequestOrBuilder.java
@@ -71,7 +71,7 @@ public interface PullRequestOrBuilder
    * </code>
    *
    * @deprecated google.pubsub.v1.PullRequest.return_immediately is deprecated. See
-   *     google/pubsub/v1/pubsub.proto;l=1222
+   *     google/pubsub/v1/pubsub.proto;l=1226
    * @return The returnImmediately.
    */
   @java.lang.Deprecated
diff --git a/proto-google-cloud-pubsub-v1/src/main/proto/google/pubsub/v1/pubsub.proto b/proto-google-cloud-pubsub-v1/src/main/proto/google/pubsub/v1/pubsub.proto
index 9ff80f2f6..4468de178 100644
--- a/proto-google-cloud-pubsub-v1/src/main/proto/google/pubsub/v1/pubsub.proto
+++ b/proto-google-cloud-pubsub-v1/src/main/proto/google/pubsub/v1/pubsub.proto
@@ -1030,7 +1030,11 @@ message CloudStorageConfig {
   // Message payloads and metadata will be written to files as an Avro binary.
   message AvroConfig {
     // When true, write the subscription name, message_id, publish_time,
-    // attributes, and ordering_key as additional fields in the output.
+    // attributes, and ordering_key as additional fields in the output. The
+    // subscription name, message_id, and publish_time fields are put in their
+    // own fields while all other message properties other than data (for
+    // example, an ordering_key, if present) are added as entries in the
+    // attributes map.
     bool write_metadata = 1;
   }