go – cloud.google.com/go Index | Examples | Files | Directories

package cloud

import "cloud.google.com/go"

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, all requests in sub-packages will run indefinitely, retrying on transient errors when correctness allows. To set timeouts or arrange for cancellation, use contexts. See the examples for details.

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

package main

import (
	"context"

	"cloud.google.com/go/datastore"
)

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

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

Code:play 

package main

import (
	"context"

	"cloud.google.com/go/bigquery"
)

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 := bigquery.NewClient(ctx, "project-id")
	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.
	if err := client.Dataset("new-dataset").Create(cctx, nil); 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:play 

package main

import (
	"context"

	"cloud.google.com/go/datastore"
	"google.golang.org/api/option"
)

func main() {
	client, err := datastore.NewClient(context.Background(),
		"project-id", 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 PubSub 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/pubsub/apiv1 provides DefaultAuthScopes.

Code:play 

package main

import (
	"context"

	"cloud.google.com/go/pubsub"
	"golang.org/x/oauth2/google"
	"google.golang.org/api/option"
)

func main() {
	ctx := context.Background()
	creds, err := google.CredentialsFromJSON(ctx, []byte("JSON creds"), pubsub.ScopePubSub)
	if err != nil {
		// TODO: handle error.
	}
	client, err := pubsub.NewClient(ctx, "project-id", 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:play 

package main

import (
	"context"
	"time"

	"cloud.google.com/go/bigquery"
)

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 := bigquery.NewClient(ctx, "project-id")
	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.

	if err := client.Dataset("new-dataset").Create(tctx, nil); err != nil {
		// TODO: handle error.
	}
}

Index

Examples

Source Files

doc.go

Directories

PathSynopsis
asset
asset/apiv1
asset/apiv1beta1Package asset is an auto-generated package for the Cloud Asset API.
asset/apiv1p2beta1Package asset is an auto-generated package for the Cloud Asset API.
asset/v1beta1Package asset is an auto-generated package for the Cloud Asset API.
automl
automl/apiv1Train high-quality custom machine learning models with minimum effort and machine learning expertise.
automl/apiv1beta1Package automl is an auto-generated package for the Cloud AutoML API.
civilPackage 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
cloudbuild/apiv1Package cloudbuild is an auto-generated package for the Cloud Build API.
cloudtasks
cloudtasks/apiv2Manages the execution of large numbers of distributed requests.
cloudtasks/apiv2beta2Package cloudtasks is an auto-generated package for the Cloud Tasks API.
cloudtasks/apiv2beta3Package cloudtasks is an auto-generated package for the Cloud Tasks API.
cmd
cmd/go-cloud-debug-agent
cmd/go-cloud-debug-agent/internal
compute
compute/metadataPackage metadata provides access to Google Compute Engine (GCE) metadata and API service accounts.
containerPackage container contains a deprecated Google Container Engine client.
containeranalysis
containeranalysis/apiv1Package containeranalysis is an auto-generated package for the Container Analysis API.
containeranalysis/apiv1beta1Package containeranalysis is an auto-generated package for the Container Analysis API.
container/apiv1Package container is an auto-generated package for the Google Container Engine API.
dataproc
dataproc/apiv1Package dataproc is an auto-generated package for the Google Cloud Dataproc API.
dataproc/apiv1beta2Package dataproc is an auto-generated package for the Google Cloud Dataproc API.
debugger
debugger/apiv2Package debugger is an auto-generated package for the Stackdriver Debugger API.
dialogflow
dialogflow/apiv2Package dialogflow is an auto-generated package for the Dialogflow API.
dlp
dlp/apiv2Provides methods for detection, risk analysis, and de-identification of privacy-sensitive fragments in text, images, and Google Cloud Platform storage repositories.
errorreportingPackage errorreporting is a Google Stackdriver Error Reporting library.
errorreporting/apiv1beta1Package errorreporting is an auto-generated package for the Stackdriver Error Reporting API.
expr
expr/apiv1alpha1Package expr is an auto-generated package for the Common Expression Language.
functions
functions/metadataPackage metadata provides methods for creating and accessing context.Context objects with Google Cloud Functions metadata.
grafeas
grafeas/apiv1Package grafeas is an auto-generated package for the Container Analysis API.
httpreplayPackage httpreplay provides an API for recording and replaying traffic from HTTP-based Google API clients.
httpreplay/cmd
httpreplay/cmd/httpr
httpreplay/internal
iamPackage iam supports the resource-specific operations of Google Cloud IAM (Identity and Access Management) for the Google Cloud Libraries.
iam/admin
iam/admin/apiv1Package admin is an auto-generated package for the Google Identity and Access Management (IAM) API.
iam/credentials
iam/credentials/apiv1Package credentials is an auto-generated package for the IAM Service Account Credentials API.
internal
iot
iot/apiv1Package iot is an auto-generated package for the Cloud IoT API.
irm
irm/apiv1alpha2Package irm is an auto-generated package for the Stackdriver Incident Response & Management API.
kms
kms/apiv1Manages keys and performs cryptographic operations in a central cloud service, for direct use by other cloud resources and applications.
language
language/apiv1
language/apiv1beta2Package language is an auto-generated package for the Google Cloud Natural Language API.
longrunningPackage longrunning supports Long Running Operations for the Google Cloud Libraries.
longrunning/autogenPackage longrunning is an auto-generated package for the Long Running Operations API.
monitoring
monitoring/apiv3Package monitoring is an auto-generated package for the Stackdriver Monitoring API.
oslogin
oslogin/apiv1Package oslogin is an auto-generated package for the Cloud OS Login API.
oslogin/apiv1betaPackage oslogin is an auto-generated package for the Google Cloud OS Login API.
phishingprotection
phishingprotection/apiv1beta1
profilerPackage profiler is a client for the Stackdriver Profiler service.
profiler/busybenchBusybench is a tool that runs a benchmark with the profiler enabled.
profiler/mocksPackage mocks is a generated GoMock package.
profiler/proftest
recaptchaenterprise
recaptchaenterprise/apiv1beta1Package recaptchaenterprise is an auto-generated package for the reCAPTCHA Enterprise API.
recommender
recommender/apiv1beta1Package recommender is an auto-generated package for the Recommender API.
redis
redis/apiv1Package redis is an auto-generated package for the Google Cloud Memorystore for Redis API.
redis/apiv1beta1Package redis is an auto-generated package for the Google Cloud Memorystore for Redis API.
rpcreplayPackage rpcreplay supports the capture and replay of gRPC calls.
rpcreplay/proto
rpcreplay/proto/intstore
rpcreplay/proto/rpcreplay
scheduler
scheduler/apiv1
scheduler/apiv1beta1
securitycenter
securitycenter/apiv1Package securitycenter is an auto-generated package for the Cloud Security Command Center API.
securitycenter/apiv1beta1Package securitycenter is an auto-generated package for the Cloud Security Command Center API.
speech
speech/apiv1
speech/apiv1p1beta1
talent
talent/apiv4beta1Package talent is an auto-generated package for the Cloud Talent Solution API.
texttospeech
texttospeech/apiv1
trace
trace/apiv1Package trace is an auto-generated package for the Stackdriver Trace API.
trace/apiv2Package trace is an auto-generated package for the Stackdriver Trace API.
translatePackage translate is the v2 client for the Google Translation API.
translate/apiv3
videointelligence
videointelligence/apiv1Package videointelligence is an auto-generated package for the Cloud Video Intelligence API.
videointelligence/apiv1beta2Package videointelligence is an auto-generated package for the Google Cloud Video Intelligence API.
vision
vision/apiv1Integrates Google Vision features, including image labeling, face, logo, and landmark detection, optical character recognition (OCR), and detection of explicit content, into applications.
vision/apiv1p1beta1Package vision is an auto-generated package for the Google Cloud Vision API.
webrisk
webrisk/apiv1beta1Package webrisk is an auto-generated package for the Web Risk API.
Version
v0.49.0
Published
Nov 19, 2019
Platform
darwin/amd64
Last checked
2 minutes ago

Tools for package owners.