Skip to content

feat: Add from and to storage url options for BlobId #888

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.

Sign up for GitHub

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
JesseLovelace merged 2 commits into from
Jun 24, 2021
Merged

feat: Add from and to storage url options for BlobId #888

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f34ee55
Add from and to storage url options for BlobId
JesseLovelace Jun 18, 2021
3a9d398
Better name
JesseLovelace Jun 24, 2021
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
23 changes: 23 additions & 0 deletions google-cloud-storage/src/main/java/com/google/cloud/storage/BlobId.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@
import com.google.common.base.MoreObjects;
import java.io.Serializable;
import java.util.Objects;
import java.util.regex.Pattern;

/**
* Google Storage Object identifier. A {@code BlobId} object includes the name of the containing
Expand Down Expand Up @@ -56,6 +57,11 @@ public Long getGeneration() {
return generation;
}

/** Returns this blob's Storage url which can be used with gsutil */
public String toGsUtilUri() {
return "gs://" + bucket + "/" + name;
}

@Override
public String toString() {
return MoreObjects.toStringHelper(this)
Expand Down Expand Up @@ -114,6 +120,23 @@ public static BlobId of(String bucket, String name, Long generation) {
return new BlobId(checkNotNull(bucket), checkNotNull(name), generation);
}

/**
* Creates a {@code BlobId} object.
*
* @param gsUtilUri the Storage url to create the blob from
*/
public static BlobId fromGsUtilUri(String gsUtilUri) {
if (!Pattern.matches("gs://.*/.*", gsUtilUri)) {
throw new IllegalArgumentException(
gsUtilUri + " is not a valid gsutil URI (i.e. \"gs://bucket/blob\")");
}
int blobNameStartIndex = gsUtilUri.indexOf('/', 5);
String bucketName = gsUtilUri.substring(5, blobNameStartIndex);
String blobName = gsUtilUri.substring(blobNameStartIndex + 1);

return BlobId.of(bucketName, blobName);
}

static BlobId fromPb(StorageObject storageObject) {
return BlobId.of(
storageObject.getBucket(), storageObject.getName(), storageObject.getGeneration());
Expand Down
8 changes: 8 additions & 0 deletions google-cloud-storage/src/test/java/com/google/cloud/storage/BlobIdTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,14 @@ public void testOf() {
assertEquals("n", blobId.getName());
}

@Test
public void testToFromGsUtilUri() {
BlobId blobId = BlobId.fromGsUtilUri("gs://bucket/path/to/blob");
assertEquals("bucket", blobId.getBucket());
assertEquals("path/to/blob", blobId.getName());
assertEquals("gs://bucket/path/to/blob", blobId.toGsUtilUri());
}

@Test
public void testEquals() {
compareBlobIds(BLOB, BlobId.of("b", "n"));
Expand Down