Skip to content

Commit c7a55a2

Browse files
frankyntritone
andauthored
feat(storage): GA gRPC client (#10859)
* docs(storage): update docs on gRPC availability * clean up long lines * update to GA * address comments * gofmt doc.go --------- Co-authored-by: Chris Cotter <[email protected]>
1 parent 9e964dd commit c7a55a2

File tree

1 file changed

+9
-10
lines changed

1 file changed

+9
-10
lines changed

storage/doc.go

+9-10
Original file line numberDiff line numberDiff line change
@@ -331,16 +331,14 @@ to add a [custom audit logging] header:
331331
// Use client as usual with the context and the additional headers will be sent.
332332
client.Bucket("my-bucket").Attrs(ctx)
333333
334-
# Experimental gRPC API
334+
# gRPC API
335335
336-
This package includes support for the Cloud Storage gRPC API, which is currently
337-
in preview. This implementation uses gRPC rather than the current JSON & XML
338-
APIs to make requests to Cloud Storage. The Notifications, Serivce Account HMAC
336+
This package includes support for the Cloud Storage gRPC API. The
337+
implementation uses gRPC rather than the Default
338+
JSON & XML APIs to make requests to Cloud Storage.
339+
The Go Storage gRPC client is generally available.
340+
The Notifications, Serivce Account HMAC
339341
and GetServiceAccount RPCs are not supported through the gRPC client.
340-
Kindly contact the Google Cloud Storage gRPC
341-
team at [email protected] with a list of GCS buckets you would like to
342-
allowlist to access this API. The Go Storage gRPC library is not yet generally
343-
available, so it may be subject to breaking changes.
344342
345343
To create a client which will use gRPC, use the alternate constructor:
346344
@@ -352,9 +350,9 @@ To create a client which will use gRPC, use the alternate constructor:
352350
// Use client as usual.
353351
354352
Using the gRPC API inside GCP with a bucket in the same region can allow for
355-
Direct Google Access (enabling requests to skip some proxy steps and reducing
353+
[Direct Connectivity] (enabling requests to skip some proxy steps and reducing
356354
response latency). A warning is emmitted if gRPC is not used within GCP to
357-
warn that Direct Google Access could not be initialized. Direct Google Access
355+
warn that Direct Connectivity could not be initialized. Direct Connectivity
358356
is not required to access the gRPC API.
359357
360358
Dependencies for the gRPC API may slightly increase the size of binaries for
@@ -411,5 +409,6 @@ client, which is available as a subpackage in this module. See package docs at
411409
[custom audit logging]: https://cloud.google.com/storage/docs/audit-logging#add-custom-metadata
412410
[Storage Control API]: https://cloud.google.com/storage/docs/reference/rpc/google.storage.control.v2
413411
[metric explorer]: https://console.cloud.google.com/projectselector/monitoring/metrics-explorer
412+
[Direct Connectivity]: https://cloud.google.com/vpc-service-controls/docs/set-up-private-connectivity#direct-connectivity
414413
*/
415414
package storage // import "cloud.google.com/go/storage"

0 commit comments

Comments
 (0)