internal
packageThis package is not in the latest version of its module.
Details
Validgo.mod file
The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license
Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version
Modules with tagged versions give importers more predictable builds.
Stable version
When a project reaches major version v1 it is considered stable.
- Learn more about best practices
Repository
Links
README¶
Internal
This directory contains internal code for cloud.google.com/go packages.
.repo-metadata-full.json
.repo-metadata-full.json contains metadata about the packages in this repo. Itis generated byinternal/gapicgen/generator. It's processed by external toolsto build lists of all of the packages.
Don't make breaking changes to the format without consulting with the externaltools.
One day, we may want to create individual.repo-metadata.json files next toeach package, which is the pattern followed by some other languages. Externaltools would then talk to pkg.go.dev or some other service to get the overalllist of packages and use the.repo-metadata.json files to get the additionalmetadata required. For now,.repo-metadata-full.json includes everything.
Updating OwlBot SHA
You may want to manually update the which version of the post-processor will beused -- to do this you need to update the SHA in the OwlBot lock file.
See thepostprocessor/README for detailedinstructions.
Note: OwlBot will eventually open a pull request to update this value if itdiscovers a new version of the container.
Documentation¶
Index¶
Constants¶
This section is empty.
Variables¶
This section is empty.
Functions¶
funcAnnotate¶added inv0.17.0
Annotate prepends msg to the error message in err, attemptingto preserve other information in err, like an error code.
Annotate panics if err is nil.
Annotate knows about these error types:- "google.golang.org/grpc/status".Status- "google.golang.org/api/googleapi".ErrorIf the error is not one of these types, Annotate behaveslike
fmt.Errorf("%s: %v", msg, err)funcAnnotatef¶added inv0.17.0
Annotatef uses format and args to format a string, then calls Annotate.
funcRetry¶added inv0.5.0
Retry calls the supplied function f repeatedly according to the providedbackoff parameters. It returns when one of the following occurs:When f's first return value is true, Retry immediately returns with f's secondreturn value.When the provided context is done, Retry returns with an error thatincludes both ctx.Error() and the last error returned by f.
Types¶
This section is empty.
Directories¶
| Path | Synopsis |
|---|---|
aliasfixmodule | |
aliasgenmodule | |
Package btree implements in-memory B-Trees of arbitrary degree. | Package btree implements in-memory B-Trees of arbitrary degree. |
Package detect is used find information from the environment. | Package detect is used find information from the environment. |
examples | |
fakemodule | |
mockmodule | |
Package fields provides a view of the fields of a struct that follows the Go rules, amended to consider tags and case insensitivity. | Package fields provides a view of the fields of a struct that follows the Go rules, amended to consider tags and case insensitivity. |
gapicgenmodule | |
gensnippetsmodule | |
godocfxmodule | |
Package leakcheck contains functions to check leaked goroutines. | Package leakcheck contains functions to check leaked goroutines. |
Package optional provides versions of primitive types that can be nil. | Package optional provides versions of primitive types that can be nil. |
postprocessormodule | |
Package pretty implements a simple pretty-printer. | Package pretty implements a simple pretty-printer. |
Package protostruct supports operations on the protocol buffer Struct message. | Package protostruct supports operations on the protocol buffer Struct message. |
stategenmodule | |
Package testutil contains helper functions for writing tests. | Package testutil contains helper functions for writing tests. |
Package tracecontext provides encoders and decoders for Stackdriver Trace contexts. | Package tracecontext provides encoders and decoders for Stackdriver Trace contexts. |
Package uid supports generating unique IDs. | Package uid supports generating unique IDs. |
Package version contains version information for Google Cloud Client Libraries for Go, as reported in request headers. | Package version contains version information for Google Cloud Client Libraries for Go, as reported in request headers. |