b22c6b7a4e
Adds READMEs and enforces vendor is done at repository root Signed-off-by: Derek McGowan <derek@mcgstyle.net>
136 lines
4.7 KiB
Markdown
136 lines
4.7 KiB
Markdown
# Google Cloud for Go
|
|
|
|
[](https://travis-ci.org/GoogleCloudPlatform/gcloud-golang)
|
|
|
|
**NOTE:** These packages are experimental, and may occasionally make
|
|
backwards-incompatible changes.
|
|
|
|
**NOTE:** Github repo is a mirror of [https://code.googlesource.com/gocloud](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
|
|
|
|
``` go
|
|
import "google.golang.org/cloud"
|
|
```
|
|
|
|
Documentation and examples are available at
|
|
[https://godoc.org/google.golang.org/cloud](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](https://godoc.org/golang.org/x/oauth2)
|
|
for examples on using oauth2 with the Cloud package.
|
|
|
|
## Google Cloud Datastore
|
|
|
|
[Google Cloud Datastore][cloud-datastore] ([docs][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][cloud-datastore-activation] to use the Google
|
|
Cloud Datastore API with your project.
|
|
|
|
[https://godoc.org/google.golang.org/cloud/datastore](https://godoc.org/google.golang.org/cloud/datastore)
|
|
|
|
|
|
```go
|
|
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][cloud-storage] ([docs][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](https://godoc.org/google.golang.org/cloud/storage)
|
|
|
|
|
|
```go
|
|
// 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][cloud-pubsub] ([docs][cloud-pubsub-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](https://godoc.org/google.golang.org/cloud/pubsub)
|
|
|
|
|
|
```go
|
|
// 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](https://github.com/GoogleCloudPlatform/gcloud-golang/blob/master/CONTRIBUTING.md)
|
|
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](https://github.com/GoogleCloudPlatform/gcloud-golang/blob/master/CONTRIBUTING.md#contributor-code-of-conduct)
|
|
for more information.
|
|
|
|
[cloud-datastore]: https://cloud.google.com/datastore/
|
|
[cloud-datastore-docs]: https://cloud.google.com/datastore/docs
|
|
[cloud-datastore-activation]: https://cloud.google.com/datastore/docs/activate
|
|
|
|
[cloud-pubsub]: https://cloud.google.com/pubsub/
|
|
[cloud-pubsub-docs]: https://cloud.google.com/pubsub/docs
|
|
|
|
[cloud-storage]: https://cloud.google.com/storage/
|
|
[cloud-storage-docs]: https://cloud.google.com/storage/docs/overview
|
|
[cloud-storage-create-bucket]: https://cloud.google.com/storage/docs/cloud-console#_creatingbuckets
|