Skip to content

Commit df57705

Browse files
docs: add clarification on non-editable metadata (#1939)
* docs: add clarification on non-editable metadata * 🦉 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 dbc7534 commit df57705

File tree

1 file changed

+29
-7
lines changed
  • google-cloud-storage/src/main/java/com/google/cloud/storage

1 file changed

+29
-7
lines changed

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

Lines changed: 29 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2112,7 +2112,10 @@ public static Builder newBuilder() {
21122112
Bucket create(BucketInfo bucketInfo, BucketTargetOption... options);
21132113

21142114
/**
2115-
* Creates a new blob with no content.
2115+
* Creates a new blob with no content. Note that all <a
2116+
* href="https://cloud.google.com/storage/docs/metadata#fixed">non-editable metadata</a>, such as
2117+
* generation or metageneration, will be ignored even if it's present in the provided BlobInfo
2118+
* object.
21162119
*
21172120
* <p>Example of creating a blob with no content.
21182121
*
@@ -2135,7 +2138,10 @@ public static Builder newBuilder() {
21352138
* #writer} is recommended as it uses resumable upload. MD5 and CRC32C hashes of {@code content}
21362139
* are computed and used for validating transferred data. Accepts an optional userProject {@link
21372140
* BlobGetOption} option which defines the project id to assign operational costs. The content
2138-
* type is detected from the blob name if not explicitly set.
2141+
* type is detected from the blob name if not explicitly set. Note that all <a
2142+
* href="https://cloud.google.com/storage/docs/metadata#fixed">non-editable metadata</a>, such as
2143+
* generation or metageneration, will be ignored even if it's present in the provided BlobInfo
2144+
* object.
21392145
*
21402146
* <p>Example of creating a blob from a byte array:
21412147
*
@@ -2159,7 +2165,10 @@ public static Builder newBuilder() {
21592165
* {@code content}. For large content, {@link #writer} is recommended as it uses resumable upload.
21602166
* MD5 and CRC32C hashes of {@code content} are computed and used for validating transferred data.
21612167
* Accepts a userProject {@link BlobGetOption} option, which defines the project id to assign
2162-
* operational costs.
2168+
* operational costs. Note that all <a
2169+
* href="https://cloud.google.com/storage/docs/metadata#fixed">non-editable metadata</a>, such as
2170+
* generation or metageneration, will be ignored even if it's present in the provided BlobInfo
2171+
* object.
21632172
*
21642173
* <p>Example of creating a blob from a byte array:
21652174
*
@@ -2184,7 +2193,10 @@ Blob create(
21842193
* #writer} is recommended as it uses resumable upload. By default any MD5 and CRC32C values in
21852194
* the given {@code blobInfo} are ignored unless requested via the {@code
21862195
* BlobWriteOption.md5Match} and {@code BlobWriteOption.crc32cMatch} options. The given input
2187-
* stream is closed upon success.
2196+
* stream is closed upon success. Note that all <a
2197+
* href="https://cloud.google.com/storage/docs/metadata#fixed">non-editable metadata</a>, such as
2198+
* generation or metageneration, will be ignored even if it's present in the provided BlobInfo
2199+
* object.
21882200
*
21892201
* <p>This method is marked as {@link Deprecated} because it cannot safely retry, given that it
21902202
* accepts an {@link InputStream} which can only be consumed once.
@@ -2226,7 +2238,9 @@ Blob create(
22262238
* Uploads {@code path} to the blob using {@link #writer}. By default any MD5 and CRC32C values in
22272239
* the given {@code blobInfo} are ignored unless requested via the {@link
22282240
* BlobWriteOption#md5Match()} and {@link BlobWriteOption#crc32cMatch()} options. Folder upload is
2229-
* not supported.
2241+
* not supported. Note that all <a href="https://cloud.google.com/storage/docs/metadata#fixed">
2242+
* non-editable metadata</a>, such as generation or metageneration, will be ignored even if it's
2243+
* present in the provided BlobInfo object.
22302244
*
22312245
* <p>Example of uploading a file:
22322246
*
@@ -2253,7 +2267,9 @@ Blob create(
22532267
* Uploads {@code path} to the blob using {@link #writer} and {@code bufferSize}. By default any
22542268
* MD5 and CRC32C values in the given {@code blobInfo} are ignored unless requested via the {@link
22552269
* BlobWriteOption#md5Match()} and {@link BlobWriteOption#crc32cMatch()} options. Folder upload is
2256-
* not supported.
2270+
* not supported. Note that all <a href="https://cloud.google.com/storage/docs/metadata#fixed">
2271+
* non-editable metadata</a>, such as generation or metageneration, will be ignored even if it's
2272+
* present in the provided BlobInfo object.
22572273
*
22582274
* <p>{@link #createFrom(BlobInfo, Path, BlobWriteOption...)} invokes this method with a buffer
22592275
* size of 15 MiB. Users can pass alternative values. Larger buffer sizes might improve the upload
@@ -2288,6 +2304,9 @@ Blob createFrom(BlobInfo blobInfo, Path path, int bufferSize, BlobWriteOption...
22882304
* Reads bytes from an input stream and uploads those bytes to the blob using {@link #writer}. By
22892305
* default any MD5 and CRC32C values in the given {@code blobInfo} are ignored unless requested
22902306
* via the {@link BlobWriteOption#md5Match()} and {@link BlobWriteOption#crc32cMatch()} options.
2307+
* Note that all <a href="https://cloud.google.com/storage/docs/metadata#fixed">non-editable
2308+
* metadata</a>, such as generation or metageneration, will be ignored even if it's present in the
2309+
* provided BlobInfo object.
22912310
*
22922311
* <p>Example of uploading data with CRC32C checksum:
22932312
*
@@ -2316,7 +2335,10 @@ Blob createFrom(BlobInfo blobInfo, InputStream content, BlobWriteOption... optio
23162335
* Reads bytes from an input stream and uploads those bytes to the blob using {@link #writer} and
23172336
* {@code bufferSize}. By default any MD5 and CRC32C values in the given {@code blobInfo} are
23182337
* ignored unless requested via the {@link BlobWriteOption#md5Match()} and {@link
2319-
* BlobWriteOption#crc32cMatch()} options.
2338+
* BlobWriteOption#crc32cMatch()} options. Note that all <a
2339+
* href="https://cloud.google.com/storage/docs/metadata#fixed">non-editable metadata</a>, such as
2340+
* generation or metageneration, will be ignored even if it's present in the provided BlobInfo
2341+
* object.
23202342
*
23212343
* <p>{@link #createFrom(BlobInfo, InputStream, BlobWriteOption...)} )} invokes this method with a
23222344
* buffer size of 15 MiB. Users can pass alternative values. Larger buffer sizes might improve the

0 commit comments

Comments
 (0)