Skip to content
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

docs: Update DeleteObject Sample to be clearer on object versioning behavior #2595

Merged
merged 7 commits into from
Jun 26, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ If you are using Maven without the BOM, add this to your dependencies:
If you are using Gradle 5.x or later, add this to your dependencies:

```Groovy
implementation platform('com.google.cloud:libraries-bom:26.41.0')
implementation platform('com.google.cloud:libraries-bom:26.42.0')

implementation 'com.google.cloud:google-cloud-storage'
```
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@

// [START storage_delete_file]
import com.google.cloud.storage.Blob;
import com.google.cloud.storage.BlobId;
import com.google.cloud.storage.Storage;
import com.google.cloud.storage.StorageOptions;

Expand All @@ -38,16 +39,19 @@ public static void deleteObject(String projectId, String bucketName, String obje
System.out.println("The object " + objectName + " wasn't found in " + bucketName);
return;
}

// Optional: set a generation-match precondition to avoid potential race
// conditions and data corruptions. The request to upload returns a 412 error if
// the object's generation number does not match your precondition.
Storage.BlobSourceOption precondition =
Storage.BlobSourceOption.generationMatch(blob.getGeneration());

storage.delete(bucketName, objectName, precondition);

System.out.println("Object " + objectName + " was deleted from " + bucketName);
BlobId idWithGeneration = blob.getBlobId();
Copy link
Contributor

@JesseLovelace JesseLovelace Jun 26, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

maybe add a comment on this line like "// The BlobId object has the Generation specified"

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

i think the variable name is clear on this, no?

// Deletes the blob specified by its id. When the generation is present and non-null it will be
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think "when the generation is present" is a little vague, maybe we should specify as "When the generation is present in the BlobId object"?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

rephrased the comments. let me know if that is clearer.

// specified in the request.
// If versioning is enabled on the bucket and the generation is present in the delete request,
// only the version of the object with the matching generation will be deleted.
// If instead you want to delete the current version, the generation should be dropped by
// performing the following.
// BlobId idWithoutGeneration =
// BlobId.of(idWithGeneration.getBucket(), idWithGeneration.getName());
sydney-munro marked this conversation as resolved.
Show resolved Hide resolved
// storage.delete(idWithoutGeneration);
storage.delete(idWithGeneration);

System.out.println("Object " + objectName + " was permanently deleted from " + bucketName);
}
}
// [END storage_delete_file]
Loading