README.md: update for v0.25.0

Change-Id: I6056ebf1959191ff7890a5af56c237af6f383921
Reviewed-on: https://code-review.googlesource.com/30270
Reviewed-by: Jean de Klerk <deklerk@google.com>
1 file changed
tree: 86fe9b3175e6610201bd4cce48bfcad9ffc6d490
  1. bigquery/
  2. bigtable/
  3. civil/
  4. cloudtasks/
  5. cmd/
  6. compute/
  7. container/
  8. dataproc/
  9. datastore/
  10. debugger/
  11. dialogflow/
  12. dlp/
  13. errorreporting/
  14. firestore/
  15. httpreplay/
  16. iam/
  17. internal/
  18. kms/
  19. language/
  20. logging/
  21. longrunning/
  22. monitoring/
  23. oslogin/
  24. profiler/
  25. pubsub/
  26. redis/
  27. rpcreplay/
  28. spanner/
  29. speech/
  30. storage/
  31. texttospeech/
  32. trace/
  33. translate/
  34. videointelligence/
  35. vision/
  36. .travis.yml
  37. authexample_test.go
  38. AUTHORS
  39. cloud.go
  40. CODE_OF_CONDUCT.md
  41. CONTRIBUTING.md
  42. CONTRIBUTORS
  43. examples_test.go
  44. import_test.go
  45. issue_template.md
  46. keys.tar.enc
  47. LICENSE
  48. license_test.go
  49. MIGRATION.md
  50. old-news.md
  51. README.md
  52. regen-gapic.sh
  53. RELEASING.md
  54. run-tests.sh
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

July 11, 2018

v0.25.0

  • Added Code of Conduct
  • bigtable:
    • cbt: Support a GC policy of “never”.
  • errorreporting:
    • Support User.
    • Close now calls Flush.
    • Use OnError (previously ignored).
    • Pass through the RPC error as-is to OnError.
  • httpreplay: A tool for recording and replaying HTTP requests (for the bigquery and storage clients in this repo).
  • kms: v1 client added
  • logging: add SourceLocation to Entry.
  • storage: improve CRC checking on read.

June 18, 2018

v0.24.0

  • bigquery: Support for the NUMERIC type.
  • bigtable:
    • cbt: Optionally specify columns for read/lookup
    • Support instance-level administration.
  • oslogin: New client for the OS Login API.
  • pubsub:
    • The package is now stable. There will be no further breaking changes.
    • Internal changes to improve Subscription.Receive behavior.
  • storage: Support updating bucket lifecycle config.
  • spanner: Support struct-typed parameter bindings.
  • texttospeech: New client for the Text-to-Speech API.

May 18, 2018

v0.23.0

  • bigquery: Add DDL stats to query statistics.
  • bigtable:
    • cbt: Add cells-per-column limit for row lookup.
    • cbt: Make it possible to combine read filters.
  • dlp: v2beta2 client removed. Use the v2 client instead.
  • firestore, spanner: Fix compilation errors due to protobuf changes.

May 8, 2018

v0.22.0

  • bigtable:

    • cbt: Support cells per column limit for row read.
    • bttest: Correctly handle empty RowSet.
    • Fix ReadModifyWrite operation in emulator.
    • Fix API path in GetCluster.
  • bigquery:

    • BEHAVIOR CHANGE: Retry on 503 status code.
    • Add dataset.DeleteWithContents.
    • Add SchemaUpdateOptions for query jobs.
    • Add Timeline to QueryStatistics.
    • Add more stats to ExplainQueryStage.
    • Support Parquet data format.
  • datastore:

    • Support omitempty for times.
  • dlp:

    • BREAKING CHANGE: Remove v1beta1 client. Please migrate to the v2 client, which is now out of beta.
    • Add v2 client.
  • firestore:

    • BEHAVIOR CHANGE: Treat set({}, MergeAll) as valid.
  • iam:

    • Support JWT signing via SignJwt callopt.
  • profiler:

    • BEHAVIOR CHANGE: PollForSerialOutput returns an error when context.Done.
    • BEHAVIOR CHANGE: Increase the initial backoff to 1 minute.
    • Avoid returning empty serial port output.
  • pubsub:

    • BEHAVIOR CHANGE: Don't backoff during next retryable error once stream is healthy.
    • BEHAVIOR CHANGE: Don't backoff on EOF.
    • pstest: Support Acknowledge and ModifyAckDeadline RPCs.
  • redis:

    • Add v1 beta Redis client.
  • spanner:

    • Support SessionLabels.
  • speech:

    • Add api v1 beta1 client.
  • storage:

    • BEHAVIOR CHANGE: Retry reads when retryable error occurs.
    • Fix delete of object in requester-pays bucket.
    • Support KMS integration.

April 9, 2018

v0.21.0

  • bigquery:

    • Add OpenCensus tracing.
  • firestore:

    • BREAKING CHANGE: If a document does not exist, return a DocumentSnapshot whose Exists method returns false. DocumentRef.Get and Transaction.Get return the non-nil DocumentSnapshot in addition to a NotFound error. DocumentRef.GetAll and Transaction.GetAll return a non-nil DocumentSnapshot instead of nil.
    • Add DocumentIterator.Stop. Call Stop whenever you are done with a DocumentIterator.
    • Added Query.Snapshots and DocumentRef.Snapshots, which provide realtime notification of updates. See https://cloud.google.com/firestore/docs/query-data/listen.
    • Canceling an RPC now always returns a grpc.Status with codes.Canceled.
  • spanner:

    • Add CommitTimestamp, which supports inserting the commit timestamp of a transaction into a column.

March 22, 2018

v0.20.0

  • bigquery: Support SchemaUpdateOptions for load jobs.

  • bigtable:

    • Add SampleRowKeys.
    • cbt: Support union, intersection GCPolicy.
    • Retry admin RPCS.
    • Add trace spans to retries.
  • datastore: Add OpenCensus tracing.

  • firestore:

    • Fix queries involving Null and NaN.
    • Allow Timestamp protobuffers for time values.
  • logging: Add a WriteTimeout option.

  • spanner: Support Batch API.

  • storage: Add OpenCensus tracing.

Older news

Supported APIs

Google APIStatusPackage
BigQuerystablecloud.google.com/go/bigquery
Bigtablestablecloud.google.com/go/bigtable
Containeralphacloud.google.com/go/container/apiv1
Data Loss Preventionalphacloud.google.com/go/dlp/apiv2beta1
Datastorestablecloud.google.com/go/datastore
Debuggeralphacloud.google.com/go/debugger/apiv2
ErrorReportingalphacloud.google.com/go/errorreporting
Firestorebetacloud.google.com/go/firestore
Languagestablecloud.google.com/go/language/apiv1
Loggingstablecloud.google.com/go/logging
Monitoringbetacloud.google.com/go/monitoring/apiv3
OS Loginalphacloud.google.com/compute/docs/oslogin/rest
Pub/Substablecloud.google.com/go/pubsub
Spannerstablecloud.google.com/go/spanner
Speechstablecloud.google.com/go/speech/apiv1
Storagestablecloud.google.com/go/storage
Translationstablecloud.google.com/go/translate
Video Intelligencebetacloud.google.com/go/videointelligence/apiv1beta1
Visionstablecloud.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. 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.

client, err := storage.NewClient(ctx)

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: 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)
}

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