gcp

Documentation

Overview

Package gcp provides fundamental Wire providers and types for Google Cloud Platform (GCP).

Index

• Variables
• func DefaultCredentials(ctx context.Context) (*google.Credentials, error)
• func DefaultTransport() http.RoundTripper
• type HTTPClient
  • func NewAnonymousHTTPClient(transport http.RoundTripper) *HTTPClient
  • func NewHTTPClient(transport http.RoundTripper, ts TokenSource) (*HTTPClient, error)
• type ProjectID
  • func DefaultProjectID(creds *google.Credentials) (ProjectID, error)
• type TokenSource
  • func CredentialsTokenSource(creds *google.Credentials) TokenSource

Variables

var DefaultIdentity = wire.NewSet(
	CredentialsTokenSource,
	DefaultCredentials,
	DefaultProjectID)

DefaultIdentity is a Wire provider set that provides the project ID and token source from Application Default Credentials (ADC).

Functions

func DefaultCredentials

func DefaultCredentials(ctx context.Context) (*google.Credentials, error)

DefaultCredentials obtains the default GCP credentials with Cloud Platform scope.

func DefaultTransport

func DefaultTransport() http.RoundTripper

DefaultTransport returns http.DefaultTransport.

Types

type HTTPClient

type HTTPClient struct {
	http.Client
}

HTTPClient is an HTTP client that makes requests authenticated with Cloud- Platform-scoped authentication tokens.

func NewAnonymousHTTPClient

func NewAnonymousHTTPClient(transport http.RoundTripper) *HTTPClient

NewAnonymousHTTPClient creates a new anonymous HTTP client.

func NewHTTPClient

func NewHTTPClient(transport http.RoundTripper, ts TokenSource) (*HTTPClient, error)

NewHTTPClient creates a new authenticated HTTP client.

type ProjectID

type ProjectID string

ProjectID is a GCP Project ID.

func DefaultProjectID

func DefaultProjectID(creds *google.Credentials) (ProjectID, error)

DefaultProjectID obtains the project ID from the default GCP credentials.

type TokenSource

type TokenSource oauth2.TokenSource

TokenSource wraps a GCP token source that provides Cloud-Platform- scoped tokens.

func CredentialsTokenSource

func CredentialsTokenSource(creds *google.Credentials) TokenSource

CredentialsTokenSource extracts the token source from GCP credentials.