package oauth

Import Path
	google.golang.org/grpc/credentials/oauth (on go.dev)

Dependency Relation
	imports 8 packages, and imported by 2 packages

Involved Source Files

	   d➜ oauth.go
		Package oauth implements gRPC credentials using OAuth.
Package-Level Type Names (total 4, in which 1 are exported)

	/* sort exporteds by: alphabet | popularity */
	 type TokenSource (struct)
		TokenSource supplies PerRPCCredentials from an oauth2.TokenSource.

		Fields (only one, which is exported)
			TokenSource oauth2.TokenSource
		Methods (total 3, all are exported)
			( T) GetRequestMetadata(ctx context.Context, uri ...string) (map[string]string, error)
				GetRequestMetadata gets the request metadata as a map from a TokenSource.

			( T) RequireTransportSecurity() bool
				RequireTransportSecurity indicates whether the credentials requires transport security.

			( T) Token() (*oauth2.Token, error)
				Token returns a token or an error.
				Token must be safe for concurrent use by multiple goroutines.
				The returned Token must not be modified.

		Implements (at least 2, both are exported)
			 T : google.golang.org/grpc/credentials.PerRPCCredentials
			 T : golang.org/x/oauth2.TokenSource

	/* 3 unexporteds ... *//* 3 unexporteds: */
	 type jwtAccess (struct)

		Fields (only one, which is unexported)
			/* one unexported ... *//* one unexported: */
			jsonKey []byte
		Methods (total 2, both are exported)
			( T) GetRequestMetadata(ctx context.Context, uri ...string) (map[string]string, error)
			( T) RequireTransportSecurity() bool
		Implements (at least one exported)
			 T : google.golang.org/grpc/credentials.PerRPCCredentials

	 type oauthAccess (struct)
		oauthAccess supplies PerRPCCredentials from a given token.

		Fields (only one, which is unexported)
			/* one unexported ... *//* one unexported: */
			token oauth2.Token
		Methods (total 2, both are exported)
			( T) GetRequestMetadata(ctx context.Context, uri ...string) (map[string]string, error)
			( T) RequireTransportSecurity() bool
		Implements (at least one exported)
			 T : google.golang.org/grpc/credentials.PerRPCCredentials

	 type serviceAccount (struct)
		serviceAccount represents PerRPCCredentials via JWT signing key.

		Fields (total 3, none are exported)
			/* 3 unexporteds ... *//* 3 unexporteds: */
			config *jwt.Config
			mu sync.Mutex
			t *oauth2.Token
		Methods (total 2, both are exported)
			(*T) GetRequestMetadata(ctx context.Context, uri ...string) (map[string]string, error)
			(*T) RequireTransportSecurity() bool
		Implements (at least one exported)
			*T : google.golang.org/grpc/credentials.PerRPCCredentials


Package-Level Functions (total 7, all are exported)

	 func NewApplicationDefault(ctx context.Context, scope ...string) (credentials.PerRPCCredentials, error)
		NewApplicationDefault returns "Application Default Credentials". For more
		detail, see https://developers.google.com/accounts/docs/application-default-credentials.

	 func NewComputeEngine() credentials.PerRPCCredentials
		NewComputeEngine constructs the PerRPCCredentials that fetches access tokens from
		Google Compute Engine (GCE)'s metadata server. It is only valid to use this
		if your program is running on a GCE instance.
		TODO(dsymonds): Deprecate and remove this.

	 func NewJWTAccessFromFile(keyFile string) (credentials.PerRPCCredentials, error)
		NewJWTAccessFromFile creates PerRPCCredentials from the given keyFile.

	 func NewJWTAccessFromKey(jsonKey []byte) (credentials.PerRPCCredentials, error)
		NewJWTAccessFromKey creates PerRPCCredentials from the given jsonKey.

	 func NewOauthAccess(token *oauth2.Token) credentials.PerRPCCredentials
		NewOauthAccess constructs the PerRPCCredentials using a given token.

	 func NewServiceAccountFromFile(keyFile string, scope ...string) (credentials.PerRPCCredentials, error)
		NewServiceAccountFromFile constructs the PerRPCCredentials using the JSON key file
		of a Google Developers service account.

	 func NewServiceAccountFromKey(jsonKey []byte, scope ...string) (credentials.PerRPCCredentials, error)
		NewServiceAccountFromKey constructs the PerRPCCredentials using the JSON key slice
		from a Google Developers service account.

The pages are generated with Golds v0.3.2-preview. (GOOS=darwin GOARCH=amd64)
Golds is a Go 101 project developed by Tapir Liu.
PR and bug reports are welcome and can be submitted to the issue list.
Please follow @Go100and1 (reachable from the left QR code) to get the latest news of Golds.