The Central Go Modules Repository

To use GoCenter:
export GOPROXY=https://gocenter.io
2,133
Stars
Apache-2.0
License
34,467
Downloads
May 24th 2020
Last Modified
Version:
Loading...

Google Cloud Client Libraries for Go

GoDoc

Go packages for Google Cloud Platform services.

import "cloud.google.com/go"

To install the packages on your system, do not clone the repo. Instead use

$ go get -u cloud.google.com/go/...

NOTE: Some of these packages are under development, and may occasionally make backwards-incompatible changes.

NOTE: Github repo is a mirror of https://code.googlesource.com/gocloud.

  • News
  • Supported APIs
  • Go Versions Supported
  • Authorization
  • Cloud Datastore
  • Cloud Storage
  • Cloud Pub/Sub
  • BigQuery
  • Stackdriver Logging
  • Cloud Spanner

News

7 August 2018

As of November 1, the code in the repo will no longer support Go versions 1.8 and earlier. No one other than AppEngine users should be on those old versions, and AppEngine Standard and Flex will stop supporting new deployments with those versions on that date.

Changes have been moved to CHANGES.

Supported APIs

Google API Status Package
Asset alpha godoc.org/cloud.google.com/go/asset/v1beta
BigQuery stable godoc.org/cloud.google.com/go/bigquery
Bigtable stable godoc.org/cloud.google.com/go/bigtable
Cloudtasks beta godoc.org/cloud.google.com/go/cloudtasks/apiv2beta3
Container stable godoc.org/cloud.google.com/go/container/apiv1
ContainerAnalysis beta godoc.org/cloud.google.com/go/containeranalysis/apiv1beta1
Dataproc stable godoc.org/cloud.google.com/go/dataproc/apiv1
Datastore stable godoc.org/cloud.google.com/go/datastore
Debugger alpha godoc.org/cloud.google.com/go/debugger/apiv2
Dialogflow alpha godoc.org/cloud.google.com/go/dialogflow/apiv2
Data Loss Prevention alpha godoc.org/cloud.google.com/go/dlp/apiv2
ErrorReporting alpha godoc.org/cloud.google.com/go/errorreporting
Firestore beta godoc.org/cloud.google.com/go/firestore
IAM stable godoc.org/cloud.google.com/go/iam
KMS stable godoc.org/cloud.google.com/go/kms
Natural Language stable godoc.org/cloud.google.com/go/language/apiv1
Logging stable godoc.org/cloud.google.com/go/logging
Monitoring alpha godoc.org/cloud.google.com/go/monitoring/apiv3
OS Login alpha cloud.google.com/compute/docs/oslogin/rest
Pub/Sub stable godoc.org/cloud.google.com/go/pubsub
Memorystore stable godoc.org/cloud.google.com/go/redis/apiv1beta1
Spanner stable godoc.org/cloud.google.com/go/spanner
Speech stable godoc.org/cloud.google.com/go/speech/apiv1
Storage stable godoc.org/cloud.google.com/go/storage
Text To Speech alpha godoc.org/cloud.google.com/go/texttospeech/apiv1
Trace alpha godoc.org/cloud.google.com/go/trace/apiv2
Translation stable godoc.org/cloud.google.com/go/translate
Video Intelligence alpha godoc.org/cloud.google.com/go/videointelligence/apiv1beta1
Vision stable godoc.org/cloud.google.com/go/vision/apiv1

Alpha status: the API is still being actively developed. As a result, it might change in backward-incompatible ways and is not recommended for production use.

Beta status: the API is largely complete, but still has outstanding features and bugs to be addressed. There may be minor backwards-incompatible changes where necessary.

Stable status: the API is mature and ready for production use. We will continue addressing bugs and feature requests.

Documentation and examples are available at https://godoc.org/cloud.google.com/go

Visit or join the google-api-go-announce group for updates on these packages.

Go Versions Supported

We support the two most recent major versions of Go. If Google App Engine uses an older version, we support that as well.

Authorization

By default, each API will use Google Application Default Credentials for authorization credentials used in calling the API endpoints. This will allow your application to run in many environments without requiring explicit configuration.

client, err := storage.NewClient(ctx)

To authorize using a JSON key file, pass option.WithCredentialsFile to the NewClient function of the desired package. For example:

client, err := storage.NewClient(ctx, option.WithCredentialsFile("path/to/keyfile.json"))

You can exert more control over authorization by using the golang.org/x/oauth2 package to create an oauth2.TokenSource. Then pass option.WithTokenSource to the NewClient function:

tokenSource := ...
client, err := storage.NewClient(ctx, option.WithTokenSource(tokenSource))

Cloud Datastore GoDoc

Example Usage

First create a datastore.Client to use throughout your application:

client, err := datastore.NewClient(ctx, "my-project-id")
if err != nil {
	log.Fatal(err)
}

Then use that client to interact with the API:

type Post struct {
	Title       string
	Body        string `datastore:",noindex"`
	PublishedAt time.Time
}
keys := []*datastore.Key{
	datastore.NameKey("Post", "post1", nil),
	datastore.NameKey("Post", "post2", nil),
}
posts := []*Post{
	{Title: "Post 1", Body: "...", PublishedAt: time.Now()},
	{Title: "Post 2", Body: "...", PublishedAt: time.Now()},
}
if _, err := client.PutMulti(ctx, keys, posts); err != nil {
	log.Fatal(err)
}

Cloud Storage GoDoc

Example Usage

First create a storage.Client to use throughout your application:

client, err := storage.NewClient(ctx)
if err != nil {
	log.Fatal(err)
}
// Read the object1 from bucket.
rc, err := client.Bucket("bucket").Object("object1").NewReader(ctx)
if err != nil {
	log.Fatal(err)
}
defer rc.Close()
body, err := ioutil.ReadAll(rc)
if err != nil {
	log.Fatal(err)
}

Cloud Pub/Sub GoDoc

Example Usage

First create a pubsub.Client to use throughout your application:

client, err := pubsub.NewClient(ctx, "project-id")
if err != nil {
	log.Fatal(err)
}

Then use the client to publish and subscribe:

// Publish "hello world" on topic1.
topic := client.Topic("topic1")
res := topic.Publish(ctx, &pubsub.Message{
	Data: []byte("hello world"),
})
// The publish happens asynchronously.
// Later, you can get the result from res:
...
msgID, err := res.Get(ctx)
if err != nil {
	log.Fatal(err)
}

// Use a callback to receive messages via subscription1.
sub := client.Subscription("subscription1")
err = sub.Receive(ctx, func(ctx context.Context, m *pubsub.Message) {
	fmt.Println(m.Data)
	m.Ack() // Acknowledge that we've consumed the message.
})
if err != nil {
	log.Println(err)
}

BigQuery GoDoc

Example Usage

First create a bigquery.Client to use throughout your application:

c, err := bigquery.NewClient(ctx, "my-project-ID")
if err != nil {
	// TODO: Handle error.
}

Then use that client to interact with the API:

// Construct a query.
q := c.Query(`
    SELECT year, SUM(number)
    FROM [bigquery-public-data:usa_names.usa_1910_2013]
    WHERE name = "William"
    GROUP BY year
    ORDER BY year
`)
// Execute the query.
it, err := q.Read(ctx)
if err != nil {
	// TODO: Handle error.
}
// Iterate through the results.
for {
	var values []bigquery.Value
	err := it.Next(&values)
	if err == iterator.Done {
		break
	}
	if err != nil {
		// TODO: Handle error.
	}
	fmt.Println(values)
}

Stackdriver Logging GoDoc

Example Usage

First create a logging.Client to use throughout your application:

ctx := context.Background()
client, err := logging.NewClient(ctx, "my-project")
if err != nil {
	// TODO: Handle error.
}

Usually, you’ll want to add log entries to a buffer to be periodically flushed (automatically and asynchronously) to the Stackdriver Logging service.

logger := client.Logger("my-log")
logger.Log(logging.Entry{Payload: "something happened!"})

Close your client before your program exits, to flush any buffered log entries.

err = client.Close()
if err != nil {
	// TODO: Handle error.
}

Cloud Spanner GoDoc

Example Usage

First create a spanner.Client to use throughout your application:

client, err := spanner.NewClient(ctx, "projects/P/instances/I/databases/D")
if err != nil {
	log.Fatal(err)
}
// Simple Reads And Writes
_, err = client.Apply(ctx, []*spanner.Mutation{
	spanner.Insert("Users",
		[]string{"name", "email"},
		[]interface{}{"alice", "a@example.com"})})
if err != nil {
	log.Fatal(err)
}
row, err := client.Single().ReadRow(ctx, "Users",
	spanner.Key{"alice"}, []string{"email"})
if err != nil {
	log.Fatal(err)
}

Contributing

Contributions are welcome. Please, see the CONTRIBUTING document for details. We’re using Gerrit for our code reviews. Please don’t open pull requests against this repo, new pull requests will be automatically closed.

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms. See Contributor Code of Conduct for more information.