Google Cloud Client Libraries for Go.
Clone or download
nolanmar511 and aalexand profiler: add function for checking if filename is in profile
Change-Id: I6eedaf12255fe1b7bcfa7859521aa960781fe5ab
Reviewed-on: https://code-review.googlesource.com/c/35752
Reviewed-by: kokoro <noreply+kokoro@google.com>
Reviewed-by: Alexey Alexandrov <aalexand@google.com>
Latest commit f04f804 Nov 21, 2018
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
asset internal: run vet Dec 4, 2018
bigquery internal: update name to googleapis/google-cloud-go Dec 6, 2018
bigtable bttest: Skip deleted rows in ReadRows Dec 6, 2018
civil all: modify copyright notice Jun 14, 2018
cloudtasks internal: run vet Dec 4, 2018
cmd/go-cloud-debug-agent internal: inline context Nov 9, 2018
compute/metadata internal: update name to googleapis/google-cloud-go Dec 6, 2018
container internal: run vet Dec 4, 2018
containeranalysis/apiv1beta1 internal: run vet Dec 4, 2018
dataproc internal: run vet Dec 4, 2018
datastore datastore: Add example for handling MultiError Nov 27, 2018
debugger/apiv2 internal: run vet Dec 4, 2018
dialogflow/apiv2 internal: run vet Dec 4, 2018
dlp/apiv2 internal: run vet Dec 4, 2018
errorreporting internal: run vet Dec 4, 2018
expr/apiv1alpha1 internal: run vet Dec 4, 2018
firestore firestore: allow StartAt/EndBefore on direct children at any depth Dec 6, 2018
functions/metadata functions: don't use a wrapper and make Resource a value Dec 4, 2018
httpreplay internal: update name to googleapis/google-cloud-go Dec 6, 2018
iam internal: run vet Dec 4, 2018
internal pubsub: Receive does not retry ResourceExhausted errors Dec 6, 2018
kms/apiv1 internal: run vet Dec 4, 2018
language internal: run vet Dec 4, 2018
logging logging: add err checking to docs Dec 10, 2018
longrunning internal: run vet Dec 4, 2018
monitoring/apiv3 internal: run vet Dec 4, 2018
oslogin internal: run vet Dec 4, 2018
profiler profiler: add function for checking if filename is in profile Dec 12, 2018
pubsub pubsub: Receive does not retry ResourceExhausted errors Dec 6, 2018
redis internal: run vet Dec 4, 2018
rpcreplay internal: inline context Nov 9, 2018
scheduler/apiv1beta1 internal: run vet Dec 4, 2018
securitycenter/apiv1beta1 internal: run vet Dec 4, 2018
spanner spanner: small docs fixes for ReadWriteTransaction Dec 5, 2018
speech internal: run vet Dec 4, 2018
storage internal: refactor TestCondition to care about errors Dec 6, 2018
texttospeech/apiv1 internal: run vet Dec 4, 2018
trace internal: run vet Dec 4, 2018
translate internal: inline context Nov 9, 2018
videointelligence internal: run vet Dec 4, 2018
vision internal: run vet Dec 4, 2018
AUTHORS storage: make NewReader return a googleapi.Error Jun 6, 2016
CHANGES.md internal: update name to googleapis/google-cloud-go Dec 6, 2018
CODE_OF_CONDUCT.md docs: add code of conduct Jul 2, 2018
CONTRIBUTING.md spanner: fix failing tests Oct 31, 2018
CONTRIBUTORS Add James Hall to contributors Mar 29, 2018
LICENSE LICENSE: use verbatim text Jan 9, 2018
README.md internal: tidy up godoc.org in README.md Dec 6, 2018
RELEASING.md internal: update name to googleapis/google-cloud-go Dec 6, 2018
authexample_test.go all: remove xnetcontext Nov 7, 2018
cloud.go internal: update name to googleapis/google-cloud-go Dec 6, 2018
examples_test.go internal: inline context Nov 9, 2018
issue_template.md internal: add issue template Mar 12, 2018
keys.tar.enc .travis.yml: add firestore project to tests Oct 6, 2017
license_test.go all: modify copyright notice Jun 14, 2018
old-news.md internal: update name to googleapis/google-cloud-go Dec 6, 2018
regen-gapic.sh bigquery: generate apiv1beta1 client Dec 5, 2018
run-tests.sh run-tests.sh: fix comment May 9, 2018

README.md

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

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 cloud.google.com/go/asset/v1beta
BigQuery stable cloud.google.com/go/bigquery
Bigtable stable cloud.google.com/go/bigtable
Cloudtasks beta cloud.google.com/go/cloudtasks/apiv2beta3
Container stable cloud.google.com/go/container/apiv1
ContainerAnalysis beta cloud.google.com/go/containeranalysis/apiv1beta1
Dataproc stable cloud.google.com/go/dataproc/apiv1
Datastore stable cloud.google.com/go/datastore
Debugger alpha cloud.google.com/go/debugger/apiv2
Dialogflow alpha cloud.google.com/go/dialogflow/apiv2
Data Loss Prevention alpha cloud.google.com/go/dlp/apiv2
ErrorReporting alpha cloud.google.com/go/errorreporting
Firestore beta cloud.google.com/go/firestore
IAM stable cloud.google.com/go/iam
KMS stable cloud.google.com/go/kms
Natural Language stable cloud.google.com/go/language/apiv1
Logging stable cloud.google.com/go/logging
Monitoring alpha cloud.google.com/go/monitoring/apiv3
OS Login alpha cloud.google.com/compute/docs/oslogin/rest
Pub/Sub stable cloud.google.com/go/pubsub
Memorystore stable cloud.google.com/go/redis/apiv1beta1
Spanner stable cloud.google.com/go/spanner
Speech stable cloud.google.com/go/speech/apiv1
Storage stable cloud.google.com/go/storage
Text To Speech alpha cloud.google.com/go/texttospeech/apiv1
Trace alpha cloud.google.com/go/trace/apiv2
Translation stable cloud.google.com/go/translate
Video Intelligence alpha cloud.google.com/go/videointelligence/apiv1beta1
Vision stable 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: snip:# (auth-ts)

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: snip:# (bq-1)

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

Then use that client to interact with the API: snip:# (bq-2)

// 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: snip:# (logging-1)

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. snip:# (logging-2)

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. snip:# (logging-3)

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.