commit | 8003513d75d7416e63cfc550df055ab35a3a6c38 | [log] [tgz] |
---|---|---|
author | Seth Hollyman <shollyman@google.com> | Fri Jan 17 18:08:32 2020 +0000 |
committer | Seth Hollyman <shollyman@google.com> | Fri Jan 17 22:14:48 2020 +0000 |
tree | e4f0372d6bf3aab6221c31147ec96660850cbf2f | |
parent | d513fbfc76a1c1673b8c6084a125e657a5981325 [diff] |
gapicgen: simplify setup and documentation. The cookie name used for gerrit authentication is standard, and so this change sets the default to that value ("o") and removes references to it in documentation. This PR also attempts to clarify what the relevant auth token from Gerrit code review looks like in the documentation, in hopes that future users don't get tripped on this as much. Change-Id: Ied4f780f1246b4269ba3f9c48e6958ec57593687 Reviewed-on: https://code-review.googlesource.com/c/gocloud/+/50611 Reviewed-by: kokoro <noreply+kokoro@google.com> Reviewed-by: Alex Hong <hongalex@google.com>
Go packages for Google Cloud Platform services.
import "cloud.google.com/go"
To install the packages on your system, do not clone the repo. Instead:
Change to your project directory:
cd /my/cloud/project
Get the package you want to use. Some products have their own module, so it's best to go get
the package(s) you want to use:
$ go get cloud.google.com/go/firestore # Replace with the package you want to use.
NOTE: Some of these packages are under development, and may occasionally make backwards-incompatible changes.
NOTE: Github repo is a mirror of https://code.googlesource.com/gocloud.
Alpha status: the API is still being actively developed. As a result, it might change in backward-incompatible ways and is not recommended for production use.
Beta status: the API is largely complete, but still has outstanding features and bugs to be addressed. There may be minor backwards-incompatible changes where necessary.
Stable status: the API is mature and ready for production use. We will continue addressing bugs and feature requests.
Documentation and examples are available at godoc.org/cloud.google.com/go
We support the two most recent major versions of Go. If Google App Engine uses an older version, we support that as well.
By default, each API will use Google Application Default Credentials for authorization credentials used in calling the API endpoints. This will allow your application to run in many environments without requiring explicit configuration.
client, err := storage.NewClient(ctx)
To authorize using a JSON key file, pass option.WithCredentialsFile
to the NewClient
function of the desired package. For example:
client, err := storage.NewClient(ctx, option.WithCredentialsFile("path/to/keyfile.json"))
You can exert more control over authorization by using the golang.org/x/oauth2
package to create an oauth2.TokenSource
. Then pass option.WithTokenSource
to the NewClient
function: snip:# (auth-ts)
tokenSource := ...
client, err := storage.NewClient(ctx, option.WithTokenSource(tokenSource))
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.