google-cloud-storage overview (2.32.1)

com.google.cloud.storage

A client for Cloud Storage - Unified object storage.

Here's a simple usage example the Java Storage client. This example shows how to create a Storage object.

Storagestorage=StorageOptions.getDefaultInstance().getService();BlobIdblobId=BlobId.of("bucket","blob_name");BlobInfoblobInfo=BlobInfo.newBuilder(blobId).setContentType("text/plain").build();Blobblob=storage.create(blobInfo,"Hello, Cloud Storage!".getBytes(UTF_8));

This second example shows how to update an object's content if the object exists.

Storagestorage=StorageOptions.getDefaultInstance().getService();BlobIdblobId=BlobId.of("bucket","blob_name");Blobblob=storage.get(blobId);if(blob!=null){byte[]prevContent=blob.getContent();System.out.println(newString(prevContent,UTF_8));WritableByteChannelchannel=blob.writer();channel.write(ByteBuffer.wrap("Updated content".getBytes(UTF_8)));channel.close();}

For more detailed code examples, see thesample library.

When using google-cloud from outside of App/Compute Engine, you have tospecify a project ID andprovide credentials.

Operations in this library are generally thread safe, except for the use of BlobReadChannel and BlobWriteChannel.See Also:Google Cloud Storage

com.google.cloud.storage.spi

com.google.cloud.storage.spi.v1

com.google.cloud.storage.testing

A testing helper for Google Cloud Storage.

A simple usage example:

Before the test:

RemoteStorageHelperhelper=RemoteStorageHelper.create();Storagestorage=helper.getOptions().getService();Stringbucket=RemoteStorageHelper.generateBucketName();storage.create(BucketInfo.of(bucket));

After the test:

RemoteStorageHelper.forceDelete(storage,bucket,5,TimeUnit.SECONDS);

See Also:Google Cloud Storage testing

com.google.cloud.storage.transfermanager

com.google.storage.control.v2

A client to Cloud Storage API

The interfaces provided are listed below, along with usage samples.

StorageControlClient

Service Description: StorageControl service includes selected control plane operations.

Sample for StorageControlClient:

// This snippet has been automatically generated and should be regarded as a code template only.// It will require modifications to work:// - It may require correct/in-range values for request initialization.// - It may require specifying regional endpoints when creating the service client as shown in// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_librarytry(StorageControlClientstorageControlClient=StorageControlClient.create()){BucketNameparent=BucketName.of("[PROJECT]","[BUCKET]");Folderfolder=Folder.newBuilder().build();StringfolderId="folderId294109737";Folderresponse=storageControlClient.createFolder(parent,folder,folderId);}

com.google.storage.control.v2.stub

com.google.storage.v2

A client to Cloud Storage API

The interfaces provided are listed below, along with usage samples.

StorageClient

Service Description: ## API Overview and Naming Syntax

The Cloud Storage gRPC API allows applications to read and write data through the abstractions of buckets and objects. For a description of these abstractions please seehttps://cloud.google.com/storage/docs.

Resources are named as follows: - Projects are referred to as they are defined by the Resource Manager API, using strings likeprojects/123456 orprojects/my-string-id. - Buckets are named using string names of the form:projects/{project}/buckets/{bucket} For globally unique buckets,_ may be substituted for the project. - Objects are uniquely identified by their name along with the name of the bucket they belong to, as separate strings in this API. For example:

ReadObjectRequest { bucket: 'projects/_/buckets/my-bucket' object: 'my-object' } Note that object names can contain/ characters, which are treated as any other character (no special directory semantics).

Sample for StorageClient:

// This snippet has been automatically generated and should be regarded as a code template only.// It will require modifications to work:// - It may require correct/in-range values for request initialization.// - It may require specifying regional endpoints when creating the service client as shown in// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_librarytry(StorageClientstorageClient=StorageClient.create()){BucketNamename=BucketName.of("[PROJECT]","[BUCKET]");storageClient.deleteBucket(name);}

com.google.storage.v2.stub

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2026-02-01 UTC.