-
Notifications
You must be signed in to change notification settings - Fork 1.3k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
feat(storage): GA gRPC client #10859
Changes from 4 commits
48dce36
0705c92
2cfa055
a272d4a
8d33b70
3b17c65
41e3fcb
0b0172f
03cad2b
cf21027
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -331,14 +331,12 @@ to add a [custom audit logging] header: | |
// Use client as usual with the context and the additional headers will be sent. | ||
client.Bucket("my-bucket").Attrs(ctx) | ||
|
||
# Experimental gRPC API | ||
# gRPC API | ||
|
||
This package includes support for the Cloud Storage gRPC API, which is currently | ||
in preview. This implementation uses gRPC rather than the current JSON & XML | ||
APIs to make requests to Cloud Storage. Kindly contact the Google Cloud Storage gRPC | ||
team at [email protected] with a list of GCS buckets you would like to | ||
allowlist to access this API. The Go Storage gRPC library is not yet generally | ||
available, so it may be subject to breaking changes. | ||
This package includes support for the Cloud Storage gRPC API. The | ||
implementation uses gRPC rather than the current | ||
JSON & XML APIs to make requests to Cloud Storage. | ||
The Go Storage gRPC library is generally available. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. s/library/client. |
||
|
||
To create a client which will use gRPC, use the alternate constructor: | ||
|
||
|
@@ -349,11 +347,12 @@ To create a client which will use gRPC, use the alternate constructor: | |
} | ||
// Use client as usual. | ||
|
||
Using the gRPC API inside GCP with a bucket in the same region can allow for | ||
Direct Google Access (enabling requests to skip some proxy steps and reducing | ||
response latency). A warning is emmitted if gRPC is not used within GCP to | ||
warn that Direct Google Access could not be initialized. Direct Google Access | ||
is not required to access the gRPC API. | ||
Using the gRPC API inside GCP with a bucket in the same region can allow direct | ||
connectivity (enabling requests to skip Google Front Ends (GFEs) and reducing | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Google Front Ends is another term without public docs, I would revert to the original wording here and just add the link for the (new?) DP docs. No need to duplicate more information here. |
||
response latency) from compute to GCS. For more information see docs on [direct connectivity]. | ||
A warning is emmitted if gRPC is not used within GCP to warn that direct | ||
connectivity could not be initialized. Direct connectivity is not required | ||
to access the gRPC API. | ||
|
||
Dependencies for the gRPC API may slightly increase the size of binaries for | ||
applications depending on this package. If you are not using gRPC, you can use | ||
|
@@ -409,5 +408,6 @@ client, which is available as a subpackage in this module. See package docs at | |
[custom audit logging]: https://cloud.google.com/storage/docs/audit-logging#add-custom-metadata | ||
[Storage Control API]: https://cloud.google.com/storage/docs/reference/rpc/google.storage.control.v2 | ||
[metric explorer]: https://console.cloud.google.com/projectselector/monitoring/metrics-explorer | ||
[direct connectivity]: https://cloud.google.com/vpc-service-controls/docs/set-up-private-connectivity#direct-connectivity | ||
*/ | ||
package storage // import "cloud.google.com/go/storage" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
s/current/default