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, 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/GoogleCloudPlatform/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".
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.
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. }
Output:
Example (Cancellation) ¶
To arrange for an RPC to be canceled, use context.WithCancel.
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. } }
Output:
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.
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. }
Output:
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.
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. }
Output:
Example (Timeout) ¶
To set a timeout for an RPC, use context.WithTimeout.
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. } }
Output:
Directories ¶
Path | Synopsis |
---|---|
asset
|
|
v1beta1
Package asset is an auto-generated package for the Cloud Asset API.
|
Package asset is an auto-generated package for the Cloud Asset API. |
Package bigquery provides a client for the BigQuery service.
|
Package bigquery provides a client for the BigQuery service. |
datatransfer/apiv1
Package datatransfer is an auto-generated package for the BigQuery Data Transfer API.
|
Package datatransfer is an auto-generated package for the BigQuery Data Transfer API. |
Package bigtable is an API to Google Cloud Bigtable.
|
Package bigtable is an API to Google Cloud Bigtable. |
bttest
Package bttest contains test helpers for working with the bigtable package.
|
Package bttest contains test helpers for working with the bigtable package. |
cmd/cbt
Cbt is a tool for doing basic interactions with Cloud Bigtable.
|
Cbt is a tool for doing basic interactions with Cloud Bigtable. |
cmd/emulator
cbtemulator launches the in-memory Cloud Bigtable server on the given address.
|
cbtemulator launches the in-memory Cloud Bigtable server on the given address. |
cmd/loadtest
Loadtest does some load testing through the Go client library for Cloud Bigtable.
|
Loadtest does some load testing through the Go client library for Cloud Bigtable. |
cmd/scantest
Scantest does scan-related load testing against Cloud Bigtable.
|
Scantest does scan-related load testing against Cloud Bigtable. |
internal/cbtconfig
Package cbtconfig encapsulates common code for reading configuration from .cbtrc and gcloud.
|
Package cbtconfig encapsulates common code for reading configuration from .cbtrc and gcloud. |
internal/gax
Package gax is a snapshot from github.com/googleapis/gax-go with minor modifications.
|
Package gax is a snapshot from github.com/googleapis/gax-go with minor modifications. |
internal/option
Package option contains common code for dealing with client options.
|
Package option contains common code for dealing with client options. |
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.
|
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. |
cloudtasks
|
|
apiv2beta2
Package cloudtasks is an auto-generated package for the Cloud Tasks API.
|
Package cloudtasks is an auto-generated package for the Cloud Tasks API. |
apiv2beta3
Package cloudtasks is an auto-generated package for the Cloud Tasks API.
|
Package cloudtasks is an auto-generated package for the Cloud Tasks API. |
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.
|
Package breakpoints handles breakpoint requests we get from the user through the Debuglet Controller, and manages corresponding breakpoints set in the code. |
go-cloud-debug-agent/internal/controller
Package controller is a library for interacting with the Google Cloud Debugger's Debuglet Controller service.
|
Package controller is a library for interacting with the Google Cloud Debugger's Debuglet Controller service. |
go-cloud-debug-agent/internal/debug
Package debug provides the portable interface to a program being debugged.
|
Package debug provides the portable interface to a program being debugged. |
go-cloud-debug-agent/internal/debug/arch
Package arch contains architecture-specific definitions.
|
Package arch contains architecture-specific definitions. |
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
|
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 |
go-cloud-debug-agent/internal/debug/elf
Package elf implements access to ELF object files.
|
Package elf implements access to ELF object files. |
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.
|
Package gosym implements access to the Go symbol and line number tables embedded in Go binaries generated by the gc compilers. |
go-cloud-debug-agent/internal/debug/local
Package local provides access to a local program.
|
Package local provides access to a local program. |
go-cloud-debug-agent/internal/debug/remote
Package remote provides remote access to a debugproxy server.
|
Package remote provides remote access to a debugproxy server. |
go-cloud-debug-agent/internal/debug/server
Package server provides RPC access to a local program being debugged.
|
Package server provides RPC access to a local program being debugged. |
go-cloud-debug-agent/internal/debug/server/protocol
Package protocol defines the types used to represent calls to the debug server.
|
Package protocol defines the types used to represent calls to the debug server. |
go-cloud-debug-agent/internal/valuecollector
Package valuecollector is used to collect the values of variables in a program.
|
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.
|
Package metadata provides access to Google Compute Engine (GCE) metadata and API service accounts. |
Package container contains a deprecated Google Container Engine client.
|
Package container contains a deprecated Google Container Engine client. |
apiv1
Package container is an auto-generated package for the Google Container Engine API.
|
Package container is an auto-generated package for the Google Container Engine API. |
containeranalysis
|
|
apiv1beta1
Package containeranalysis is an auto-generated package for the Container Analysis API.
|
Package containeranalysis is an auto-generated package for the Container Analysis API. |
dataproc
|
|
apiv1
Package dataproc is an auto-generated package for the Google Cloud Dataproc API.
|
Package dataproc is an auto-generated package for the Google Cloud Dataproc API. |
apiv1beta2
Package dataproc is an auto-generated package for the Google Cloud Dataproc API.
|
Package dataproc is an auto-generated package for the Google Cloud Dataproc API. |
Package datastore provides a client for Google Cloud Datastore.
|
Package datastore provides a client for Google Cloud Datastore. |
debugger
|
|
apiv2
Package debugger is an auto-generated package for the Stackdriver Debugger API.
|
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.
|
Package dialogflow is an auto-generated package for the Dialogflow API. |
dlp
|
|
apiv2
Provides methods for detection, risk analysis, and de-identification of privacy-sensitive fragments in text, images, and Google Cloud Platform storage repositories.
|
Provides methods for detection, risk analysis, and de-identification of privacy-sensitive fragments in text, images, and Google Cloud Platform storage repositories. |
Package errorreporting is a Google Stackdriver Error Reporting library.
|
Package errorreporting is a Google Stackdriver Error Reporting library. |
apiv1beta1
Package errorreporting is an auto-generated package for the Stackdriver Error Reporting API.
|
Package errorreporting is an auto-generated package for the Stackdriver Error Reporting API. |
expr
|
|
apiv1alpha1
Package expr is an auto-generated package for the Common Expression Language.
|
Package expr is an auto-generated package for the Common Expression Language. |
Package firestore provides a client for reading and writing to a Cloud Firestore database.
|
Package firestore provides a client for reading and writing to a Cloud Firestore database. |
apiv1beta1
Package firestore is an auto-generated package for the Google Cloud Firestore API.
|
Package firestore is an auto-generated package for the Google Cloud Firestore API. |
functions
|
|
metadata
Package metadata provides methods for creating and accessing context.Context objects with Google Cloud Functions metadata.
|
Package metadata provides methods for creating and accessing context.Context objects with Google Cloud Functions metadata. |
Package httpreplay provides an API for recording and replaying traffic from HTTP-based Google API clients.
|
Package httpreplay provides an API for recording and replaying traffic from HTTP-based Google API clients. |
internal/proxy
Package proxy provides a record/replay HTTP proxy.
|
Package proxy provides a record/replay HTTP proxy. |
Package iam supports the resource-specific operations of Google Cloud IAM (Identity and Access Management) for the Google Cloud Libraries.
|
Package iam supports the resource-specific operations of Google Cloud IAM (Identity and Access Management) for the Google Cloud Libraries. |
admin/apiv1
Package admin is an auto-generated package for the Google Identity and Access Management (IAM) API.
|
Package admin is an auto-generated package for the Google Identity and Access Management (IAM) API. |
credentials/apiv1
Package credentials is an auto-generated package for the IAM Service Account Credentials API.
|
Package credentials is an auto-generated package for the IAM Service Account Credentials API. |
btree
Package btree implements in-memory B-Trees of arbitrary degree.
|
Package btree implements in-memory B-Trees of arbitrary degree. |
fields
Package fields provides a view of the fields of a struct that follows the Go rules, amended to consider tags and case insensitivity.
|
Package fields provides a view of the fields of a struct that follows the Go rules, amended to consider tags and case insensitivity. |
leakcheck
Package leakcheck contains functions to check leaked goroutines.
|
Package leakcheck contains functions to check leaked goroutines. |
optional
Package optional provides versions of primitive types that can be nil.
|
Package optional provides versions of primitive types that can be nil. |
pretty
Package pretty implements a simple pretty-printer.
|
Package pretty implements a simple pretty-printer. |
protostruct
Package protostruct supports operations on the protocol buffer Struct message.
|
Package protostruct supports operations on the protocol buffer Struct message. |
testutil
Package testutil contains helper functions for writing tests.
|
Package testutil contains helper functions for writing tests. |
tracecontext
Package tracecontext provides encoders and decoders for Stackdriver Trace contexts.
|
Package tracecontext provides encoders and decoders for Stackdriver Trace contexts. |
uid
Package uid supports generating unique IDs.
|
Package uid supports generating unique IDs. |
version
Package version contains version information for Google Cloud Client Libraries for Go, as reported in request headers.
|
Package version contains version information for Google Cloud Client Libraries for Go, as reported in request headers. |
kms
|
|
apiv1
Manages keys and performs cryptographic operations in a central cloud service, for direct use by other cloud resources and applications.
|
Manages keys and performs cryptographic operations in a central cloud service, for direct use by other cloud resources and applications. |
language
|
|
apiv1
Google Cloud Natural Language API provides natural language understanding technologies to developers.
|
Google Cloud Natural Language API provides natural language understanding technologies to developers. |
apiv1beta2
Package language is an auto-generated package for the Google Cloud Natural Language API.
|
Package language is an auto-generated package for the Google Cloud Natural Language API. |
Package logging contains a Stackdriver Logging client suitable for writing logs.
|
Package logging contains a Stackdriver Logging client suitable for writing logs. |
apiv2
Package logging is an auto-generated package for the Stackdriver Logging API.
|
Package logging is an auto-generated package for the Stackdriver Logging API. |
internal/testing
Package testing provides support for testing the logging client.
|
Package testing provides support for testing the logging client. |
logadmin
Package logadmin contains a Stackdriver Logging client that can be used for reading logs and working with sinks, metrics and monitored resources.
|
Package logadmin contains a Stackdriver Logging client that can be used for reading logs and working with sinks, metrics and monitored resources. |
Package longrunning supports Long Running Operations for the Google Cloud Libraries.
|
Package longrunning supports Long Running Operations for the Google Cloud Libraries. |
autogen
Package longrunning is an auto-generated package for the Google Long Running Operations API.
|
Package longrunning is an auto-generated package for the Google Long Running Operations API. |
monitoring
|
|
apiv3
Package monitoring is an auto-generated package for the Stackdriver Monitoring API.
|
Package monitoring is an auto-generated package for the Stackdriver Monitoring API. |
oslogin
|
|
apiv1
Package oslogin is an auto-generated package for the Google Cloud OS Login API.
|
Package oslogin is an auto-generated package for the Google Cloud OS Login API. |
apiv1beta
Package oslogin is an auto-generated package for the Google Cloud OS Login API.
|
Package oslogin is an auto-generated package for the Google Cloud OS Login API. |
Package profiler is a client for the Stackdriver Profiler service.
|
Package profiler is a client for the Stackdriver Profiler service. |
busybench
Busybench is a tool that runs a benchmark with the profiler enabled.
|
Busybench is a tool that runs a benchmark with the profiler enabled. |
mocks
Package mocks is a generated GoMock package.
|
Package mocks is a generated GoMock package. |
Package pubsub provides an easy way to publish and receive Google Cloud Pub/Sub messages, hiding the details of the underlying server RPCs.
|
Package pubsub provides an easy way to publish and receive Google Cloud Pub/Sub messages, hiding the details of the underlying server RPCs. |
apiv1
Package pubsub is an auto-generated package for the Google Cloud Pub/Sub API.
|
Package pubsub is an auto-generated package for the Google Cloud Pub/Sub API. |
loadtest
Package loadtest implements load testing for pubsub, following the interface defined in https://github.com/GoogleCloudPlatform/pubsub/tree/master/load-test-framework/ .
|
Package loadtest implements load testing for pubsub, following the interface defined in https://github.com/GoogleCloudPlatform/pubsub/tree/master/load-test-framework/ . |
loadtest/pb
Package google_pubsub_loadtest is a generated protocol buffer package.
|
Package google_pubsub_loadtest is a generated protocol buffer package. |
pstest
Package pstest provides a fake Cloud PubSub service for testing.
|
Package pstest provides a fake Cloud PubSub service for testing. |
redis
|
|
apiv1
The Google Cloud Memorystore for Redis API is used for creating and managing Redis instances on the Google Cloud Platform.
|
The Google Cloud Memorystore for Redis API is used for creating and managing Redis instances on the Google Cloud Platform. |
apiv1beta1
Package redis is an auto-generated package for the Google Cloud Memorystore for Redis API.
|
Package redis is an auto-generated package for the Google Cloud Memorystore for Redis API. |
Package rpcreplay supports the capture and replay of gRPC calls.
|
Package rpcreplay supports the capture and replay of gRPC calls. |
proto/intstore
Package intstore is a generated protocol buffer package.
|
Package intstore is a generated protocol buffer package. |
proto/rpcreplay
Package rpcreplay is a generated protocol buffer package.
|
Package rpcreplay is a generated protocol buffer package. |
scheduler
|
|
apiv1beta1
Package scheduler is an auto-generated package for the Cloud Scheduler API.
|
Package scheduler is an auto-generated package for the Cloud Scheduler API. |
securitycenter
|
|
apiv1beta1
Package securitycenter is an auto-generated package for the Cloud Security Command Center API.
|
Package securitycenter is an auto-generated package for the Cloud Security Command Center API. |
Package spanner provides a client for reading and writing to Cloud Spanner databases.
|
Package spanner provides a client for reading and writing to Cloud Spanner databases. |
admin/database/apiv1
Package database is an auto-generated package for the Cloud Spanner Database Admin API.
|
Package database is an auto-generated package for the Cloud Spanner Database Admin API. |
admin/instance/apiv1
Package instance is an auto-generated package for the Cloud Spanner Instance Admin API.
|
Package instance is an auto-generated package for the Cloud Spanner Instance Admin API. |
apiv1
Package spanner is an auto-generated package for the Cloud Spanner API.
|
Package spanner is an auto-generated package for the Cloud Spanner API. |
speech
|
|
apiv1
Converts audio to text by applying powerful neural network models.
|
Converts audio to text by applying powerful neural network models. |
apiv1p1beta1
Package speech is an auto-generated package for the Cloud Speech API.
|
Package speech is an auto-generated package for the Cloud Speech API. |
Package storage provides an easy way to work with Google Cloud Storage.
|
Package storage provides an easy way to work with Google Cloud Storage. |
texttospeech
|
|
apiv1
Package texttospeech is an auto-generated package for the Cloud Text-to-Speech API.
|
Package texttospeech is an auto-generated package for the Cloud Text-to-Speech API. |
Package trace is OBSOLETE.
|
Package trace is OBSOLETE. |
apiv1
Package trace is an auto-generated package for the Stackdriver Trace API.
|
Package trace is an auto-generated package for the Stackdriver Trace API. |
apiv2
Package trace is an auto-generated package for the Stackdriver Trace API.
|
Package trace is an auto-generated package for the Stackdriver Trace API. |
Package translate is a client for the Google Translation API.
|
Package translate is a client for the Google Translation API. |
internal/translate/v2
Package translate provides access to the Translate API.
|
Package translate provides access to the Translate API. |
videointelligence
|
|
apiv1
Package videointelligence is an auto-generated package for the Cloud Video Intelligence API.
|
Package videointelligence is an auto-generated package for the Cloud Video Intelligence API. |
apiv1beta1
Package videointelligence is an auto-generated package for the Google Cloud Video Intelligence API.
|
Package videointelligence is an auto-generated package for the Google Cloud Video Intelligence API. |
apiv1beta2
Package videointelligence is an auto-generated package for the Google Cloud Video Intelligence API.
|
Package videointelligence is an auto-generated package for the Google Cloud Video Intelligence API. |
vision
|
|
apiv1
Integrates Google Vision features, including image labeling, face, logo, and landmark detection, optical character recognition (OCR), and detection of explicit content, into applications.
|
Integrates Google Vision features, including image labeling, face, logo, and landmark detection, optical character recognition (OCR), and detection of explicit content, into applications. |
apiv1p1beta1
Package vision is an auto-generated package for the Google Cloud Vision API.
|
Package vision is an auto-generated package for the Google Cloud Vision API. |