internaloption

Documentation

Overview

Package internaloption contains options used internally by Google client code.

Index

• func AllowNonDefaultServiceAccount(nd bool) option.ClientOption
• func AuthCreds(ctx context.Context, opts []option.ClientOption) (*auth.Credentials, error)
• func EnableAsyncRefreshDryRun(errHandler func()) option.ClientOption
• func EnableDirectPath(dp bool) option.ClientOption
• func EnableDirectPathXds() option.ClientOption
• func EnableJwtWithScope() option.ClientOption
• func EnableNewAuthLibrary() option.ClientOption
• func GetLogger(opts []option.ClientOption) *slog.Logger
• func SkipDialSettingsValidation() option.ClientOption
• func WithCredentials(creds *google.Credentials) option.ClientOption
• func WithDefaultAudience(audience string) option.ClientOption
• func WithDefaultEndpoint(url string) option.ClientOption
• func WithDefaultEndpointTemplate(url string) option.ClientOption
• func WithDefaultMTLSEndpoint(url string) option.ClientOption
• func WithDefaultScopes(scope ...string) option.ClientOption
• func WithDefaultUniverseDomain(ud string) option.ClientOption
• type EmbeddableAdapter
  • func (*EmbeddableAdapter) Apply(_ *internal.DialSettings)

Examples

• EmbeddableAdapter

Functions

func AllowNonDefaultServiceAccount

func AllowNonDefaultServiceAccount(nd bool) option.ClientOption

AllowNonDefaultServiceAccount returns a ClientOption that overrides the default requirement for using the default service account for DirectPath.

It should only be used internally by generated clients. This is an EXPERIMENTAL API and may be changed or removed in the future.

func AuthCreds

func AuthCreds(ctx context.Context, opts []option.ClientOption) (*auth.Credentials, error)

AuthCreds returns cloud.google.com/go/auth.Credentials using the following options provided via option.ClientOption, including legacy oauth2/google options, in this order:

* option.WithAuthCredentials * option/internaloption.WithCredentials (internal use only) * option.WithCredentials * option.WithTokenSource

If there are no applicable credentials options, then it passes the following options to cloud.google.com/go/auth/credentials.DetectDefault and returns the result:

* option.WithAudiences * option.WithCredentialsFile * option.WithCredentialsJSON * option.WithScopes * option/internaloption.WithDefaultScopes (internal use only) * option/internaloption.EnableJwtWithScope (internal use only)

This function should only be used internally by generated clients. This is an EXPERIMENTAL API and may be changed or removed in the future.

func EnableAsyncRefreshDryRun

func EnableAsyncRefreshDryRun(errHandler func()) option.ClientOption

EnableAsyncRefreshDryRun returns a ClientOption that specifies if libraries in this module should asynchronously refresh auth token in parallel to sync refresh.

This option can be used to determine whether refreshing the token asymnchronously prior to its actual expiry works without any issues in a particular environment.

errHandler function will be called when there is an error while refreshing the token asynchronously.

This is an EXPERIMENTAL option and will be removed in the future. TODO(b/372244283): Remove after b/358175516 has been fixed

func EnableDirectPath

func EnableDirectPath(dp bool) option.ClientOption

EnableDirectPath returns a ClientOption that overrides the default attempt to use DirectPath.

It should only be used internally by generated clients. This is an EXPERIMENTAL API and may be changed or removed in the future.

func EnableDirectPathXds

func EnableDirectPathXds() option.ClientOption

EnableDirectPathXds returns a ClientOption that overrides the default DirectPath type. It is only valid when DirectPath is enabled.

It should only be used internally by generated clients. This is an EXPERIMENTAL API and may be changed or removed in the future.

func EnableJwtWithScope

func EnableJwtWithScope() option.ClientOption

EnableJwtWithScope returns a ClientOption that specifies if scope can be used with self-signed JWT.

EnableJwtWithScope is ignored when option.WithUniverseDomain is set to a value other than the Google Default Universe (GDU) of "googleapis.com". For non-GDU domains, token exchange is impossible and services must support self-signed JWTs with scopes.

func EnableNewAuthLibrary

func EnableNewAuthLibrary() option.ClientOption

EnableNewAuthLibrary returns a ClientOption that specifies if libraries in this module to delegate auth to our new library. This option will be removed in the future once all clients have been moved to the new auth layer.

func GetLogger

func GetLogger(opts []option.ClientOption) *slog.Logger

GetLogger is a helper for client libraries to extract the slog.Logger from the provided options or return a default logger if one is not found.

It should only be used internally by generated clients. This is an EXPERIMENTAL API and may be changed or removed in the future.

func SkipDialSettingsValidation

func SkipDialSettingsValidation() option.ClientOption

SkipDialSettingsValidation bypasses validation on ClientOptions.

It should only be used internally.

func WithCredentials

func WithCredentials(creds *google.Credentials) option.ClientOption

WithCredentials returns a client option to specify credentials which will be used to authenticate API calls. This credential takes precedence over all other credential options.

func WithDefaultAudience

func WithDefaultAudience(audience string) option.ClientOption

WithDefaultAudience returns a ClientOption that specifies a default audience to be used as the audience field ("aud") for the JWT token authentication.

It should only be used internally by generated clients.

func WithDefaultEndpoint

func WithDefaultEndpoint(url string) option.ClientOption

WithDefaultEndpoint is an option that indicates the default endpoint.

It should only be used internally by generated clients.

This is similar to WithEndpoint, but allows us to determine whether the user has overridden the default endpoint.

Deprecated: WithDefaultEndpoint does not support setting the universe domain. Use WithDefaultEndpointTemplate and WithDefaultUniverseDomain to compose the default endpoint instead.

func WithDefaultEndpointTemplate

func WithDefaultEndpointTemplate(url string) option.ClientOption

WithDefaultEndpointTemplate provides a template for creating the endpoint using a universe domain. See also WithDefaultUniverseDomain and option.WithUniverseDomain. The placeholder UNIVERSE_DOMAIN should be used instead of a concrete universe domain such as "googleapis.com".

Example: WithDefaultEndpointTemplate("https://logging.UNIVERSE_DOMAIN/")

It should only be used internally by generated clients.

func WithDefaultMTLSEndpoint

func WithDefaultMTLSEndpoint(url string) option.ClientOption

WithDefaultMTLSEndpoint is an option that indicates the default mTLS endpoint.

It should only be used internally by generated clients.

func WithDefaultScopes

func WithDefaultScopes(scope ...string) option.ClientOption

WithDefaultScopes returns a ClientOption that overrides the default OAuth2 scopes to be used for a service.

It should only be used internally by generated clients.

func WithDefaultUniverseDomain

func WithDefaultUniverseDomain(ud string) option.ClientOption

WithDefaultUniverseDomain returns a ClientOption that sets the default universe domain.

It should only be used internally by generated clients.

This is similar to the public WithUniverse, but allows us to determine whether the user has overridden the default universe.

Types

type EmbeddableAdapter

type EmbeddableAdapter struct{}

EmbeddableAdapter is a no-op option.ClientOption that allow libraries to create their own client options by embedding this type into their own client-specific option wrapper. See example for usage.

Example

package main

import (
	"context"
	"fmt"

	"google.golang.org/api/option"
	"google.golang.org/api/option/internaloption"
)

type config struct {
	i int
}

type clientSpecificOption interface {
	option.ClientOption
	ApplyOpt(*config)
}

func WithFavoriteNumber(i int) option.ClientOption {
	return &withFavoriteNumber{i: i}
}

type withFavoriteNumber struct {
	internaloption.EmbeddableAdapter
	i int
}

func (w *withFavoriteNumber) ApplyOpt(c *config) {
	c.i = w.i
}

type Foo struct {
	i int
}

func NewFoo(ctx context.Context, opts ...option.ClientOption) (*Foo, error) {
	var conf config
	for _, opt := range opts {
		if fooOpt, ok := opt.(clientSpecificOption); ok {
			fooOpt.ApplyOpt(&conf)
		}
	}
	// Pass options to internals for dialing. All client-specific options will
	// be no-ops.
	return &Foo{i: conf.i}, nil
}

func (f *Foo) Number() int { return f.i }

func main() {
	f, err := NewFoo(context.Background(), WithFavoriteNumber(42))
	if err != nil {
		// TODO: handle error
	}
	fmt.Println(f.Number())
}

Output:

42

func (*EmbeddableAdapter) Apply

func (*EmbeddableAdapter) Apply(_ *internal.DialSettings)