README

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:

  1. Change to your project directory:

    cd /my/cloud/project
    
  2. Get the package you want to use. Some products have their own module, so it's best to go get the package(s) you want to use:

    $ go get cloud.google.com/go/firestore # Replace with the package you want to use.
    

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.

Supported APIs

Google API Status Package
Asset stable cloud.google.com/go/asset/apiv1
Automl stable cloud.google.com/go/automl/apiv1
BigQuery stable cloud.google.com/go/bigquery
Bigtable stable cloud.google.com/go/bigtable
Cloudbuild stable cloud.google.com/go/cloudbuild/apiv1
Cloudtasks stable cloud.google.com/go/cloudtasks/apiv2
Container stable cloud.google.com/go/container/apiv1
ContainerAnalysis beta cloud.google.com/go/containeranalysis/apiv1
Dataproc stable cloud.google.com/go/dataproc/apiv1
Datastore stable cloud.google.com/go/datastore
Debugger stable cloud.google.com/go/debugger/apiv2
Dialogflow stable cloud.google.com/go/dialogflow/apiv2
Data Loss Prevention stable cloud.google.com/go/dlp/apiv2
ErrorReporting alpha cloud.google.com/go/errorreporting
Firestore stable cloud.google.com/go/firestore
IAM stable cloud.google.com/go/iam
IoT stable cloud.google.com/go/iot/apiv1
IRM alpha cloud.google.com/go/irm/apiv1alpha2
KMS stable cloud.google.com/go/kms/apiv1
Natural Language stable cloud.google.com/go/language/apiv1
Logging stable cloud.google.com/go/logging
Memorystore alpha cloud.google.com/go/redis/apiv1
Monitoring stable cloud.google.com/go/monitoring/apiv3
OS Login stable cloud.google.com/go/oslogin/apiv1
Pub/Sub stable cloud.google.com/go/pubsub
Phishing Protection alpha cloud.google.com/go/phishingprotection/apiv1beta1
reCAPTCHA Enterprise alpha cloud.google.com/go/recaptchaenterprise/apiv1beta1
Recommender beta cloud.google.com/go/recommender/apiv1beta1
Scheduler stable cloud.google.com/go/scheduler/apiv1
Securitycenter stable cloud.google.com/go/securitycenter/apiv1
Spanner stable cloud.google.com/go/spanner
Speech stable cloud.google.com/go/speech/apiv1
Storage stable cloud.google.com/go/storage
Talent alpha cloud.google.com/go/talent/apiv4beta1
Text To Speech stable cloud.google.com/go/texttospeech/apiv1
Trace stable cloud.google.com/go/trace/apiv2
Translate stable cloud.google.com/go/translate
Video Intelligence beta cloud.google.com/go/videointelligence/apiv1beta2
Vision stable cloud.google.com/go/vision/apiv1
Webrisk alpha cloud.google.com/go/webrisk/apiv1beta1

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 pkg.go.dev/cloud.google.com/go

Go Versions Supported

We currently support Go versions 1.11 and newer.

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

Contributing

Contributions are welcome. Please, see the CONTRIBUTING document for details.

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.

Expand ▾ Collapse ▴

Documentation

Overview

Package cloud is the root of the packages used to access Google Cloud Services. See https://godoc.org/cloud.google.com/go for a full list of sub-packages.

Client Options

All clients in sub-packages are configurable via client options. These options are described here: https://godoc.org/google.golang.org/api/option.

Authentication and Authorization

All the clients in sub-packages support authentication via Google Application Default Credentials (see https://cloud.google.com/docs/authentication/production), or by providing a JSON key file for a Service Account. See the authentication examples in this package for details.

Timeouts and Cancellation

By default, non-streaming methods, like Create or Get, will have a default deadline applied to the context provided at call time, unless a context deadline is already set. Streaming methods have no default deadline and will run indefinitely. To set timeouts or arrange for cancellation, use contexts. See the examples for details. Transient errors will be retried when correctness allows.

To opt out of default deadlines, set the temporary environment variable GOOGLE_API_GO_EXPERIMENTAL_DISABLE_DEFAULT_DEADLINE to "true" prior to client creation. This affects all Google Cloud Go client libraries. This opt-out mechanism will be removed in a future release. File an issue at https://github.com/googleapis/google-cloud-go if the default deadlines cannot work for you.

Do not attempt to control the initial connection (dialing) of a service by setting a timeout on the context passed to NewClient. Dialing is non-blocking, so timeouts would be ineffective and would only interfere with credential refreshing, which uses the same context.

Connection Pooling

Connection pooling differs in clients based on their transport. Cloud clients either rely on HTTP or gRPC transports to communicate with Google Cloud.

Cloud clients that use HTTP (bigquery, compute, storage, and translate) rely on the underlying HTTP transport to cache connections for later re-use. These are cached to the default http.MaxIdleConns and http.MaxIdleConnsPerHost settings in http.DefaultTransport.

For gRPC clients (all others in this repo), connection pooling is configurable. Users of cloud client libraries may specify option.WithGRPCConnectionPool(n) as a client option to NewClient calls. This configures the underlying gRPC connections to be pooled and addressed in a round robin fashion.

Using the Libraries with Docker

Minimal docker images like Alpine lack CA certificates. This causes RPCs to appear to hang, because gRPC retries indefinitely. See https://github.com/googleapis/google-cloud-go/issues/928 for more information.

Debugging

To see gRPC logs, set the environment variable GRPC_GO_LOG_SEVERITY_LEVEL. See https://godoc.org/google.golang.org/grpc/grpclog for more information.

For HTTP logging, set the GODEBUG environment variable to "http2debug=1" or "http2debug=2".

Client Stability

Clients in this repository are considered alpha or beta unless otherwise marked as stable in the README.md. Semver is not used to communicate stability of clients.

Alpha and beta clients may change or go away without notice.

Clients marked stable will maintain compatibility with future versions for as long as we can reasonably sustain. Incompatible changes might be made in some situations, including:

- Security bugs may prompt backwards-incompatible changes.

- Situations in which components are no longer feasible to maintain without making breaking changes, including removal.

- Parts of the client surface may be outright unstable and subject to change. These parts of the surface will be labeled with the note, "It is EXPERIMENTAL and subject to change or removal without notice."

Example (ApplicationDefaultCredentials)

Google Application Default Credentials is the recommended way to authorize and authenticate clients.

For information on how to create and obtain Application Default Credentials, see https://developers.google.com/identity/protocols/application-default-credentials.

Code:

package main

import (
	secretmanager "cloud.google.com/go/secretmanager/apiv1"
	"context"
)

func main() {
	client, err := secretmanager.NewClient(context.Background())
	if err != nil {
		// TODO: handle error.
	}
	_ = client // Use the client.
}
Example (Cancellation)

To arrange for an RPC to be canceled, use context.WithCancel.

Code:

package main

import (
	secretmanager "cloud.google.com/go/secretmanager/apiv1"
	"context"
	secretmanagerpb "google.golang.org/genproto/googleapis/cloud/secretmanager/v1"
)

func main() {
	ctx := context.Background()
	// Do not cancel the context passed to NewClient: dialing happens asynchronously,
	// and the context is used to refresh credentials in the background.
	client, err := secretmanager.NewClient(ctx)
	if err != nil {
		// TODO: handle error.
	}
	cctx, cancel := context.WithCancel(ctx)
	defer cancel() // Always call cancel.

	// TODO: Make the cancel function available to whatever might want to cancel the
	// call--perhaps a GUI button.
	req := &secretmanagerpb.DeleteSecretRequest{Name: "projects/proj/secrets/name"}
	if err := client.DeleteSecret(cctx, req); err != nil {
		// TODO: handle error.
	}
}
Example (CredentialsFile)

You can use a file with credentials to authenticate and authorize, such as a JSON key file associated with a Google service account. Service Account keys can be created and downloaded from https://console.developers.google.com/permissions/serviceaccounts.

This example uses the Datastore client, but the same steps apply to the other client libraries underneath this package.

Code:

package main

import (
	secretmanager "cloud.google.com/go/secretmanager/apiv1"
	"context"
	"google.golang.org/api/option"
)

func main() {
	client, err := secretmanager.NewClient(context.Background(),
		option.WithCredentialsFile("/path/to/service-account-key.json"))
	if err != nil {
		// TODO: handle error.
	}
	_ = client // Use the client.
}
Example (CredentialsFromJSON)

In some cases (for instance, you don't want to store secrets on disk), you can create credentials from in-memory JSON and use the WithCredentials option.

The google package in this example is at golang.org/x/oauth2/google.

This example uses the Secret Manager client, but the same steps apply to the other client libraries underneath this package. Note that scopes can be found at https://developers.google.com/identity/protocols/googlescopes, and are also provided in all auto-generated libraries: for example, cloud.google.com/go/secretmanager/apiv1 provides DefaultAuthScopes.

Code:

package main

import (
	secretmanager "cloud.google.com/go/secretmanager/apiv1"
	"context"
	"golang.org/x/oauth2/google"
	"google.golang.org/api/option"
)

func main() {
	ctx := context.Background()
	creds, err := google.CredentialsFromJSON(ctx, []byte("JSON creds"), secretmanager.DefaultAuthScopes()...)
	if err != nil {
		// TODO: handle error.
	}
	client, err := secretmanager.NewClient(ctx, option.WithCredentials(creds))
	if err != nil {
		// TODO: handle error.
	}
	_ = client // Use the client.
}
Example (Timeout)

To set a timeout for an RPC, use context.WithTimeout.

Code:

package main

import (
	secretmanager "cloud.google.com/go/secretmanager/apiv1"
	"context"
	secretmanagerpb "google.golang.org/genproto/googleapis/cloud/secretmanager/v1"
	"time"
)

func main() {
	ctx := context.Background()
	// Do not set a timeout on the context passed to NewClient: dialing happens
	// asynchronously, and the context is used to refresh credentials in the
	// background.
	client, err := secretmanager.NewClient(ctx)
	if err != nil {
		// TODO: handle error.
	}
	// Time out if it takes more than 10 seconds to create a dataset.
	tctx, cancel := context.WithTimeout(ctx, 10*time.Second)
	defer cancel() // Always call cancel.

	req := &secretmanagerpb.DeleteSecretRequest{Name: "projects/project-id/secrets/name"}
	if err := client.DeleteSecret(tctx, req); err != nil {
		// TODO: handle error.
	}
}

Source Files

Directories

Path Synopsis
accessapproval/apiv1 NOTE: This package is in beta.
analytics/admin/apiv1alpha NOTE: This package is in alpha.
analytics/data/apiv1alpha NOTE: This package is in alpha.
area120/tables/apiv1alpha1 NOTE: This package is in alpha.
asset/apiv1 Package asset is an auto-generated package for the Cloud Asset API.
asset/apiv1beta1 Package asset is an auto-generated package for the Cloud Asset API.
asset/apiv1p2beta1 Package asset is an auto-generated package for the Cloud Asset API.
asset/apiv1p5beta1 Package asset is an auto-generated package for the Cloud Asset API.
assuredworkloads/apiv1beta1 NOTE: This package is in beta.
automl/apiv1 Package automl is an auto-generated package for the Cloud AutoML API.
automl/apiv1beta1 Package automl is an auto-generated package for the Cloud AutoML API.
billing/apiv1 Package billing is an auto-generated package for the Cloud Billing API.
billing/budgets/apiv1 Package budgets is an auto-generated package for the Cloud Billing Budget API.
billing/budgets/apiv1beta1 NOTE: This package is in beta.
civil Package civil implements types for civil time, a time-zone-independent representation of time that follows the rules of the proleptic Gregorian calendar with exactly 24-hour days, 60-minute hours, and 60-second minutes.
cloudbuild/apiv1 Creates and manages builds on Google Cloud Platform.
cloudbuild/apiv1/v2 Package cloudbuild is an auto-generated package for the Cloud Build API.
cloudtasks/apiv2 Package cloudtasks is an auto-generated package for the Cloud Tasks API.
cloudtasks/apiv2beta2 Package cloudtasks is an auto-generated package for the Cloud Tasks API.
cloudtasks/apiv2beta3 Package cloudtasks is an auto-generated package for the Cloud Tasks API.
cmd/go-cloud-debug-agent Deprecated.
cmd/go-cloud-debug-agent/internal/breakpoints Package breakpoints handles breakpoint requests we get from the user through the Debuglet Controller, and manages corresponding breakpoints set in the code.
cmd/go-cloud-debug-agent/internal/controller Package controller is a library for interacting with the Google Cloud Debugger's Debuglet Controller service.
cmd/go-cloud-debug-agent/internal/debug Package debug provides the portable interface to a program being debugged.
cmd/go-cloud-debug-agent/internal/debug/arch Package arch contains architecture-specific definitions.
cmd/go-cloud-debug-agent/internal/debug/cmd/debugproxy
cmd/go-cloud-debug-agent/internal/debug/dwarf Package dwarf provides access to DWARF debugging information loaded from executable files, as defined in the DWARF 2.0 Standard at http://dwarfstd.org/doc/dwarf-2.0.0.pdf
cmd/go-cloud-debug-agent/internal/debug/elf Package elf implements access to ELF object files.
cmd/go-cloud-debug-agent/internal/debug/gosym Package gosym implements access to the Go symbol and line number tables embedded in Go binaries generated by the gc compilers.
cmd/go-cloud-debug-agent/internal/debug/local Package local provides access to a local program.
cmd/go-cloud-debug-agent/internal/debug/remote Package remote provides remote access to a debugproxy server.
cmd/go-cloud-debug-agent/internal/debug/server Package server provides RPC access to a local program being debugged.
cmd/go-cloud-debug-agent/internal/debug/server/protocol Package protocol defines the types used to represent calls to the debug server.
cmd/go-cloud-debug-agent/internal/debug/tests/peek
cmd/go-cloud-debug-agent/internal/valuecollector Package valuecollector is used to collect the values of variables in a program.
compute/metadata Package metadata provides access to Google Compute Engine (GCE) metadata and API service accounts.
container Package container contains a deprecated Google Container Engine client.
container/apiv1 Package container is an auto-generated package for the Kubernetes Engine API.
containeranalysis/apiv1 Package containeranalysis is an auto-generated package for the Container Analysis API.
containeranalysis/apiv1beta1 Package containeranalysis is an auto-generated package for the Container Analysis API.
datacatalog/apiv1 Package datacatalog is an auto-generated package for the Google Cloud Data Catalog API.
datacatalog/apiv1beta1 Package datacatalog is an auto-generated package for the Google Cloud Data Catalog API.
dataproc/apiv1 Package dataproc is an auto-generated package for the Cloud Dataproc API.
dataproc/apiv1beta2 Package dataproc is an auto-generated package for the Cloud Dataproc API.
debugger/apiv2 Package debugger is an auto-generated package for the Stackdriver Debugger API.
dialogflow/apiv2 Package dialogflow is an auto-generated package for the Dialogflow API.
dialogflow/cx/apiv3beta1 Package cx is an auto-generated package for the Dialogflow API.
dlp/apiv2 Package dlp is an auto-generated package for the Cloud Data Loss Prevention (DLP) API.
errorreporting Package errorreporting is a Google Cloud Error Reporting library.
errorreporting/apiv1beta1 Package errorreporting is an auto-generated package for the Cloud Error Reporting API.
functions/apiv1 Use of Context The ctx passed to NewClient is used for authentication requests and for creating the underlying connection, but is not used for subsequent calls.
functions/metadata Package metadata provides methods for creating and accessing context.Context objects with Google Cloud Functions metadata.
gaming/apiv1 Use of Context The ctx passed to NewClient is used for authentication requests and for creating the underlying connection, but is not used for subsequent calls.
gaming/apiv1beta NOTE: This package is in beta.
grafeas/apiv1 Package grafeas is an auto-generated package for the Container Analysis API.
httpreplay Package httpreplay provides an API for recording and replaying traffic from HTTP-based Google API clients.
httpreplay/cmd/httpr
httpreplay/internal/proxy Package proxy provides a record/replay HTTP proxy.
iam Package iam supports the resource-specific operations of Google Cloud IAM (Identity and Access Management) for the Google Cloud Libraries.
iam/admin/apiv1 Package admin is an auto-generated package for the Google Identity and Access Management (IAM) API.
iam/credentials/apiv1 Package credentials is an auto-generated package for the IAM Service Account Credentials API.
internal
internal/btree Package btree implements in-memory B-Trees of arbitrary degree.
internal/fields Package fields provides a view of the fields of a struct that follows the Go rules, amended to consider tags and case insensitivity.
internal/leakcheck Package leakcheck contains functions to check leaked goroutines.
internal/optional Package optional provides versions of primitive types that can be nil.
internal/pretty Package pretty implements a simple pretty-printer.
internal/protostruct Package protostruct supports operations on the protocol buffer Struct message.
internal/testutil Package testutil contains helper functions for writing tests.
internal/trace
internal/tracecontext Package tracecontext provides encoders and decoders for Stackdriver Trace contexts.
internal/uid Package uid supports generating unique IDs.
internal/version Package version contains version information for Google Cloud Client Libraries for Go, as reported in request headers.
iot/apiv1 Package iot is an auto-generated package for the Cloud IoT API.
kms/apiv1 Package kms is an auto-generated package for the Cloud Key Management Service (KMS) API.
language/apiv1 Package language is an auto-generated package for the Cloud Natural Language API.
language/apiv1beta2 Package language is an auto-generated package for the Cloud Natural Language API.
longrunning Package longrunning supports Long Running Operations for the Google Cloud Libraries.
longrunning/autogen Package longrunning is an auto-generated package for the Long Running Operations API.
managedidentities/apiv1 Package managedidentities is an auto-generated package for the Managed Service for Microsoft Active Directory API.
memcache/apiv1beta2 Package memcache is an auto-generated package for the Cloud Memorystore for Memcached API.
monitoring/apiv3 Package monitoring is an auto-generated package for the Cloud Monitoring API.
monitoring/apiv3/v2 Package monitoring is an auto-generated package for the Cloud Monitoring API.
monitoring/dashboard/apiv1 Use of Context The ctx passed to NewClient is used for authentication requests and for creating the underlying connection, but is not used for subsequent calls.
notebooks/apiv1beta1 Package notebooks is an auto-generated package for the Notebooks API.
osconfig/agentendpoint/apiv1 Package agentendpoint is an auto-generated package for the Cloud OS Config API.
osconfig/agentendpoint/apiv1beta Package agentendpoint is an auto-generated package for the Cloud OS Config API.
osconfig/apiv1 Package osconfig is an auto-generated package for the Cloud OS Config API.
osconfig/apiv1beta Package osconfig is an auto-generated package for the Cloud OS Config API.
oslogin/apiv1 Package oslogin is an auto-generated package for the Cloud OS Login API.
oslogin/apiv1beta Package oslogin is an auto-generated package for the Cloud OS Login API.
phishingprotection/apiv1beta1 Package phishingprotection is an auto-generated package for the Phishing Protection API.
policytroubleshooter/apiv1 Package policytroubleshooter is an auto-generated package for the Policy Troubleshooter API.
profiler Package profiler is a client for the Cloud Profiler service.
profiler/busybench Busybench is a tool that runs a benchmark with the profiler enabled.
profiler/mocks Package mocks is a generated GoMock package.
profiler/proftest
recaptchaenterprise/apiv1 Package recaptchaenterprise is an auto-generated package for the reCAPTCHA Enterprise API.
recaptchaenterprise/apiv1beta1 Package recaptchaenterprise is an auto-generated package for the reCAPTCHA Enterprise API.
recommender/apiv1 Package recommender is an auto-generated package for the Recommender API.
recommender/apiv1beta1 Package recommender is an auto-generated package for the Recommender API.
redis/apiv1 Package redis is an auto-generated package for the Google Cloud Memorystore for Redis API.
redis/apiv1beta1 Package redis is an auto-generated package for the Google Cloud Memorystore for Redis API.
rpcreplay Package rpcreplay supports the capture and replay of gRPC calls.
rpcreplay/proto/intstore
rpcreplay/proto/rpcreplay
scheduler/apiv1 Package scheduler is an auto-generated package for the Cloud Scheduler API.
scheduler/apiv1beta1 Package scheduler is an auto-generated package for the Cloud Scheduler API.
secretmanager/apiv1 Package secretmanager is an auto-generated package for the Secret Manager API.
secretmanager/apiv1beta1 Package secretmanager is an auto-generated package for the Secret Manager API.
security/privateca/apiv1beta1 NOTE: This package is in beta.
securitycenter/apiv1 Package securitycenter is an auto-generated package for the Security Command Center API.
securitycenter/apiv1beta1 Package securitycenter is an auto-generated package for the Security Command Center API.
securitycenter/apiv1p1beta1 Package securitycenter is an auto-generated package for the Security Command Center API.
securitycenter/settings/apiv1beta1 Package settings is an auto-generated package for the Cloud Security Command Center API.
servicedirectory/apiv1beta1 Package servicedirectory is an auto-generated package for the Service Directory API.
speech/apiv1 Package speech is an auto-generated package for the Cloud Speech-to-Text API.
speech/apiv1p1beta1 Package speech is an auto-generated package for the Cloud Speech-to-Text API.
talent/apiv4 NOTE: This package is in beta.
talent/apiv4beta1 Package talent is an auto-generated package for the Cloud Talent Solution API.
texttospeech/apiv1 Package texttospeech is an auto-generated package for the Cloud Text-to-Speech API.
third_party/pkgsite
trace/apiv1 Package trace is an auto-generated package for the Stackdriver Trace API.
trace/apiv2 Package trace is an auto-generated package for the Stackdriver Trace API.
translate Package translate is the v2 client for the Google Translation API.
translate/apiv3 Package translate is an auto-generated package for the Cloud Translation API.
video/transcoder/apiv1beta1 NOTE: This package is in beta.
videointelligence/apiv1 Package videointelligence is an auto-generated package for the Cloud Video Intelligence API.
videointelligence/apiv1beta2 Package videointelligence is an auto-generated package for the Google Cloud Video Intelligence API.
vision/apiv1 Package vision is an auto-generated package for the Cloud Vision API.
vision/apiv1p1beta1 Package vision is an auto-generated package for the Cloud Vision API.
webrisk/apiv1 Package webrisk is an auto-generated package for the Web Risk API.
webrisk/apiv1beta1 Package webrisk is an auto-generated package for the Web Risk API.
websecurityscanner/apiv1 Package websecurityscanner is an auto-generated package for the Web Security Scanner API.
workflows/apiv1beta NOTE: This package is in beta.
workflows/executions/apiv1beta NOTE: This package is in beta.
MODULE bigquery
MODULE bigtable
MODULE compute/metadata
MODULE datastore
MODULE firestore
MODULE internal/examples/fake
MODULE internal/examples/mock
MODULE internal/gapicgen
MODULE internal/godocfx
MODULE logging
MODULE pubsub
MODULE pubsublite
MODULE spanner
MODULE storage