cloud

package
v2.3.0-alpha+incompatible Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jan 11, 2016 License: Apache-2.0, Apache-2.0 Imports: 6 Imported by: 0

README

Google Cloud for Go

Build Status

NOTE: These packages are experimental, and may occasionally make backwards-incompatible changes.

NOTE: Github repo is a mirror of https://code.googlesource.com/gocloud.

Go packages for Google Cloud Platform services. Supported APIs include:

  • Google Cloud Datastore
  • Google Cloud Storage
  • Google Cloud Pub/Sub
  • Google Cloud Container Engine
import "google.golang.org/cloud"

Documentation and examples are available at https://godoc.org/google.golang.org/cloud.

Authorization

Authorization, throughout the package, is delegated to the godoc.org/golang.org/x/oauth2. Refer to the godoc documentation for examples on using oauth2 with the Cloud package.

Google Cloud Datastore

Google Cloud Datastore (docs) is a fully managed, schemaless database for storing non-relational data. Cloud Datastore automatically scales with your users and supports ACID transactions, high availability of reads and writes, strong consistency for reads and ancestor queries, and eventual consistency for all other queries.

Follow the activation instructions to use the Google Cloud Datastore API with your project.

https://godoc.org/google.golang.org/cloud/datastore

type Post struct {
	Title       string
	Body        string `datastore:",noindex"`
	PublishedAt time.Time
}
keys := []*datastore.Key{
	datastore.NewKey(ctx, "Post", "post1", 0, nil),
	datastore.NewKey(ctx, "Post", "post2", 0, nil),
}
posts := []*Post{
	{Title: "Post 1", Body: "...", PublishedAt: time.Now()},
	{Title: "Post 2", Body: "...", PublishedAt: time.Now()},
}
if _, err := datastore.PutMulti(ctx, keys, posts); err != nil {
	log.Println(err)
}

Google Cloud Storage

Google Cloud Storage (docs) allows you to store data on Google infrastructure with very high reliability, performance and availability, and can be used to distribute large data objects to users via direct download.

https://godoc.org/google.golang.org/cloud/storage

// Read the object1 from bucket.
rc, err := storage.NewReader(ctx, "bucket", "object1")
if err != nil {
	log.Fatal(err)
}
slurp, err := ioutil.ReadAll(rc)
rc.Close()
if err != nil {
	log.Fatal(err)
}

Google Cloud Pub/Sub (Alpha)

Google Cloud Pub/Sub is in Alpha status. As a result, it might change in backward-incompatible ways and is not recommended for production use. It is not subject to any SLA or deprecation policy.

Google Cloud Pub/Sub (docs) allows you to connect your services with reliable, many-to-many, asynchronous messaging hosted on Google's infrastructure. Cloud Pub/Sub automatically scales as you need it and provides a foundation for building your own robust, global services.

https://godoc.org/google.golang.org/cloud/pubsub

// Publish "hello world" on topic1.
msgIDs, err := pubsub.Publish(ctx, "topic1", &pubsub.Message{
	Data: []byte("hello world"),
})
if err != nil {
	log.Println(err)
}
// Pull messages via subscription1.
msgs, err := pubsub.Pull(ctx, "subscription1", 1)
if err != nil {
	log.Println(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.

Documentation

Overview

Package cloud contains Google Cloud Platform APIs related types and common functions.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func NewContext

func NewContext(projID string, c *http.Client) context.Context

NewContext returns a new context that uses the provided http.Client. Provided http.Client is responsible to authorize and authenticate the requests made to the Google Cloud APIs. It mutates the client's original Transport to append the cloud package's user-agent to the outgoing requests. You can obtain the project ID from the Google Developers Console, https://console.developers.google.com.

func WithContext

func WithContext(parent context.Context, projID string, c *http.Client) context.Context

WithContext returns a new context in a similar way NewContext does, but initiates the new context with the specified parent.

Types

type ClientOption

type ClientOption interface {
	// Resolve configures the given DialOpts for this option.
	Resolve(*opts.DialOpt)
}

ClientOption is used when construct clients for each cloud service.

func WithBaseGRPC

func WithBaseGRPC(client *grpc.ClientConn) ClientOption

WithBaseGRPC returns a ClientOption that specifies the GRPC client connection to use as the basis of communications. This option many only be used with services that support HRPC as their communication transport.

func WithBaseHTTP

func WithBaseHTTP(client *http.Client) ClientOption

WithBaseHTTP returns a ClientOption that specifies the HTTP client to use as the basis of communications. This option may only be used with services that support HTTP as their communication transport.

func WithEndpoint

func WithEndpoint(url string) ClientOption

WithEndpoint returns a ClientOption that overrides the default endpoint to be used for a service.

func WithScopes

func WithScopes(scope ...string) ClientOption

WithScopes returns a ClientOption that overrides the default OAuth2 scopes to be used for a service.

func WithTokenSource

func WithTokenSource(s oauth2.TokenSource) ClientOption

WithTokenSource returns a ClientOption that specifies an OAuth2 token source to be used as the basis for authentication.

func WithUserAgent

func WithUserAgent(ua string) ClientOption

WithUserAgent returns a ClientOption that sets the User-Agent.

Directories

Path Synopsis
Package bigquery provides a client for the BigQuery service.
Package bigquery provides a client for the BigQuery service.
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/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.
internal/cbtrc
Package cbtrc encapsulates common code for reading .cbtrc files.
Package cbtrc encapsulates common code for reading .cbtrc files.
internal/cluster_data_proto
Package google_bigtable_admin_cluster_v1 is a generated protocol buffer package.
Package google_bigtable_admin_cluster_v1 is a generated protocol buffer package.
internal/cluster_service_proto
Package google_bigtable_admin_cluster_v1 is a generated protocol buffer package.
Package google_bigtable_admin_cluster_v1 is a generated protocol buffer package.
internal/data_proto
Package google_bigtable_v1 is a generated protocol buffer package.
Package google_bigtable_v1 is a generated protocol buffer package.
internal/duration_proto
Package google_protobuf is a generated protocol buffer package.
Package google_protobuf is a generated protocol buffer package.
internal/empty
Package google_protobuf is a generated protocol buffer package.
Package google_protobuf is a generated protocol buffer package.
internal/service_proto
Package google_bigtable_v1 is a generated protocol buffer package.
Package google_bigtable_v1 is a generated protocol buffer package.
internal/table_data_proto
Package google_bigtable_admin_table_v1 is a generated protocol buffer package.
Package google_bigtable_admin_table_v1 is a generated protocol buffer package.
internal/table_service_proto
Package google_bigtable_admin_table_v1 is a generated protocol buffer package.
Package google_bigtable_admin_table_v1 is a generated protocol buffer package.
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 Google Container Engine client.
Package container contains a Google Container Engine client.
Package datastore contains a Google Cloud Datastore client.
Package datastore contains a Google Cloud Datastore client.
examples
bigquery/concat_table
concat_table is an example client of the bigquery client library.
concat_table is an example client of the bigquery client library.
bigquery/load
load is an example client of the bigquery client library.
load is an example client of the bigquery client library.
bigquery/query
query is an example client of the bigquery client library.
query is an example client of the bigquery client library.
bigquery/read
read is an example client of the bigquery client library.
read is an example client of the bigquery client library.
bigtable/bigtable-hello
helloworld tracks how often a user has visited the index page.
helloworld tracks how often a user has visited the index page.
bigtable/search
This is a sample web server that uses Cloud Bigtable as the storage layer for a simple document-storage and full-text-search service.
This is a sample web server that uses Cloud Bigtable as the storage layer for a simple document-storage and full-text-search service.
pubsub/cmdline
Package main contains a simple command line tool for Cloud Pub/Sub Cloud Pub/Sub docs: https://cloud.google.com/pubsub/docs
Package main contains a simple command line tool for Cloud Pub/Sub Cloud Pub/Sub docs: https://cloud.google.com/pubsub/docs
storage/appengine
Package gcsdemo is an example App Engine app using the Google Cloud Storage API.
Package gcsdemo is an example App Engine app using the Google Cloud Storage API.
storage/appenginevm
Package main is an example Mananged VM app using the Google Cloud Storage API.
Package main is an example Mananged VM app using the Google Cloud Storage API.
Package internal provides support for the cloud packages.
Package internal provides support for the cloud packages.
datastore
Package datastore is a generated protocol buffer package.
Package datastore is a generated protocol buffer package.
opts
Package opts holds the DialOpts struct, configurable by cloud.ClientOptions to set up transports for cloud packages.
Package opts holds the DialOpts struct, configurable by cloud.ClientOptions to set up transports for cloud packages.
testutil
Package testutil contains helper functions for writing tests.
Package testutil contains helper functions for writing tests.
Package logging contains a Google Cloud Logging client.
Package logging contains a Google Cloud Logging client.
Package pubsub contains a Google Cloud Pub/Sub client.
Package pubsub contains a Google Cloud Pub/Sub client.
Package storage contains a Google Cloud Storage client.
Package storage contains a Google Cloud Storage client.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL