Skip to content

Commit 98e694f

Browse files
authored
docs: reorder columns in table of BlobWriteSessionConfigs.java (#2242)
The considerations column being last is cut off in the ultimate rendered javadocs. Move it left before retries and apis used.
1 parent a599c63 commit 98e694f

File tree

1 file changed

+39
-39
lines changed

1 file changed

+39
-39
lines changed

google-cloud-storage/src/main/java/com/google/cloud/storage/BlobWriteSessionConfigs.java

Lines changed: 39 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -41,10 +41,10 @@
4141
* <th>Strategy</th>
4242
* <th>Factory Method(s)</th>
4343
* <th>Description</th>
44+
* <th>Transport(s) Supported</th>
45+
* <th>Considerations</th>
4446
* <th>Retry Support</th>
45-
* <th>Transports Supported</th>
4647
* <th>Cloud Storage API used</th>
47-
* <th>Considerations</th>
4848
* </tr>
4949
* <tr>
5050
* <td>Default (Chunk based upload)</td>
@@ -54,12 +54,7 @@
5454
* full or close. Buffer size is configurable via
5555
* {@link DefaultBlobWriteSessionConfig#withChunkSize(int)}
5656
* </td>
57-
* <td>
58-
* Each chunk is retried up to the limitations specified in
59-
* {@link StorageOptions#getRetrySettings()}
60-
* </td>
6157
* <td>gRPC</td>
62-
* <td><a href="https://cloud.google.com/storage/docs/resumable-uploads">Resumable Upload</a></td>
6358
* <td>The network will only be used for the following operations:
6459
* <ol>
6560
* <li>Creating the Resumable Upload Session</li>
@@ -71,6 +66,11 @@
7166
* </li>
7267
* </ol>
7368
* </td>
69+
* <td>
70+
* Each chunk is retried up to the limitations specified in
71+
* {@link StorageOptions#getRetrySettings()}
72+
* </td>
73+
* <td><a href="https://cloud.google.com/storage/docs/resumable-uploads">Resumable Upload</a></td>
7474
* </tr>
7575
* <tr>
7676
* <td>Buffer to disk then upload</td>
@@ -85,12 +85,7 @@
8585
* Buffer bytes to a temporary file on disk. On {@link WritableByteChannel#close() close()}
8686
* upload the entire files contents to Cloud Storage. Delete the temporary file.
8787
* </td>
88-
* <td>
89-
* Upload the file in the fewest number of RPC possible retrying within the limitations
90-
* specified in {@link StorageOptions#getRetrySettings()}
91-
* </td>
9288
* <td>gRPC</td>
93-
* <td><a href="https://cloud.google.com/storage/docs/resumable-uploads">Resumable Upload</a></td>
9489
* <td>
9590
* <ol>
9691
* <li>A Resumable Upload Session will be used to upload the file on disk.</li>
@@ -100,6 +95,11 @@
10095
* </li>
10196
* </ol>
10297
* </td>
98+
* <td>
99+
* Upload the file in the fewest number of RPC possible retrying within the limitations
100+
* specified in {@link StorageOptions#getRetrySettings()}
101+
* </td>
102+
* <td><a href="https://cloud.google.com/storage/docs/resumable-uploads">Resumable Upload</a></td>
103103
* </tr>
104104
* <tr>
105105
* <td>Journal to disk while uploading</td>
@@ -110,12 +110,7 @@
110110
* retryable error query the offset of the Resumable Upload Session, then open the recovery
111111
* file from the offset and transmit the bytes to Cloud Storage.
112112
* </td>
113-
* <td>
114-
* Opening the stream for upload will be retried up to the limitations specified in {@link StorageOptions#getRetrySettings()}
115-
* All bytes are buffered to disk and allow for recovery from any arbitrary offset.
116-
* </td>
117113
* <td>gRPC</td>
118-
* <td><a href="https://cloud.google.com/storage/docs/resumable-uploads">Resumable Upload</a></td>
119114
* <td>
120115
* <ol>
121116
* <li>
@@ -133,6 +128,11 @@
133128
* </li>
134129
* </ol>
135130
* </td>
131+
* <td>
132+
* Opening the stream for upload will be retried up to the limitations specified in {@link StorageOptions#getRetrySettings()}
133+
* All bytes are buffered to disk and allow for recovery from any arbitrary offset.
134+
* </td>
135+
* <td><a href="https://cloud.google.com/storage/docs/resumable-uploads">Resumable Upload</a></td>
136136
* </tr>
137137
* <tr>
138138
* <td>Parallel Composite Upload</td>
@@ -141,30 +141,8 @@
141141
* Break the stream of bytes into smaller part objects uploading each part in parallel. Then
142142
* composing the parts together to make the ultimate object.
143143
* </td>
144-
* <td>
145-
* Automatic retires will be applied for the following:
146-
* <ol>
147-
* <li>Creation of each individual part</li>
148-
* <li>Performing an intermediary compose</li>
149-
* <li>Performing a delete to cleanup each part and intermediary compose object</li>
150-
* </ol>
151-
*
152-
* Retrying the creation of the final object is contingent upon if an appropriate precondition
153-
* is supplied when calling {@link Storage#blobWriteSession(BlobInfo, BlobWriteOption...)}.
154-
* Either {@link BlobTargetOption#doesNotExist()} or {@link Storage.BlobTargetOption#generationMatch(long)}
155-
* should be specified in order to make the final request idempotent.
156-
* <p>Each operation will be retried up to the limitations specified in {@link StorageOptions#getRetrySettings()}
157-
* </td>
158144
* <td>gRPC</td>
159145
* <td>
160-
* <ul>
161-
* <li><a href="https://cloud.google.com/storage/docs/parallel-composite-uploads">Parallel composite uploads</a></li>
162-
* <li><a href="https://cloud.google.com/storage/docs/uploading-objects-from-memory">Direct uploads</a></li>
163-
* <li><a href="https://cloud.google.com/storage/docs/composite-objects">Compose</a></li>
164-
* <li><a href="https://cloud.google.com/storage/docs/deleting-objects">Object delete</a></li>
165-
* </ul>
166-
* </td>
167-
* <td>
168146
* <ol>
169147
* <li>
170148
* Performing parallel composite uploads costs more money.
@@ -217,6 +195,28 @@
217195
* </li>
218196
* </ol>
219197
* </td>
198+
* <td>
199+
* Automatic retires will be applied for the following:
200+
* <ol>
201+
* <li>Creation of each individual part</li>
202+
* <li>Performing an intermediary compose</li>
203+
* <li>Performing a delete to cleanup each part and intermediary compose object</li>
204+
* </ol>
205+
*
206+
* Retrying the creation of the final object is contingent upon if an appropriate precondition
207+
* is supplied when calling {@link Storage#blobWriteSession(BlobInfo, BlobWriteOption...)}.
208+
* Either {@link BlobTargetOption#doesNotExist()} or {@link Storage.BlobTargetOption#generationMatch(long)}
209+
* should be specified in order to make the final request idempotent.
210+
* <p>Each operation will be retried up to the limitations specified in {@link StorageOptions#getRetrySettings()}
211+
* </td>
212+
* <td>
213+
* <ul>
214+
* <li><a href="https://cloud.google.com/storage/docs/parallel-composite-uploads">Parallel composite uploads</a></li>
215+
* <li><a href="https://cloud.google.com/storage/docs/uploading-objects-from-memory">Direct uploads</a></li>
216+
* <li><a href="https://cloud.google.com/storage/docs/composite-objects">Compose</a></li>
217+
* <li><a href="https://cloud.google.com/storage/docs/deleting-objects">Object delete</a></li>
218+
* </ul>
219+
* </td>
220220
* </tr>
221221
* </table>
222222
*

0 commit comments

Comments
 (0)