project

package

v1.0.0 Latest Latest Go to latest Published: Feb 22, 2024 License: MIT Imports: 8 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/lucmq/gcp-id

Links

Open Source Insights

Documentation ¶

Overview ¶

Package project provides functionality for retrieving Google Cloud project IDs and related configuration.

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func ID ¶

func ID(opts ...Options) string

ID retrieves the default Google Cloud project ID based on the provided options.

It uses the following order when searching:

Common environment variables like GCP_PROJECT, GCLOUD_PROJECT, GOOGLE_CLOUD_PROJECT.
The DefaultApplicationCredentials method from the golang.org/x/oauth2/google package.
The default project configured in `gcloud` CLI.

If the project ID is empty and the Strict option is enabled, `ID()` panics.

Types ¶

type Options ¶

type Options struct {
	// Default: 30s.
	Timeout time.Duration

	// Scopes is the list OAuth scopes.
	Scopes []string

	// If true, ID() panics when no default project ID is found.
	Strict bool
}

Options represents the configuration options for the ID function.

Source Files ¶

View all Source files

project.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL