Skip to content

Commit

Permalink
docs: Add documentation about quantum write alignment, use of ObjectC…
Browse files Browse the repository at this point in the history
…hecksums, Bucket.name format, and Object.delete_time (#2032)

* feat: Add ctype=CORD for ChecksummedData.content
docs: Add documentation about quantum write alignment, use of ObjectChecksums, Bucket.name format, and Object.delete_time

PiperOrigin-RevId: 534116186

Source-Link: googleapis/googleapis@117be9d

Source-Link: googleapis/googleapis-gen@8b2ea92
Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiOGIyZWE5MjY3Mjk1ODM5YzAzYjZiMTI5YThmOWQ5YzQ4ZDU5ODYxYyJ9

chore: upgrading Protobuf to 23.1 and gRPC to 1.55.0 in code generation

PiperOrigin-RevId: 534084593

Source-Link: googleapis/googleapis@aa4559a

Source-Link: googleapis/googleapis-gen@370325a
Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiMzcwMzI1YWY4MjM2NzMyZjU4ODVmNTk0MGUwZWY0ODFmZWU4MzAwMyJ9

* docs: clarified the behavior of supplying bucket.name field in CreateBucket to reflect actual implementation

PiperOrigin-RevId: 535720951

Source-Link: googleapis/googleapis@e54ab8c

Source-Link: googleapis/googleapis-gen@47a36bd
Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiNDdhMzZiZGUzYTQ1OTQxNzhkOTNjY2ViNWRmMmMwMGUzNDk0YmU4MiJ9

* chore: upgrading protobuf to 23.2 for code generation

PiperOrigin-RevId: 537035741

Source-Link: googleapis/googleapis@640f743

Source-Link: googleapis/googleapis-gen@5ec02ed
Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiNWVjMDJlZDIwMjI4NzhmOTljOTRjNzYzMDYwZmY2YTAxODg5NmI2ZSJ9

* chore: upgrading protobuf to 23.2 for code generation

---------

Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com>
  • Loading branch information
gcf-owl-bot[bot] and gcf-owl-bot[bot] committed Jun 6, 2023
1 parent ee1ea32 commit c39ec13
Show file tree
Hide file tree
Showing 71 changed files with 988 additions and 1,193 deletions.
Expand Up @@ -426,10 +426,10 @@ public final UnaryCallable<GetBucketRequest, Bucket> getBucketCallable() {
*
* @param parent Required. The project to which this bucket will belong.
* @param bucket Properties of the new bucket being inserted. The name of the bucket is specified
* in the `bucket_id` field. Populating `bucket.name` field will result in an error. The
* project of the bucket must be specified in the `bucket.project` field. This field must be
* in `projects/{projectIdentifier}` format, {projectIdentifier} can be the project ID or
* project number. The `parent` field must be either empty or `projects/_`.
* in the `bucket_id` field. Populating `bucket.name` field will be ignored. The project of
* the bucket must be specified in the `bucket.project` field. This field must be in
* `projects/{projectIdentifier}` format, {projectIdentifier} can be the project ID or project
* number. The `parent` field must be either empty or `projects/_`.
* @param bucketId Required. The ID to use for this bucket, which will become the final component
* of the bucket's resource name. For example, the value `foo` might result in a bucket with
* the name `projects/123456/buckets/foo`.
Expand Down Expand Up @@ -467,10 +467,10 @@ public final Bucket createBucket(ProjectName parent, Bucket bucket, String bucke
*
* @param parent Required. The project to which this bucket will belong.
* @param bucket Properties of the new bucket being inserted. The name of the bucket is specified
* in the `bucket_id` field. Populating `bucket.name` field will result in an error. The
* project of the bucket must be specified in the `bucket.project` field. This field must be
* in `projects/{projectIdentifier}` format, {projectIdentifier} can be the project ID or
* project number. The `parent` field must be either empty or `projects/_`.
* in the `bucket_id` field. Populating `bucket.name` field will be ignored. The project of
* the bucket must be specified in the `bucket.project` field. This field must be in
* `projects/{projectIdentifier}` format, {projectIdentifier} can be the project ID or project
* number. The `parent` field must be either empty or `projects/_`.
* @param bucketId Required. The ID to use for this bucket, which will become the final component
* of the bucket's resource name. For example, the value `foo` might result in a bucket with
* the name `projects/123456/buckets/foo`.
Expand Down Expand Up @@ -2674,7 +2674,9 @@ public final UnaryCallable<UpdateObjectRequest, Object> updateObjectCallable() {
* were already persisted (without checking that it matches the previously written data), and
* write only the data starting from the persisted offset. Even though the data isn't written, it
* may still incur a performance cost over resuming at the correct write offset. This behavior can
* make client-side handling simpler in some cases.
* make client-side handling simpler in some cases. - Clients must only send data that is a
* multiple of 256 KiB per message, unless the object is being finished with `finish_write` set to
* `true`.
*
* <p>The service will not view the object as complete until the client has sent a
* `WriteObjectRequest` with `finish_write` set to `true`. Sending any requests on a stream after
Expand Down
Expand Up @@ -1713,6 +1713,8 @@ default void updateObject(
* persisted offset. Even though the data isn't written, it may still
* incur a performance cost over resuming at the correct write offset.
* This behavior can make client-side handling simpler in some cases.
* - Clients must only send data that is a multiple of 256 KiB per message,
* unless the object is being finished with `finish_write` set to `true`.
* The service will not view the object as complete until the client has
* sent a `WriteObjectRequest` with `finish_write` set to `true`. Sending any
* requests on a stream after sending a request with `finish_write` set to
Expand Down Expand Up @@ -2320,6 +2322,8 @@ public void updateObject(
* persisted offset. Even though the data isn't written, it may still
* incur a performance cost over resuming at the correct write offset.
* This behavior can make client-side handling simpler in some cases.
* - Clients must only send data that is a multiple of 256 KiB per message,
* unless the object is being finished with `finish_write` set to `true`.
* The service will not view the object as complete until the client has
* sent a `WriteObjectRequest` with `finish_write` set to `true`. Sending any
* requests on a stream after sending a request with `finish_write` set to
Expand Down

0 comments on commit c39ec13

Please sign in to comment.