-
Notifications
You must be signed in to change notification settings - Fork 1.1k
Fix documentation around updating blob metadata #5173
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.
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
Merged
Merged
Changes from 3 commits
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
cb409e9
Fix documentation around updating blob metadata
JesseLovelace 66c9957
Fix documentation around updating blob metadata
JesseLovelace 8f4d41e
Merge branch 'metadatadocumentation' of github.com:googleapis/google-…
JesseLovelace ef46067
Merge branch 'metadatadocumentation' of github.com:googleapis/google-…
JesseLovelace 946d514
Merge branch 'metadatadocumentation' of github.com:googleapis/google-…
JesseLovelace f571270
Merge branch 'metadatadocumentation' of github.com:googleapis/google-…
JesseLovelace d3fd046
Merge branch 'metadatadocumentation' of github.com:googleapis/google-…
JesseLovelace File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -512,17 +512,33 @@ public Blob reload(BlobSourceOption... options) { | |
| * current blob metadata are at their latest version use the {@code metagenerationMatch} option: | ||
| * {@code newBlob.update(BlobTargetOption.metagenerationMatch())}. | ||
| * | ||
| * <p>Original metadata are merged with metadata in the provided in this {@code blob}. To replace | ||
| * metadata instead you first have to unset them. Unsetting metadata can be done by setting this | ||
| * {@code blob}'s metadata to {@code null}. | ||
| * <p>Original metadata are merged with metadata in the provided {@code blobInfo}. If the original | ||
| * metadata already contains a key specified in the provided {@code blobInfo's} metadata map, it | ||
| * will be replaced by the new value. Removing metadata can be done by setting that metadata's | ||
| * value to {@code null}. | ||
| * | ||
| * <p>Example of replacing blob's metadata. | ||
| * <p>Example of adding new metadata values or replacing existing ones. | ||
| * | ||
| * <pre>{@code | ||
| * String bucketName = "my_unique_bucket"; | ||
| * String blobName = "my_blob_name"; | ||
| * Map<String, String> newMetadata = new HashMap<>(); | ||
| * newMetadata.put("keyToAdd", "value"); | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
|
||
| * Blob blob = storage.update(BlobInfo.newBuilder(bucketName, blobName) | ||
| * .setMetadata(newMetadata) | ||
| * .build()); | ||
| * }</pre> | ||
| * | ||
| * <p>Example of removing metadata values. | ||
| * | ||
| * <pre>{@code | ||
| * String bucketName = "my_unique_bucket"; | ||
| * String blobName = "my_blob_name"; | ||
| * Map<String, String> newMetadata = new HashMap<>(); | ||
| * newMetadata.put("key", "value"); | ||
| * blob.toBuilder().setMetadata(null).build().update(); | ||
| * Blob updatedBlob = blob.toBuilder().setMetadata(newMetadata).build().update(); | ||
| * newMetadata.put("keyToRemove", null); | ||
| * Blob blob = storage.update(BlobInfo.newBuilder(bucketName, blobName) | ||
| * .setMetadata(newMetadata) | ||
| * .build()); | ||
| * }</pre> | ||
| * | ||
| * @param options update options | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -1718,17 +1718,29 @@ Blob create( | |
|
|
||
| /** | ||
| * Updates blob information. Original metadata are merged with metadata in the provided {@code | ||
| * blobInfo}. To replace metadata instead you first have to unset them. Unsetting metadata can be | ||
| * done by setting the provided {@code blobInfo}'s metadata to {@code null}. | ||
| * blobInfo}. If the original metadata already contains a key specified in the provided {@code | ||
| * blobInfo's} metadata map, it will be replaced by the new value. Removing metadata can be done | ||
| * by setting that metadata's value to {@code null}. | ||
| * | ||
| * <p>Example of adding new metadata values or replacing existing ones. | ||
| * | ||
| * <pre>{@code | ||
| * String bucketName = "my_unique_bucket"; | ||
| * String blobName = "my_blob_name"; | ||
| * Map<String, String> newMetadata = new HashMap<>(); | ||
| * newMetadata.put("keyToAdd", "value"); | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
|
||
| * Blob blob = storage.update(BlobInfo.newBuilder(bucketName, blobName) | ||
| * .setMetadata(newMetadata) | ||
| * .build()); | ||
| * }</pre> | ||
| * | ||
| * <p>Example of replacing blob's metadata. | ||
| * <p>Example of removing metadata values. | ||
| * | ||
| * <pre>{@code | ||
| * String bucketName = "my_unique_bucket"; | ||
| * String blobName = "my_blob_name"; | ||
| * Map<String, String> newMetadata = new HashMap<>(); | ||
| * newMetadata.put("key", "value"); | ||
| * storage.update(BlobInfo.newBuilder(bucketName, blobName).setMetadata(null).build()); | ||
| * newMetadata.put("keyToRemove", null); | ||
| * Blob blob = storage.update(BlobInfo.newBuilder(bucketName, blobName) | ||
| * .setMetadata(newMetadata) | ||
| * .build()); | ||
|
|
||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
replacing -> updating