Google Git
Sign in
code / gocloud / refs/tags/v0.2.0
tag62eaf27e82fcf1ca9f0a3ef8efa0a146bcf6e539
taggerJonathan Amsterdam <jba@google.com>Mon Oct 03 16:01:06 2016 -0400
objectfe3d41e1ecb2ce36ad3a979037c9b9a2b726226f 
prior to storage client breakage
commitfe3d41e1ecb2ce36ad3a979037c9b9a2b726226f[log] [tgz]
authorJonathan Amsterdam <jba@google.com>Sat Sep 17 12:32:13 2016 -0400
committerJonathan Amsterdam <jba@google.com>Mon Oct 03 10:57:02 2016 +0000
tree86a7d27e316bec5f0ce27f1d4c5b1a8cdd9f60f2
parent90296fd601ebfc594192e722a022663b0c3f8756 [diff]
storage: add CopierFrom and ComposerFrom

Copying is handled via a Copier object, which provides for setting
destination attributes and accessing the rewrite token.

The API's copy and rewrite operations are collapsed into
Copier.Run. It always calls rewrite. We lose no functionality or
performance in doing so, because the storage service's copy calls
rewrite.

Multiple calls to rewrite are handled automatically. The user can
provide a callback to get progress on the number of bytes transferred,
and to stop the copy.

For consistency, there is also an ObjectHandle.ComposeFrom method and a
Composer type.

ObjectHandle.CopyTo and ObjectHandle.ComposeFrom are deprecated.

This is not a breaking change.

Change-Id: I2f3fa666af47867da0478efd2d8d872674586074
Reviewed-on: https://code-review.googlesource.com/7697
Reviewed-by: Dave Day <djd@golang.org>
5 files changed
tree: 86a7d27e316bec5f0ce27f1d4c5b1a8cdd9f60f2
  1. bigquery/
  2. bigtable/
  3. cmd/
  4. compute/
  5. container/
  6. datastore/
  7. errorreporting/
  8. errors/
  9. examples/
  10. internal/
  11. language/
  12. logging/
  13. monitoring/
  14. preview/
  15. pubsub/
  16. speech/
  17. storage/
  18. trace/
  19. vision/
  20. .travis.yml
  21. appveyor.yml
  22. authexample_test.go
  23. AUTHORS
  24. cloud.go
  25. CONTRIBUTING.md
  26. CONTRIBUTORS
  27. key.json.enc
  28. LICENSE
  29. license_test.go
  30. README.md
README.md

Google Cloud for Go

Build Status GoDoc

import "cloud.google.com/go"

Go packages for Google Cloud Platform services.

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

September 8, 2016

  • New clients for some of Google's Machine Learning APIs: Vision, Speech, and Natural Language.

  • Preview version of a new Stackdriver Logging client in cloud.google.com/go/preview/logging. This client uses gRPC as its transport layer, and supports log reading, sinks and metrics. It will replace the current client at cloud.google.com/go/logging shortly.

Supported APIs

Google APIStatusPackage
Datastorebetacloud.google.com/go/datastore
Storagebetacloud.google.com/go/storage
Pub/Subexperimentalcloud.google.com/go/pubsub
Bigtablebetacloud.google.com/go/bigtable
BigQueryexperimentalcloud.google.com/go/bigquery
Loggingexperimentalcloud.google.com/go/logging
Visionexperimentalcloud.google.com/go/vision
Languageexperimentalcloud.google.com/go/language/apiv1beta1
Speechexperimentalcloud.google.com/go/speech/apiv1beta

Experimental 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. You can see which versions are currently supported by looking at the lines following go: in .travis.yml.

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.

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

client, err := storage.NewClient(ctx, option.WithServiceAccountFile("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.NewKey(ctx, "Post", "post1", 0, nil),
	datastore.NewKey(ctx, "Post", "post2", 0, 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)
}

// Publish "hello world" on topic1.
topic := client.Topic("topic1")
msgIDs, err := topic.Publish(ctx, &pubsub.Message{
	Data: []byte("hello world"),
})
if err != nil {
	log.Fatal(err)
}

// Create an iterator to pull messages via subscription1.
it, err := client.Subscription("subscription1").Pull(ctx)
if err != nil {
	log.Println(err)
}
defer it.Stop()

// Consume N messages from the iterator.
for i := 0; i < N; i++ {
	msg, err := it.Next()
	if err == pubsub.Done {
		break
	}
	if err != nil {
		log.Fatalf("Failed to retrieve message: %v", err)
	}

	fmt.Printf("Message %d: %s\n", i, msg.Data)
	msg.Done(true) // Acknowledge that we've consumed the message.
}

Cloud 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 it.Next(ctx) {
    // Retrieve the current row into a list of values.
    var values bigquery.ValueList
    if err := it.Get(&values); err != nil {
        // TODO: Handle error.
    }
    fmt.Println(values)
}
if it.Err() != nil {
    // TODO: Handle it.Err()
}

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.
}

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.