Getting Started

For this tutorial, you will need a [Google Developers Console](https://console.developers.google.com/) project with the Storage JSON API enabled. You will need to [enable billing](https://support.google.com/cloud/answer/6158867?hl=en) to use Google Cloud Storage. [Follow these instructions](https://cloud.google.com/docs/authentication#preparation) to get your project set up. You will also need to set up the local development environment by [installing the Google Cloud SDK](https://cloud.google.com/sdk/) and running the following commands in command line: `gcloud auth login` and `gcloud config set project [YOUR PROJECT ID]`.

You'll need to obtain the `gcloud-java-storage` library. See the [Quickstart](#quickstart) section to add `gcloud-java-storage` as a dependency in your code.

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:

import com.google.gcloud.storage.Storage;

import com.google.gcloud.storage.StorageOptions;

Storage storage = StorageOptions.defaultInstance().service();

For other authentication options, see the [Authentication](https://github.com/GoogleCloudPlatform/gcloud-java#authentication) page.

Stored objects are called "blobs" in `gcloud-java` and are organized into containers called "buckets". 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:

import com.google.gcloud.storage.BlobId;

import com.google.gcloud.storage.BlobInfo;

import com.google.gcloud.storage.BucketInfo;

Then add the following code to create a bucket and upload a simple blob.

*Important: Bucket names have to be globally unique. 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.*

String bucketName = "my_unique_bucket"; // Remember to change this to something unique

BucketInfo bucketInfo = storage.create(BucketInfo.builder(bucketName).build());

BlobId blobId = BlobId.of(bucketName, "my_blob_name");

BlobInfo blobInfo = storage.create(BlobInfo.builder(blobId).build(),

"a simple blob".getBytes(UTF_8));

At this point, you will be able to see your newly created bucket and blob on the Google Developers Console.

Now that we have content uploaded to the server, we can see how to read data from the server. Add the following import:

Then add the following lines to your program to get back the blob we uploaded.

Blob blob = Blob.load(storage, blobInfo.blobId());

String blobContent = new String(blob.content(), UTF_8);

If others have permission to edit the blob, then you may want to call `reload` to get a more up to date copy of the blob later in your program. The following snippet shows how to get a new Blob object containing updated information.

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 imports:

import com.google.gcloud.storage.Bucket;

import java.util.Iterator;

Then add the following code to list all your buckets and all the blobs inside your newly created bucket.

Iterator<BucketInfo> bucketInfoIterator = storage.list().iterateAll();

System.out.println("My buckets:");

while (bucketInfoIterator.hasNext()) {

System.out.println(bucketInfoIterator.next());

}

Bucket bucket = Bucket.load(storage, bucketName);

Iterator<Blob> blobIterator = bucket.list().iterateAll();

System.out.println("My blobs:");

while (blobIterator.hasNext()) {

System.out.println(blobIterator.next().info());

}

Here we put together all the code shown above into one program. This program assumes that you are running on Compute Engine or from your own desktop. To run this 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.

import static java.nio.charset.StandardCharsets.UTF_8;

import com.google.gcloud.storage.Storage;

import com.google.gcloud.storage.StorageOptions;

import com.google.gcloud.storage.Blob;

import com.google.gcloud.storage.BlobId;

import com.google.gcloud.storage.BlobInfo;

import com.google.gcloud.storage.Bucket;

import com.google.gcloud.storage.BucketInfo;

import java.util.Iterator;

public class GcloudStorageExample {

public static void main(String[] args) {

// Create a service object

// Credentials are inferred from the environment.

Storage storage = StorageOptions.defaultInstance().service();

// Create a bucket

String bucketName = "my_unique_bucket-1323252"; // Remember to change this to something unique

BucketInfo bucketInfo = storage.create(BucketInfo.builder(bucketName).build());

// Upload a blob to the newly created bucket

BlobId blobId = BlobId.of(bucketName, "my_blob_name");

BlobInfo blobInfo = storage.create(BlobInfo.builder(blobId).build(),

"a simple blob".getBytes(UTF_8));

// Retrieve a blob from the server

Blob blob = Blob.load(storage, blobInfo.blobId());

String blobContent = new String(blob.content(), UTF_8);

// An example of how to get an updated blob

// This is useful in cases where others with access to your blob may have changed it.

Blob refreshedBlob = blob.reload();

// List all your buckets

Iterator<BucketInfo> bucketInfoIterator = storage.list().iterateAll();

System.out.println("My buckets:");

while (bucketInfoIterator.hasNext()) {

System.out.println(bucketInfoIterator.next());

}

// List the blobs in a particular bucket

Bucket bucket = Bucket.load(storage, bucketName);

Iterator<Blob> blobIterator = bucket.list().iterateAll();

System.out.println("My blobs:");

while (blobIterator.hasNext()) {

System.out.println(blobIterator.next().info());

}

}