Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

settings

package

Go to main page

Versions in this module

v2

v2.11.0

Aug 8, 2025

v2.10.1

Aug 8, 2025

v2.10.0

Aug 8, 2025

Changes in this version

+ func WriteCredentials(cred *Credentials, path string) error

+ func WriteDialSettings(ds *DialSettings, path string) error

type Credentials

+ func ReadCredentials(path string) (*Credentials, error)

type DialSettings

+ func ReadDialSettings(path string) (*DialSettings, error)

+ type Option interface

+ Apply func(ds *DialSettings)

v2.7.0

Nov 22, 2023

v2.6.0

Nov 22, 2023

Changes in this version

+ const StateAuthorized

+ const StateInit

+ const StateInvalid

+ const StateUndefined

type Credentials

+ Status State

v2.5.0

May 26, 2023

Changes in this version

+ const AccessToken

+ const ClientID

+ const ClientSecret

+ const ProjectID

type Credentials

+ ClientID string

+ ClientSecret string

+ func CredentialsFromEnv() *Credentials

+ func (c *Credentials) Clone() *Credentials

+ func (c *Credentials) Expired() bool

+ func (c *Credentials) HashedKey() string

+ func (c *Credentials) IsValid() bool

+ func (c *Credentials) Key() string

type DialSettings

+ func (ds *DialSettings) Clone() DialSettings

+ type State int

v2.2.1

Aug 15, 2022

v2.2.0

Jun 4, 2022

v2.1.0

Mar 3, 2022

v2.0.0

Feb 7, 2022

Changes in this version

+ type ClientOption interface

+ Apply func(*DialSettings)

+ func WithAPIKey(apiKey string) ClientOption

+ func WithEndpoint(url string) ClientOption

+ func WithScopes(scope ...string) ClientOption

+ func WithUserAgent(ua string) ClientOption

+ func WithoutAuthentication() ClientOption

+ type Credentials struct

+ Expires int64

+ ProjectID string

+ Token string

+ UserID string

+ func ReadCredentialsFromFile(path string) (*Credentials, error)

+ func (cred *Credentials) WriteToFile(path string) error

+ type DialSettings struct

+ APIKey string

+ Credentials *Credentials

+ CredentialsFile string

+ DefaultEndpoint string

+ DefaultScopes []string

+ Endpoint string

+ InternalCredentials *Credentials

+ NoAuth bool

+ Options map[string]string

+ Scopes []string

+ SkipValidation bool

+ UserAgent string

+ func ReadSettingsFromFile(path string) (*DialSettings, error)

+ func (ds *DialSettings) GetOption(opt string) string

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

+ func (ds *DialSettings) HasOption(opt string) bool

+ func (ds *DialSettings) SetOption(opt, o string)

+ func (ds *DialSettings) Validate() error

+ func (ds *DialSettings) WriteToFile(path string) error