type ClientCertSource = func(*tls.CertificateRequestInfo) (*tls.Certificate,error)

type ClientOption interface {Apply(*internal.DialSettings)}

funcWithAPIKey¶

func WithAPIKey(apiKeystring)ClientOption

WithAPIKey returns a ClientOption that specifies an API key to be usedas the basis for authentication.

API Keys can only be used for JSON-over-HTTP APIs, including those underthe import path google.golang.org/api/....

funcWithAudiences¶added inv0.2.0

func WithAudiences(audience ...string)ClientOption

WithAudiences returns a ClientOption that specifies an audience to be usedas the audience field ("aud") for the JWT token authentication.

funcWithAuthCredentials¶added inv0.174.0

func WithAuthCredentials(creds *auth.Credentials)ClientOption

WithAuthCredentials returns a ClientOption that specifies ancloud.google.com/go/auth.Credentials to be used as the basis forauthentication.

funcWithClientCertSource¶added inv0.18.0

func WithClientCertSource(sClientCertSource)ClientOption

WithClientCertSource returns a ClientOption that specifies acallback function for obtaining a TLS client certificate.

This option is used for supporting mTLS authentication, where theserver validates the client certifcate when establishing a connection.

The callback function will be invoked whenever the server requests acertificate from the client. Implementations of the callback functionshould try to ensure that a valid certificate can be repeatedly returnedon demand for the entire life cycle of the transport client. If a nilCertificate is returned (i.e. no Certificate can be obtained), an errorshould be returned.

This is an EXPERIMENTAL API and may be changed or removed in the future.

funcWithCredentials¶

func WithCredentials(creds *google.Credentials)ClientOption

WithCredentials returns a ClientOption that authenticates API calls.

funcWithCredentialsFile¶

func WithCredentialsFile(filenamestring)ClientOption

WithCredentialsFile returns a ClientOption that authenticatesAPI calls with the given service account or refresh token JSONcredentials file.

Important: If you accept a credential configuration (credentialJSON/File/Stream) from an external source for authentication to GoogleCloud Platform, you must validate it before providing it to any GoogleAPI or library. Providing an unvalidated credential configuration toGoogle APIs can compromise the security of your systems and data. Formore information, refer to [Validate credential configurations fromexternal sources](https://cloud.google.com/docs/authentication/external/externally-sourced-credentials).

funcWithCredentialsJSON¶

func WithCredentialsJSON(p []byte)ClientOption

WithCredentialsJSON returns a ClientOption that authenticatesAPI calls with the given service account or refresh token JSONcredentials.

Important: If you accept a credential configuration (credentialJSON/File/Stream) from an external source for authentication to GoogleCloud Platform, you must validate it before providing it to any GoogleAPI or library. Providing an unvalidated credential configuration toGoogle APIs can compromise the security of your systems and data. Formore information, refer to [Validate credential configurations fromexternal sources](https://cloud.google.com/docs/authentication/external/externally-sourced-credentials).

funcWithEndpoint¶

func WithEndpoint(urlstring)ClientOption

WithEndpoint returns a ClientOption that overrides the default endpointto be used for a service. Please note that by default Google APIs onlyaccept HTTPS traffic.

For a gRPC client, the port number is typically included in the endpoint.Example: "us-central1-speech.googleapis.com:443".

For a REST client, the port number is typically not included. Example:"https://speech.googleapis.com".

funcWithGRPCConn¶

func WithGRPCConn(conn *grpc.ClientConn)ClientOption

WithGRPCConn returns a ClientOption that specifies the gRPC clientconnection to use as the basis of communications. This option may only beused with services that support gRPC as their communication transport. Whenused, the WithGRPCConn option takes precedent over all other suppliedoptions.

funcWithGRPCConnectionPool¶

func WithGRPCConnectionPool(sizeint)ClientOption

WithGRPCConnectionPool returns a ClientOption that creates a pool of gRPCconnections that requests will be balanced between.

funcWithGRPCDialOption¶

func WithGRPCDialOption(optgrpc.DialOption)ClientOption

WithGRPCDialOption returns a ClientOption that appends a new grpc.DialOptionto an underlying gRPC dial. It does not work with WithGRPCConn.

funcWithHTTPClient¶

func WithHTTPClient(client *http.Client)ClientOption

WithHTTPClient returns a ClientOption that specifies the HTTP client to useas the basis of communications. This option may only be used with servicesthat support HTTP as their communication transport. When used, theWithHTTPClient option takes precedent over all other supplied options.

funcWithLogger¶added inv0.206.0

func WithLogger(l *slog.Logger)ClientOption

WithLogger returns a ClientOption that sets the logger used throughout theclient library call stack. If this option is provided it takes precedenceover the value set in GOOGLE_SDK_GO_LOGGING_LEVEL. Specifying this optionenables logging at the provided logger's configured level.

funcWithQuotaProject¶added inv0.2.0

func WithQuotaProject(quotaProjectstring)ClientOption

WithQuotaProject returns a ClientOption that specifies the project usedfor quota and billing purposes.

For more information please read:https://cloud.google.com/apis/docs/system-parameters

funcWithRequestReason¶added inv0.2.0

func WithRequestReason(requestReasonstring)ClientOption

WithRequestReason returns a ClientOption that specifies a reason formaking the request, which is intended to be recorded in audit logging.An example reason would be a support-case ticket number.

For more information please read:https://cloud.google.com/apis/docs/system-parameters

funcWithScopes¶

func WithScopes(scope ...string)ClientOption

WithScopes returns a ClientOption that overrides the default OAuth2 scopesto be used for a service.

If both WithScopes and WithTokenSource are used, scope settings from thetoken source will be used instead.

funcWithTelemetryDisabled¶added inv0.14.0

func WithTelemetryDisabled()ClientOption

WithTelemetryDisabled returns a ClientOption that disables default telemetry (OpenCensus)settings on gRPC and HTTP clients.An example reason would be to bind custom telemetry that overrides the defaults.

funcWithTokenSource¶

func WithTokenSource(soauth2.TokenSource)ClientOption

WithTokenSource returns a ClientOption that specifies an OAuth2 tokensource to be used as the basis for authentication.

funcWithUniverseDomain¶added inv0.153.0

func WithUniverseDomain(udstring)ClientOption

WithUniverseDomain returns a ClientOption that sets the universe domain.

funcWithUserAgent¶

func WithUserAgent(uastring)ClientOption

WithUserAgent returns a ClientOption that sets the User-Agent. This optionis incompatible with theWithHTTPClient option. If you wish to provide acustom client you will need to add this header via RoundTripper middleware.

funcWithoutAuthentication¶

func WithoutAuthentication()ClientOption

WithoutAuthentication returns a ClientOption that specifies that noauthentication should be used. It is suitable only for testing and foraccessing public resources, like public Google Cloud Storage buckets.It is an error to provide both WithoutAuthentication and any of WithAPIKey,WithTokenSource, WithCredentialsFile or WithServiceAccountFile.