package transport

import "google.golang.org/api/transport"

Package transport provides utility methods for creating authenticated transports to Google's HTTP and gRPC APIs. It is intended to be used in conjunction with google.golang.org/api/option.

This package is not intended for use by end developers. Use the google.golang.org/api/option package to configure API clients.

ctx := context.Background()

// Providing no auth option will cause NewClient to look for Application
// Default Creds as specified at https://godoc.org/golang.org/x/oauth2/google#FindDefaultCredentials.
//
// Note: Given the same set of options, transport.NewHTTPClient and
// transport.DialGRPC use the same credentials.
c, _, err := transport.NewHTTPClient(ctx)
if err != nil {
    log.Fatal(err)
}
_ = c // Use authenticated client.

ctx := context.Background()

// Download service account creds per https://cloud.google.com/docs/authentication/production.
//
// Note: Given the same set of options, transport.NewHTTPClient and
// transport.DialGRPC use the same credentials.
c, _, err := transport.NewHTTPClient(ctx, option.WithCredentialsFile("/path/to/service-account-creds.json"))
if err != nil {
    log.Fatal(err)
}
_ = c // Use authenticated client.

Index ¶

• func Creds(ctx context.Context, opts ...option.ClientOption) (*google.Credentials, error)
• func DialGRPC(ctx context.Context, opts ...option.ClientOption) (*grpc.ClientConn, error)
• func DialGRPCInsecure(ctx context.Context, opts ...option.ClientOption) (*grpc.ClientConn, error)
• func NewHTTPClient(ctx context.Context, opts ...option.ClientOption) (*http.Client, string, error)

Examples ¶

• package (ApplicationDefaultCredentials)
• package (WithCredentialsFile)

Package Files ¶

dial.go doc.go go19.go

func Creds ¶ Uses

func Creds(ctx context.Context, opts ...option.ClientOption) (*google.Credentials, error)

Creds constructs a google.Credentials from the information in the options, or obtains the default credentials in the same way as google.FindDefaultCredentials.

func DialGRPC ¶ Uses

func DialGRPC(ctx context.Context, opts ...option.ClientOption) (*grpc.ClientConn, error)

DialGRPC returns a GRPC connection for use communicating with a Google cloud service, configured with the given ClientOptions.

func DialGRPCInsecure ¶ Uses

func DialGRPCInsecure(ctx context.Context, opts ...option.ClientOption) (*grpc.ClientConn, error)

DialGRPCInsecure returns an insecure GRPC connection for use communicating with fake or mock Google cloud service implementations, such as emulators. The connection is configured with the given ClientOptions.

func NewHTTPClient ¶ Uses

func NewHTTPClient(ctx context.Context, opts ...option.ClientOption) (*http.Client, string, error)

NewHTTPClient returns an HTTP client for use communicating with a Google cloud service, configured with the given ClientOptions. It also returns the endpoint for the service as specified in the options.

Directories ¶