The highest tagged major version is
README
¶
Google API Extensions for Go
Google API Extensions for Go (gax-go) is a set of modules which aids the
development of APIs for clients and servers based on gRPC and Google API
conventions.
To install the API extensions, use:
go get -u github.com/googleapis/gax-go
Note: Application code will rarely need to use this library directly, but the code generated automatically from API definition files can use it to simplify code generation and to provide more convenient and idiomatic API surface.
Go Versions
This library requires Go 1.6 or above.
License
BSD - please see LICENSE for more information.
Documentation
¶
Overview ¶
Package gax contains a set of modules which aid the development of APIs for clients and servers based on gRPC and Google API conventions.
Application code will rarely need to use this library directly. However, code generated automatically from API definition files can use it to simplify code generation and to provide more convenient and idiomatic API surfaces.
Index ¶
Constants ¶
const Version = "1.0.1"
Version specifies the gax version.
Variables ¶
This section is empty.
Functions ¶
func Invoke ¶
func Invoke(ctx context.Context, call APICall, opts ...CallOption) error
Invoke calls the given APICall, performing retries as specified by opts, if any.
func Sleep ¶
Sleep is similar to time.Sleep, but it can be interrupted by ctx.Done() closing. If interrupted, Sleep returns ctx.Err().
func XGoogHeader ¶
XGoogHeader is for use by the Google Cloud Libraries only.
XGoogHeader formats key-value pairs. The resulting string is suitable for x-goog-api-client header.
Types ¶
type Backoff ¶
Backoff implements exponential backoff. The wait time between retries is a random value between 0 and the "retry envelope". The envelope starts at Initial and increases by the factor of Multiplier every retry, but is capped at Max.
type CallOption ¶
type CallOption = v2.CallOption
CallOption is an option used by Invoke to control behaviors of RPC calls. CallOption works by modifying relevant fields of CallSettings.
func WithGRPCOptions ¶
func WithGRPCOptions(opt ...grpc.CallOption) CallOption
WithGRPCOptions allows passing gRPC call options during client creation.
func WithRetry ¶
func WithRetry(fn func() Retryer) CallOption
WithRetry sets CallSettings.Retry to fn.
type CallSettings ¶
type CallSettings = v2.CallSettings
CallSettings allow fine-grained control over how calls are made.
type Retryer ¶
Retryer is used by Invoke to determine retry behavior.
Source Files