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

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:

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

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

Code:

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

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:

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.

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:

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.

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

Code:

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

Package Files

doc.go

Directories

PathSynopsis
asset/apiv1Package asset is an auto-generated package for the Cloud Asset API.
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/apiv1beta1Package automl is an auto-generated package for the Cloud AutoML API.
bigqueryPackage bigquery provides a client for the BigQuery service.
bigquery/datatransfer/apiv1Package datatransfer is an auto-generated package for the BigQuery Data Transfer API.
bigquery/storage/apiv1beta1Package storage is an auto-generated package for the BigQuery Storage API.
bigtablePackage bigtable is an API to Google Cloud Bigtable.
bigtable/bttestPackage bttest contains test helpers for working with the bigtable package.
bigtable/cmd/cbtCbt is a command-line tool that allows you to interact with Cloud Bigtable.
bigtable/cmd/emulatorcbtemulator launches the in-memory Cloud Bigtable server on the given address.
bigtable/cmd/loadtestLoadtest does some load testing through the Go client library for Cloud Bigtable.
bigtable/cmd/scantestScantest does scan-related load testing against Cloud Bigtable.
bigtable/internal/cbtconfigPackage cbtconfig encapsulates common code for reading configuration from .cbtrc and gcloud.
bigtable/internal/optionPackage option contains common code for dealing with client options.
bigtable/internal/stat
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.
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/go-cloud-debug-agent
cmd/go-cloud-debug-agent/internal/breakpointsPackage 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/controllerPackage controller is a library for interacting with the Google Cloud Debugger's Debuglet Controller service.
cmd/go-cloud-debug-agent/internal/debugPackage debug provides the portable interface to a program being debugged.
cmd/go-cloud-debug-agent/internal/debug/archPackage arch contains architecture-specific definitions.
cmd/go-cloud-debug-agent/internal/debug/cmd/debugproxy
cmd/go-cloud-debug-agent/internal/debug/dwarfPackage 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/elfPackage elf implements access to ELF object files.
cmd/go-cloud-debug-agent/internal/debug/gosymPackage 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/localPackage local provides access to a local program.
cmd/go-cloud-debug-agent/internal/debug/remotePackage remote provides remote access to a debugproxy server.
cmd/go-cloud-debug-agent/internal/debug/serverPackage server provides RPC access to a local program being debugged.
cmd/go-cloud-debug-agent/internal/debug/server/protocolPackage 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/valuecollectorPackage valuecollector is used to collect the values of variables in a program.
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/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/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.
datastorePackage datastore provides a client for Google Cloud Datastore.
datastore/internal/gaepbPackage gaepb is a subset of protobufs, copied from google.golang.org/appengine/internal/datastore.
debugger/apiv2Package debugger is an auto-generated package for the Stackdriver Debugger API.
dialogflow/apiv2Package dialogflow is an auto-generated package for the Dialogflow API.
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/apiv1alpha1Package expr is an auto-generated package for the Common Expression Language.
firestorePackage firestore provides a client for reading and writing to a Cloud Firestore database.
firestore/apiv1Package firestore is an auto-generated package for the Google Cloud Firestore API.
firestore/apiv1/adminPackage apiv1 is an auto-generated package for the Google Cloud Firestore Admin API.
firestore/apiv1beta1Package firestore is an auto-generated package for the Google Cloud Firestore API.
firestore/genproto
firestore/internal
functions/metadataPackage metadata provides methods for creating and accessing context.Context objects with Google Cloud Functions metadata.
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/httpr
httpreplay/internal/proxyPackage proxy provides a record/replay HTTP proxy.
iamPackage iam supports the resource-specific operations of Google Cloud IAM (Identity and Access Management) for the Google Cloud Libraries.
iam/admin/apiv1Package admin is an auto-generated package for the Google Identity and Access Management (IAM) API.
iam/credentials/apiv1Package credentials is an auto-generated package for the IAM Service Account Credentials API.
internal
internal/btreePackage btree implements in-memory B-Trees of arbitrary degree.
internal/fieldsPackage fields provides a view of the fields of a struct that follows the Go rules, amended to consider tags and case insensitivity.
internal/leakcheckPackage leakcheck contains functions to check leaked goroutines.
internal/optionalPackage optional provides versions of primitive types that can be nil.
internal/prettyPackage pretty implements a simple pretty-printer.
internal/protostructPackage protostruct supports operations on the protocol buffer Struct message.
internal/testutilPackage testutil contains helper functions for writing tests.
internal/trace
internal/tracecontextPackage tracecontext provides encoders and decoders for Stackdriver Trace contexts.
internal/uidPackage uid supports generating unique IDs.
internal/versionPackage version contains version information for Google Cloud Client Libraries for Go, as reported in request headers.
iot/apiv1Package iot is an auto-generated package for the Cloud IoT API.
irm/apiv1alpha2Package irm is an auto-generated package for the Stackdriver Incident Response & Management API.
kms/apiv1Manages keys and performs cryptographic operations in a central cloud service, for direct use by other cloud resources and applications.
language/apiv1Package language is an auto-generated package for the Cloud Natural Language API.
language/apiv1beta2Package language is an auto-generated package for the Google Cloud Natural Language API.
loggingPackage logging contains a Stackdriver Logging client suitable for writing logs.
logging/apiv2Package logging is an auto-generated package for the Stackdriver Logging API.
logging/internal
logging/internal/testingPackage testing provides support for testing the logging client.
logging/logadminPackage logadmin contains a Stackdriver Logging client that can be used for reading logs and working with sinks, metrics and monitored resources.
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/apiv3Package monitoring is an auto-generated package for the Stackdriver Monitoring API.
oslogin/apiv1Package oslogin is an auto-generated package for the Google Cloud OS Login API.
oslogin/apiv1betaPackage oslogin is an auto-generated package for the Google Cloud OS Login API.
phishingprotection/apiv1beta1Package phishingprotection is an auto-generated package for the Phishing Protection API.
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
pubsubPackage pubsub provides an easy way to publish and receive Google Cloud Pub/Sub messages, hiding the details of the underlying server RPCs.
pubsub/apiv1Provides reliable, many-to-many, asynchronous messaging between applications.
pubsub/internal/distribution
pubsub/loadtestPackage loadtest implements load testing for pubsub, following the interface defined in https://github.com/GoogleCloudPlatform/pubsub/tree/master/load-test-framework/ .
pubsub/loadtest/cmd
pubsub/loadtest/pbPackage google_pubsub_loadtest is a generated protocol buffer package.
pubsub/pstestPackage pstest provides a fake Cloud PubSub service for testing.
recaptchaenterprise/apiv1beta1Package recaptchaenterprise is an auto-generated package for the reCAPTCHA Enterprise API.
recommender/apiv1beta1Package recommender is an auto-generated package for the Recommender API.
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/intstore
rpcreplay/proto/rpcreplay
scheduler/apiv1Creates and manages jobs run on a regular recurring schedule.
scheduler/apiv1beta1Package scheduler is an auto-generated package for the Cloud Scheduler API.
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.
spannerPackage spanner provides a client for reading and writing to Cloud Spanner databases.
spanner/admin/database/apiv1Package database is an auto-generated package for the Cloud Spanner Database Admin API.
spanner/admin/instance/apiv1Package instance is an auto-generated package for the Cloud Spanner Instance Admin API.
spanner/apiv1Cloud Spanner is a managed, mission-critical, globally consistent and scalable relational database service.
spanner/internal/backoff
spanner/internal/testutil
spanner/spannertestPackage spannertest contains test helpers for working with Cloud Spanner.
spanner/spansqlPackage spansql contains types and a parser for the Cloud Spanner SQL dialect.
speech/apiv1Converts audio to text by applying powerful neural network models.
speech/apiv1p1beta1Package speech is an auto-generated package for the Cloud Speech API.
storagePackage storage provides an easy way to work with Google Cloud Storage.
talent/apiv4beta1Package talent is an auto-generated package for the Cloud Talent Solution API.
texttospeech/apiv1Package texttospeech is an auto-generated package for the Cloud Text-to-Speech API.
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 a client for the Google Translation API.
videointelligence/apiv1Package videointelligence is an auto-generated package for the Cloud Video Intelligence API.
videointelligence/apiv1beta1Package videointelligence is an auto-generated package for the Google Cloud Video Intelligence API.
videointelligence/apiv1beta2Package videointelligence is an auto-generated package for the Google Cloud Video Intelligence API.
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/apiv1beta1Package webrisk is an auto-generated package for the Web Risk API.

Updated 2019-09-21. Refresh now. Tools for package owners.