internal

Documentation

Overview

Package internal supports the options and transport packages.

Package internal supports the options and transport packages.

Index

• Constants
• func Creds(ctx context.Context, ds *DialSettings) (*google.Credentials, error)
• func ErrUniverseNotMatch(settingsUD, credsUD string) error
• func GetGRPCTransportConfigAndEndpoint(settings *DialSettings) (credentials.TransportCredentials, string, error)
• func GetHTTPTransportConfigAndEndpoint(settings *DialSettings) (cert.Source, func(context.Context, string, string) (net.Conn, error), string, ...)
• func GetQuotaProject(creds *google.Credentials, clientOpt string) string
• func GetS2AAddress() string
• func GetUniverseDomain(creds *google.Credentials) (string, error)
• type ConnPool
• type DialSettings
  • func (ds *DialSettings) GetAudience() string
  • func (ds *DialSettings) GetDefaultUniverseDomain() string
  • func (ds *DialSettings) GetScopes() []string
  • func (ds *DialSettings) GetUniverseDomain() string
  • func (ds *DialSettings) HasCustomAudience() bool
  • func (ds *DialSettings) IsNewAuthLibraryEnabled() bool
  • func (ds *DialSettings) IsUniverseDomainGDU() bool
  • func (ds *DialSettings) Validate() error

Constants

const Version = "0.163.0"

Version is the current tagged release of the library.

Functions

func Creds

func Creds(ctx context.Context, ds *DialSettings) (*google.Credentials, error)

Creds returns credential information obtained from DialSettings, or if none, then it returns default credential information.

func ErrUniverseNotMatch

func ErrUniverseNotMatch(settingsUD, credsUD string) error

ErrUniverseNotMatch composes an error string from the provided universe domain sources (DialSettings and Credentials, respectively).

func GetGRPCTransportConfigAndEndpoint

func GetGRPCTransportConfigAndEndpoint(settings *DialSettings) (credentials.TransportCredentials, string, error)

GetGRPCTransportConfigAndEndpoint returns an instance of credentials.TransportCredentials, and the corresponding endpoint to use for GRPC client.

func GetHTTPTransportConfigAndEndpoint

func GetHTTPTransportConfigAndEndpoint(settings *DialSettings) (cert.Source, func(context.Context, string, string) (net.Conn, error), string, error)

GetHTTPTransportConfigAndEndpoint returns a client certificate source, a function for dialing MTLS with S2A, and the endpoint to use for HTTP client.

func GetQuotaProject

func GetQuotaProject(creds *google.Credentials, clientOpt string) string

GetQuotaProject retrieves quota project with precedence being: client option, environment variable, creds file.

func GetS2AAddress

func GetS2AAddress() string

GetS2AAddress returns the S2A address to be reached via plaintext connection.

func GetUniverseDomain

func GetUniverseDomain(creds *google.Credentials) (string, error)

GetUniverseDomain returns the default service domain for a given Cloud universe, from google.Credentials, for comparison with the value returned by (*DialSettings).GetUniverseDomain. This wrapper function should be removed to close [TODO(chrisdsmith): issue link here]. See details below.

Types

type ConnPool

type ConnPool interface {
	// Conn returns a ClientConn from the pool.
	//
	// Conns aren't returned to the pool.
	Conn() *grpc.ClientConn

	// Num returns the number of connections in the pool.
	//
	// It will always return the same value.
	Num() int

	// Close closes every ClientConn in the pool.
	//
	// The error returned by Close may be a single error or multiple errors.
	Close() error

	// ConnPool implements grpc.ClientConnInterface to enable it to be used directly with generated proto stubs.
	grpc.ClientConnInterface
}

ConnPool is a pool of grpc.ClientConns.

type DialSettings

type DialSettings struct {
	Endpoint                      string
	DefaultEndpoint               string
	DefaultEndpointTemplate       string
	DefaultMTLSEndpoint           string
	Scopes                        []string
	DefaultScopes                 []string
	EnableJwtWithScope            bool
	TokenSource                   oauth2.TokenSource
	Credentials                   *google.Credentials
	CredentialsFile               string // if set, Token Source is ignored.
	CredentialsJSON               []byte
	InternalCredentials           *google.Credentials
	UserAgent                     string
	APIKey                        string
	Audiences                     []string
	DefaultAudience               string
	HTTPClient                    *http.Client
	GRPCDialOpts                  []grpc.DialOption
	GRPCConn                      *grpc.ClientConn
	GRPCConnPool                  ConnPool
	GRPCConnPoolSize              int
	NoAuth                        bool
	TelemetryDisabled             bool
	ClientCertSource              func(*tls.CertificateRequestInfo) (*tls.Certificate, error)
	CustomClaims                  map[string]interface{}
	SkipValidation                bool
	ImpersonationConfig           *impersonate.Config
	EnableDirectPath              bool
	EnableDirectPathXds           bool
	EnableNewAuthLibrary          bool
	AllowNonDefaultServiceAccount bool
	UniverseDomain                string
	DefaultUniverseDomain         string

	// Google API system parameters. For more information please read:
	// https://cloud.google.com/apis/docs/system-parameters
	QuotaProject  string
	RequestReason string
}

DialSettings holds information needed to establish a connection with a Google API service.

func (*DialSettings) GetAudience

func (ds *DialSettings) GetAudience() string

GetAudience returns the user-provided audience, if set, or else falls back to the default audience.

func (*DialSettings) GetDefaultUniverseDomain

func (ds *DialSettings) GetDefaultUniverseDomain() string

GetDefaultUniverseDomain returns the default service domain for a given Cloud universe, as configured with internaloption.WithDefaultUniverseDomain. The default value is "googleapis.com".

func (*DialSettings) GetScopes

func (ds *DialSettings) GetScopes() []string

GetScopes returns the user-provided scopes, if set, or else falls back to the default scopes.

func (*DialSettings) GetUniverseDomain

func (ds *DialSettings) GetUniverseDomain() string

GetUniverseDomain returns the default service domain for a given Cloud universe, as configured with option.WithUniverseDomain. The default value is the value of GetDefaultUniverseDomain, as configured with internaloption.WithDefaultUniverseDomain.

func (*DialSettings) HasCustomAudience

func (ds *DialSettings) HasCustomAudience() bool

HasCustomAudience returns true if a custom audience is provided by users.

func (*DialSettings) IsNewAuthLibraryEnabled

func (ds *DialSettings) IsNewAuthLibraryEnabled() bool

func (*DialSettings) IsUniverseDomainGDU

func (ds *DialSettings) IsUniverseDomainGDU() bool

func (*DialSettings) Validate

func (ds *DialSettings) Validate() error

Validate reports an error if ds is invalid.