Skip to content

Commit 3d97bdd

Browse files
gcf-owl-bot[bot]gcf-owl-bot[bot]
authored
docs: Updated ChecksummedData message definition to specify ctype=CORD, and removed incorrect earlier attempt that set that annotation in the ReadObjectResponse message definition (#1959)
* docs: Updated ChecksummedData message definition to specify ctype=CORD, and removed incorrect earlier attempt that set that annotation in the ReadObjectResponse message definition docs: Clarified behavior of resumable upload cancellation PiperOrigin-RevId: 520467605 Source-Link: googleapis/googleapis@ae0254f Source-Link: https://github.com/googleapis/googleapis-gen/commit/9b05c311fb9086850234522ef6b5775490a87807 Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiOWIwNWMzMTFmYjkwODY4NTAyMzQ1MjJlZjZiNTc3NTQ5MGE4NzgwNyJ9 * 🦉 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>
1 parent c0ffe7c commit 3d97bdd

File tree

8 files changed

+291
-249
lines changed

8 files changed

+291
-249
lines changed

‎gapic-google-cloud-storage-v2/src/main/java/com/google/storage/v2/StorageClient.java

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2200,6 +2200,11 @@ public final UnaryCallable<DeleteObjectRequest, Empty> deleteObjectCallable() {
22002200
/**
22012201
* Cancels an in-progress resumable upload.
22022202
*
2203+
* <p>Any attempts to write to the resumable upload after cancelling the upload will fail.
2204+
*
2205+
* <p>The behavior for currently in progress write operations is not guaranteed - they could
2206+
* either complete before the cancellation or fail if the cancellation completes first.
2207+
*
22032208
* <p>Sample code:
22042209
*
22052210
* <pre>{@code
@@ -2228,6 +2233,11 @@ public final CancelResumableWriteResponse cancelResumableWrite(String uploadId)
22282233
/**
22292234
* Cancels an in-progress resumable upload.
22302235
*
2236+
* <p>Any attempts to write to the resumable upload after cancelling the upload will fail.
2237+
*
2238+
* <p>The behavior for currently in progress write operations is not guaranteed - they could
2239+
* either complete before the cancellation or fail if the cancellation completes first.
2240+
*
22312241
* <p>Sample code:
22322242
*
22332243
* <pre>{@code
@@ -2255,6 +2265,11 @@ public final CancelResumableWriteResponse cancelResumableWrite(
22552265
/**
22562266
* Cancels an in-progress resumable upload.
22572267
*
2268+
* <p>Any attempts to write to the resumable upload after cancelling the upload will fail.
2269+
*
2270+
* <p>The behavior for currently in progress write operations is not guaranteed - they could
2271+
* either complete before the cancellation or fail if the cancellation completes first.
2272+
*
22582273
* <p>Sample code:
22592274
*
22602275
* <pre>{@code

‎grpc-google-cloud-storage-v2/src/main/java/com/google/storage/v2/StorageGrpc.java

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1613,6 +1613,11 @@ default void deleteObject(
16131613
*
16141614
* <pre>
16151615
* Cancels an in-progress resumable upload.
1616+
* Any attempts to write to the resumable upload after cancelling the upload
1617+
* will fail.
1618+
* The behavior for currently in progress write operations is not guaranteed -
1619+
* they could either complete before the cancellation or fail if the
1620+
* cancellation completes first.
16161621
* </pre>
16171622
*/
16181623
default void cancelResumableWrite(
@@ -2209,6 +2214,11 @@ public void deleteObject(
22092214
*
22102215
* <pre>
22112216
* Cancels an in-progress resumable upload.
2217+
* Any attempts to write to the resumable upload after cancelling the upload
2218+
* will fail.
2219+
* The behavior for currently in progress write operations is not guaranteed -
2220+
* they could either complete before the cancellation or fail if the
2221+
* cancellation completes first.
22122222
* </pre>
22132223
*/
22142224
public void cancelResumableWrite(
@@ -2751,6 +2761,11 @@ public com.google.protobuf.Empty deleteObject(
27512761
*
27522762
* <pre>
27532763
* Cancels an in-progress resumable upload.
2764+
* Any attempts to write to the resumable upload after cancelling the upload
2765+
* will fail.
2766+
* The behavior for currently in progress write operations is not guaranteed -
2767+
* they could either complete before the cancellation or fail if the
2768+
* cancellation completes first.
27542769
* </pre>
27552770
*/
27562771
public com.google.storage.v2.CancelResumableWriteResponse cancelResumableWrite(
@@ -3200,6 +3215,11 @@ protected StorageFutureStub build(io.grpc.Channel channel, io.grpc.CallOptions c
32003215
*
32013216
* <pre>
32023217
* Cancels an in-progress resumable upload.
3218+
* Any attempts to write to the resumable upload after cancelling the upload
3219+
* will fail.
3220+
* The behavior for currently in progress write operations is not guaranteed -
3221+
* they could either complete before the cancellation or fail if the
3222+
* cancellation completes first.
32033223
* </pre>
32043224
*/
32053225
public com.google.common.util.concurrent.ListenableFuture<

‎proto-google-cloud-storage-v2/src/main/java/com/google/storage/v2/ChecksummedData.java

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@ public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() {
7878
* The data.
7979
* </pre>
8080
*
81-
* <code>bytes content = 1;</code>
81+
* <code>bytes content = 1 [ctype = CORD];</code>
8282
*
8383
* @return The content.
8484
*/
@@ -496,7 +496,7 @@ public Builder mergeFrom(
496496
* The data.
497497
* </pre>
498498
*
499-
* <code>bytes content = 1;</code>
499+
* <code>bytes content = 1 [ctype = CORD];</code>
500500
*
501501
* @return The content.
502502
*/
@@ -511,7 +511,7 @@ public com.google.protobuf.ByteString getContent() {
511511
* The data.
512512
* </pre>
513513
*
514-
* <code>bytes content = 1;</code>
514+
* <code>bytes content = 1 [ctype = CORD];</code>
515515
*
516516
* @param value The content to set.
517517
* @return This builder for chaining.
@@ -532,7 +532,7 @@ public Builder setContent(com.google.protobuf.ByteString value) {
532532
* The data.
533533
* </pre>
534534
*
535-
* <code>bytes content = 1;</code>
535+
* <code>bytes content = 1 [ctype = CORD];</code>
536536
*
537537
* @return This builder for chaining.
538538
*/

‎proto-google-cloud-storage-v2/src/main/java/com/google/storage/v2/ChecksummedDataOrBuilder.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ public interface ChecksummedDataOrBuilder
3030
* The data.
3131
* </pre>
3232
*
33-
* <code>bytes content = 1;</code>
33+
* <code>bytes content = 1 [ctype = CORD];</code>
3434
*
3535
* @return The content.
3636
*/

‎proto-google-cloud-storage-v2/src/main/java/com/google/storage/v2/ReadObjectResponse.java

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@ public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() {
7777
* generate more data.
7878
* </pre>
7979
*
80-
* <code>.google.storage.v2.ChecksummedData checksummed_data = 1 [ctype = CORD];</code>
80+
* <code>.google.storage.v2.ChecksummedData checksummed_data = 1;</code>
8181
*
8282
* @return Whether the checksummedData field is set.
8383
*/
@@ -95,7 +95,7 @@ public boolean hasChecksummedData() {
9595
* generate more data.
9696
* </pre>
9797
*
98-
* <code>.google.storage.v2.ChecksummedData checksummed_data = 1 [ctype = CORD];</code>
98+
* <code>.google.storage.v2.ChecksummedData checksummed_data = 1;</code>
9999
*
100100
* @return The checksummedData.
101101
*/
@@ -115,7 +115,7 @@ public com.google.storage.v2.ChecksummedData getChecksummedData() {
115115
* generate more data.
116116
* </pre>
117117
*
118-
* <code>.google.storage.v2.ChecksummedData checksummed_data = 1 [ctype = CORD];</code>
118+
* <code>.google.storage.v2.ChecksummedData checksummed_data = 1;</code>
119119
*/
120120
@java.lang.Override
121121
public com.google.storage.v2.ChecksummedDataOrBuilder getChecksummedDataOrBuilder() {
@@ -744,7 +744,7 @@ public Builder mergeFrom(
744744
* generate more data.
745745
* </pre>
746746
*
747-
* <code>.google.storage.v2.ChecksummedData checksummed_data = 1 [ctype = CORD];</code>
747+
* <code>.google.storage.v2.ChecksummedData checksummed_data = 1;</code>
748748
*
749749
* @return Whether the checksummedData field is set.
750750
*/
@@ -761,7 +761,7 @@ public boolean hasChecksummedData() {
761761
* generate more data.
762762
* </pre>
763763
*
764-
* <code>.google.storage.v2.ChecksummedData checksummed_data = 1 [ctype = CORD];</code>
764+
* <code>.google.storage.v2.ChecksummedData checksummed_data = 1;</code>
765765
*
766766
* @return The checksummedData.
767767
*/
@@ -784,7 +784,7 @@ public com.google.storage.v2.ChecksummedData getChecksummedData() {
784784
* generate more data.
785785
* </pre>
786786
*
787-
* <code>.google.storage.v2.ChecksummedData checksummed_data = 1 [ctype = CORD];</code>
787+
* <code>.google.storage.v2.ChecksummedData checksummed_data = 1;</code>
788788
*/
789789
public Builder setChecksummedData(com.google.storage.v2.ChecksummedData value) {
790790
if (checksummedDataBuilder_ == null) {
@@ -809,7 +809,7 @@ public Builder setChecksummedData(com.google.storage.v2.ChecksummedData value) {
809809
* generate more data.
810810
* </pre>
811811
*
812-
* <code>.google.storage.v2.ChecksummedData checksummed_data = 1 [ctype = CORD];</code>
812+
* <code>.google.storage.v2.ChecksummedData checksummed_data = 1;</code>
813813
*/
814814
public Builder setChecksummedData(
815815
com.google.storage.v2.ChecksummedData.Builder builderForValue) {
@@ -832,7 +832,7 @@ public Builder setChecksummedData(
832832
* generate more data.
833833
* </pre>
834834
*
835-
* <code>.google.storage.v2.ChecksummedData checksummed_data = 1 [ctype = CORD];</code>
835+
* <code>.google.storage.v2.ChecksummedData checksummed_data = 1;</code>
836836
*/
837837
public Builder mergeChecksummedData(com.google.storage.v2.ChecksummedData value) {
838838
if (checksummedDataBuilder_ == null) {
@@ -860,7 +860,7 @@ public Builder mergeChecksummedData(com.google.storage.v2.ChecksummedData value)
860860
* generate more data.
861861
* </pre>
862862
*
863-
* <code>.google.storage.v2.ChecksummedData checksummed_data = 1 [ctype = CORD];</code>
863+
* <code>.google.storage.v2.ChecksummedData checksummed_data = 1;</code>
864864
*/
865865
public Builder clearChecksummedData() {
866866
bitField0_ = (bitField0_ & ~0x00000001);
@@ -882,7 +882,7 @@ public Builder clearChecksummedData() {
882882
* generate more data.
883883
* </pre>
884884
*
885-
* <code>.google.storage.v2.ChecksummedData checksummed_data = 1 [ctype = CORD];</code>
885+
* <code>.google.storage.v2.ChecksummedData checksummed_data = 1;</code>
886886
*/
887887
public com.google.storage.v2.ChecksummedData.Builder getChecksummedDataBuilder() {
888888
bitField0_ |= 0x00000001;
@@ -899,7 +899,7 @@ public com.google.storage.v2.ChecksummedData.Builder getChecksummedDataBuilder()
899899
* generate more data.
900900
* </pre>
901901
*
902-
* <code>.google.storage.v2.ChecksummedData checksummed_data = 1 [ctype = CORD];</code>
902+
* <code>.google.storage.v2.ChecksummedData checksummed_data = 1;</code>
903903
*/
904904
public com.google.storage.v2.ChecksummedDataOrBuilder getChecksummedDataOrBuilder() {
905905
if (checksummedDataBuilder_ != null) {
@@ -920,7 +920,7 @@ public com.google.storage.v2.ChecksummedDataOrBuilder getChecksummedDataOrBuilde
920920
* generate more data.
921921
* </pre>
922922
*
923-
* <code>.google.storage.v2.ChecksummedData checksummed_data = 1 [ctype = CORD];</code>
923+
* <code>.google.storage.v2.ChecksummedData checksummed_data = 1;</code>
924924
*/
925925
private com.google.protobuf.SingleFieldBuilderV3<
926926
com.google.storage.v2.ChecksummedData,

‎proto-google-cloud-storage-v2/src/main/java/com/google/storage/v2/ReadObjectResponseOrBuilder.java

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ public interface ReadObjectResponseOrBuilder
3333
* generate more data.
3434
* </pre>
3535
*
36-
* <code>.google.storage.v2.ChecksummedData checksummed_data = 1 [ctype = CORD];</code>
36+
* <code>.google.storage.v2.ChecksummedData checksummed_data = 1;</code>
3737
*
3838
* @return Whether the checksummedData field is set.
3939
*/
@@ -48,7 +48,7 @@ public interface ReadObjectResponseOrBuilder
4848
* generate more data.
4949
* </pre>
5050
*
51-
* <code>.google.storage.v2.ChecksummedData checksummed_data = 1 [ctype = CORD];</code>
51+
* <code>.google.storage.v2.ChecksummedData checksummed_data = 1;</code>
5252
*
5353
* @return The checksummedData.
5454
*/
@@ -63,7 +63,7 @@ public interface ReadObjectResponseOrBuilder
6363
* generate more data.
6464
* </pre>
6565
*
66-
* <code>.google.storage.v2.ChecksummedData checksummed_data = 1 [ctype = CORD];</code>
66+
* <code>.google.storage.v2.ChecksummedData checksummed_data = 1;</code>
6767
*/
6868
com.google.storage.v2.ChecksummedDataOrBuilder getChecksummedDataOrBuilder();
6969

0 commit comments

Comments
 (0)