Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Merged
merged 2 commits into from
Jul 26, 2023
Merged

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9ce8035
docs: clarified where ordering_key will be written if write_metadata …
gcf-owl-bot[bot] Jul 26, 2023
c162276
🦉 Updates from OwlBot post-processor
gcf-owl-bot[bot] Jul 26, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 25 additions & 5 deletions proto-google-cloud-pubsub-v1/src/main/java/com/google/pubsub/v1/CloudStorageConfig.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand Down Expand Up @@ -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>
Expand Down Expand Up @@ -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>
Expand All @@ -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>
Expand All @@ -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>
Expand Down
8 changes: 4 additions & 4 deletions proto-google-cloud-pubsub-v1/src/main/java/com/google/pubsub/v1/PullRequest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand All @@ -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.
*/
Expand Down Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion proto-google-cloud-pubsub-v1/src/main/java/com/google/pubsub/v1/PullRequestOrBuilder.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
6 changes: 5 additions & 1 deletion proto-google-cloud-pubsub-v1/src/main/proto/google/pubsub/v1/pubsub.proto
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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;
}

Expand Down