Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
chore: generate README from templates (#238)
* chore: generate README from templates * chore: adjust product name * chore: restore Example Applications section Co-authored-by: Frank Natividad <frankyn@users.noreply.github.com>
- Loading branch information
Showing
5 changed files
with
261 additions
and
113 deletions.
There are no files selected for viewing
This file contains 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 |
---|---|---|
@@ -0,0 +1,121 @@ | ||
custom_content: | | ||
#### Creating an authorized service object | ||
To make authenticated requests to Google Cloud Storage, you must create a service object with credentials. You can | ||
then make API calls by calling methods on the Storage service object. The simplest way to authenticate is to use | ||
[Application Default Credentials](https://developers.google.com/identity/protocols/application-default-credentials). | ||
These credentials are automatically inferred from your environment, so you only need the following code to create your | ||
service object: | ||
```java | ||
import com.google.cloud.storage.Storage; | ||
import com.google.cloud.storage.StorageOptions; | ||
Storage storage = StorageOptions.getDefaultInstance().getService(); | ||
``` | ||
For other authentication options, see the [Authentication](https://github.com/googleapis/google-cloud-java#authentication) page. | ||
#### Storing data | ||
Stored objects are called "blobs" in `google-cloud` and are organized into containers called "buckets". `Blob`, a | ||
subclass of `BlobInfo`, adds a layer of service-related functionality over `BlobInfo`. Similarly, `Bucket` adds a | ||
layer of service-related functionality over `BucketInfo`. In this code snippet, we will create a new bucket and | ||
upload a blob to that bucket. | ||
Add the following imports at the top of your file: | ||
```java | ||
import static java.nio.charset.StandardCharsets.UTF_8; | ||
import com.google.cloud.storage.Blob; | ||
import com.google.cloud.storage.Bucket; | ||
import com.google.cloud.storage.BucketInfo; | ||
``` | ||
Then add the following code to create a bucket and upload a simple blob. | ||
*Important: Bucket names have to be globally unique (among all users of Cloud Storage). If you choose a bucket name | ||
that already exists, you'll get a helpful error message telling you to choose another name. In the code below, replace | ||
"my_unique_bucket" with a unique bucket name. See more about naming rules | ||
[here](https://cloud.google.com/storage/docs/bucket-naming?hl=en#requirements).* | ||
```java | ||
// Create a bucket | ||
String bucketName = "my_unique_bucket"; // Change this to something unique | ||
Bucket bucket = storage.create(BucketInfo.of(bucketName)); | ||
// Upload a blob to the newly created bucket | ||
BlobId blobId = BlobId.of(bucketName, "my_blob_name"); | ||
BlobInfo blobInfo = BlobInfo.newBuilder(blobId).setContentType("text/plain").build(); | ||
Blob blob = storage.create(blobInfo, "a simple blob".getBytes(UTF_8)); | ||
``` | ||
A complete example for creating a blob can be found at | ||
[CreateBlob.java](https://github.com/googleapis/google-cloud-java/tree/master/google-cloud-examples/src/main/java/com/google/cloud/examples/storage/snippets/CreateBlob.java). | ||
At this point, you will be able to see your newly created bucket and blob on the Google Developers Console. | ||
#### Retrieving data | ||
Now that we have content uploaded to the server, we can see how to read data from the server. Add the following line | ||
to your program to get back the blob we uploaded. | ||
```java | ||
BlobId blobId = BlobId.of(bucketName, "my_blob_name"); | ||
byte[] content = storage.readAllBytes(blobId); | ||
String contentString = new String(content, UTF_8); | ||
``` | ||
A complete example for accessing blobs can be found at | ||
[CreateBlob.java](https://github.com/googleapis/google-cloud-java/tree/master/google-cloud-examples/src/main/java/com/google/cloud/examples/storage/snippets/CreateBlob.java). | ||
#### Updating data | ||
Another thing we may want to do is update a blob. The following snippet shows how to update a Storage blob if it exists. | ||
``` java | ||
BlobId blobId = BlobId.of(bucketName, "my_blob_name"); | ||
Blob blob = storage.get(blobId); | ||
if (blob != null) { | ||
byte[] prevContent = blob.getContent(); | ||
System.out.println(new String(prevContent, UTF_8)); | ||
WritableByteChannel channel = blob.writer(); | ||
channel.write(ByteBuffer.wrap("Updated content".getBytes(UTF_8))); | ||
channel.close(); | ||
} | ||
``` | ||
The complete source code can be found at | ||
[UpdateBlob.java](https://github.com/googleapis/google-cloud-java/tree/master/google-cloud-examples/src/main/java/com/google/cloud/examples/storage/snippets/UpdateBlob.java). | ||
#### Listing buckets and contents of buckets | ||
Suppose that you've added more buckets and blobs, and now you want to see the names of your buckets and the contents | ||
of each one. Add the following code to list all your buckets and all the blobs inside each bucket. | ||
```java | ||
// List all your buckets | ||
System.out.println("My buckets:"); | ||
for (Bucket bucket : storage.list().iterateAll()) { | ||
System.out.println(bucket); | ||
// List all blobs in the bucket | ||
System.out.println("Blobs in the bucket:"); | ||
for (Blob blob : bucket.list().iterateAll()) { | ||
System.out.println(blob); | ||
} | ||
} | ||
``` | ||
#### Complete source code | ||
In | ||
[CreateAndListBucketsAndBlobs.java](https://github.com/googleapis/google-cloud-java/tree/master/google-cloud-examples/src/main/java/com/google/cloud/examples/storage/snippets/CreateAndListBucketsAndBlobs.java) | ||
we put together examples creating and listing buckets and blobs into one program. The program assumes that you are | ||
running on Compute Engine or from your own desktop. To run the example on App Engine, simply move | ||
the code from the main method to your application's servlet class and change the print statements to | ||
display on your webpage. | ||
### Example Applications | ||
- [`StorageExample`](https://github.com/googleapis/google-cloud-java/tree/master/google-cloud-examples/src/main/java/com/google/cloud/examples/storage/StorageExample.java) is a simple command line interface that provides some of Cloud Storage's functionality. Read more about using the application on the [`StorageExample` docs page](https://github.com/googleapis/google-cloud-java/blob/master/google-cloud-examples/README.md). | ||
- [`Bookshelf`](https://github.com/GoogleCloudPlatform/getting-started-java/tree/master/bookshelf) - An App Engine application that manages a virtual bookshelf. | ||
- This app uses `google-cloud` to interface with Cloud Datastore and Cloud Storage. It also uses Cloud SQL, another Google Cloud Platform service. | ||
- [`Flexible Environment/Storage example`](https://github.com/GoogleCloudPlatform/java-docs-samples/tree/master/flexible/cloudstorage) - An app that uploads files to a public Cloud Storage bucket on the App Engine Flexible Environment runtime. |
This file contains 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 |
---|---|---|
@@ -1,13 +1,15 @@ | ||
{ | ||
"name": "storage", | ||
"name_pretty": "Google Cloud Storage", | ||
"name_pretty": "Cloud Storage", | ||
"product_documentation": "https://cloud.google.com/storage", | ||
"client_documentation": "https://googleapis.dev/java/java-storage/latest/", | ||
"api_description": "is a durable and highly available object storage service. Google Cloud Storage is almost infinitely scalable and guarantees consistency: when a write succeeds, the latest copy of the object will be returned to any GET, globally.", | ||
"issue_tracker": "https://issuetracker.google.com/savedsearches/559782", | ||
"release_level": "ga", | ||
"language": "java", | ||
"repo": "googleapis/java-storage", | ||
"repo_short": "java-storage", | ||
"distribution_name": "com.google.cloud:google-cloud-storage", | ||
"api_id": "storage.googleapis.com" | ||
"api_id": "storage.googleapis.com", | ||
"requires_billing": true | ||
} |
Oops, something went wrong.