Package: cloud.google.com/go/compute/metadata

package metadata Import Path cloud.google.com/go/compute/metadata (on go.dev) Dependency Relation imports 12 packages, and imported by 6 packages Involved Source Files d➜ metadata.go Package metadata provides access to Google Compute Engine (GCE) metadata and API service accounts. This package is a wrapper around the GCE metadata service, as documented at https://developers.google.com/compute/docs/metadata. Package-Level Type Names (total 4, in which 3 are exported) /* sort exporteds by: alphabet | popularity */ type Client (struct) A Client provides metadata. Fields (only one, which is unexported) /* one unexported ... *//* one unexported: */ hc *http.Client Methods (total 20, in which 17 are exported) (*T) Email(serviceAccount string) (string, error) Email returns the email address associated with the service account. The account may be empty or the string "default" to use the instance's main account. (*T) ExternalIP() (string, error) ExternalIP returns the instance's primary external (public) IP address. (*T) Get(suffix string) (string, error) Get returns a value from the metadata service. The suffix is appended to "http://${GCE_METADATA_HOST}/computeMetadata/v1/". If the GCE_METADATA_HOST environment variable is not defined, a default of 169.254.169.254 will be used instead. If the requested metadata is not defined, the returned error will be of type NotDefinedError. (*T) Hostname() (string, error) Hostname returns the instance's hostname. This will be of the form "<instanceID>.c.<projID>.internal". (*T) InstanceAttributeValue(attr string) (string, error) InstanceAttributeValue returns the value of the provided VM instance attribute. If the requested attribute is not defined, the returned error will be of type NotDefinedError. InstanceAttributeValue may return ("", nil) if the attribute was defined to be the empty string. (*T) InstanceAttributes() ([]string, error) InstanceAttributes returns the list of user-defined attributes, assigned when initially creating a GCE VM instance. The value of an attribute can be obtained with InstanceAttributeValue. (*T) InstanceID() (string, error) InstanceID returns the current VM's numeric instance ID. (*T) InstanceName() (string, error) InstanceName returns the current VM's instance ID string. (*T) InstanceTags() ([]string, error) InstanceTags returns the list of user-defined instance tags, assigned when initially creating a GCE instance. (*T) InternalIP() (string, error) InternalIP returns the instance's primary internal IP address. (*T) NumericProjectID() (string, error) NumericProjectID returns the current instance's numeric project ID. (*T) ProjectAttributeValue(attr string) (string, error) ProjectAttributeValue returns the value of the provided project attribute. If the requested attribute is not defined, the returned error will be of type NotDefinedError. ProjectAttributeValue may return ("", nil) if the attribute was defined to be the empty string. (*T) ProjectAttributes() ([]string, error) ProjectAttributes returns the list of user-defined attributes applying to the project as a whole, not just this VM. The value of an attribute can be obtained with ProjectAttributeValue. (*T) ProjectID() (string, error) ProjectID returns the current instance's project ID string. (*T) Scopes(serviceAccount string) ([]string, error) Scopes returns the service account scopes for the given account. The account may be empty or the string "default" to use the instance's main account. (*T) Subscribe(suffix string, fn func(v string, ok bool) error) error Subscribe subscribes to a value from the metadata service. The suffix is appended to "http://${GCE_METADATA_HOST}/computeMetadata/v1/". The suffix may contain query parameters. Subscribe calls fn with the latest metadata value indicated by the provided suffix. If the metadata value is deleted, fn is called with the empty string and ok false. Subscribe blocks until fn returns a non-nil error or the value is deleted. Subscribe returns the error value returned from the last call to fn, which may be nil when ok == false. (*T) Zone() (string, error) Zone returns the current VM's zone, such as "us-central1-b". /* 3 unexporteds ... *//* 3 unexporteds: */ (*T) getETag(suffix string) (value, etag string, err error) getETag returns a value from the metadata service as well as the associated ETag. This func is otherwise equivalent to Get. (*T) getTrimmed(suffix string) (s string, err error) (*T) lines(suffix string) ([]string, error) As Outputs Of (at least one exported) func NewClient(c *http.Client) *Client As Types Of (only one, which is unexported) /* one unexported ... *//* one unexported: */ var defaultClient *Client type Error (struct) Error contains an error response from the server. Fields (total 2, both are exported) Code int Code is the HTTP response status code. Message string Message is the server response message. Methods (only one, which is exported) (*T) Error() string Implements (at least one exported) *T : error type NotDefinedError string (basic type) NotDefinedError is returned when requested metadata is not defined. The underlying string is the suffix after "/computeMetadata/v1/". This error is not returned if the value is defined to be the empty string. Methods (only one, which is exported) ( T) Error() string Implements (at least one exported) T : error /* one unexported ... *//* one unexported: */ type cachedValue (struct) Fields (total 4, none are exported) /* 4 unexporteds ... *//* 4 unexporteds: */ k string mu sync.Mutex trim bool v string Methods (only one, which is unexported) /* one unexported ... *//* one unexported: */ (*T) get(cl *Client) (v string, err error) As Types Of (total 3, none are exported) /* 3 unexporteds ... *//* 3 unexporteds: */ var instID *cachedValue var projID *cachedValue var projNum *cachedValue Package-Level Functions (total 23, in which 19 are exported) func Email(serviceAccount string) (string, error) Email calls Client.Email on the default client. func ExternalIP() (string, error) ExternalIP returns the instance's primary external (public) IP address. func Get(suffix string) (string, error) Get calls Client.Get on the default client. func Hostname() (string, error) Hostname returns the instance's hostname. This will be of the form "<instanceID>.c.<projID>.internal". func InstanceAttributes() ([]string, error) InstanceAttributes calls Client.InstanceAttributes on the default client. func InstanceAttributeValue(attr string) (string, error) InstanceAttributeValue calls Client.InstanceAttributeValue on the default client. func InstanceID() (string, error) InstanceID returns the current VM's numeric instance ID. func InstanceName() (string, error) InstanceName returns the current VM's instance ID string. func InstanceTags() ([]string, error) InstanceTags returns the list of user-defined instance tags, assigned when initially creating a GCE instance. func InternalIP() (string, error) InternalIP returns the instance's primary internal IP address. func NewClient(c *http.Client) *Client NewClient returns a Client that can be used to fetch metadata. Returns the client that uses the specified http.Client for HTTP requests. If nil is specified, returns the default client. func NumericProjectID() (string, error) NumericProjectID returns the current instance's numeric project ID. func OnGCE() bool OnGCE reports whether this process is running on Google Compute Engine. func ProjectAttributes() ([]string, error) ProjectAttributes calls Client.ProjectAttributes on the default client. func ProjectAttributeValue(attr string) (string, error) ProjectAttributeValue calls Client.ProjectAttributeValue on the default client. func ProjectID() (string, error) ProjectID returns the current instance's project ID string. func Scopes(serviceAccount string) ([]string, error) Scopes calls Client.Scopes on the default client. func Subscribe(suffix string, fn func(v string, ok bool) error) error Subscribe calls Client.Subscribe on the default client. func Zone() (string, error) Zone returns the current VM's zone, such as "us-central1-b". /* 4 unexporteds ... *//* 4 unexporteds: */ func initOnGCE() func strsContains(ss []string, s string) bool func systemInfoSuggestsGCE() bool systemInfoSuggestsGCE reports whether the local system (without doing network requests) suggests that we're running on GCE. If this returns true, testOnGCE tries a bit harder to reach its metadata server. func testOnGCE() bool Package-Level Variables (total 6, none are exported) /* 6 unexporteds ... *//* 6 unexporteds: */ var defaultClient *Client var instID *cachedValue var onGCE bool var onGCEOnce sync.Once var projID *cachedValue var projNum *cachedValue Package-Level Constants (total 3, none are exported) /* 3 unexporteds ... *//* 3 unexporteds: */ const metadataHostEnv = "GCE_METADATA_HOST" metadataHostEnv is the environment variable specifying the GCE metadata hostname. If empty, the default value of metadataIP ("169.254.169.254") is used instead. This is variable name is not defined by any spec, as far as I know; it was made up for the Go package. const metadataIP = "169.254.169.254" metadataIP is the documented metadata server IP address. const userAgent = "gcloud-golang/0.1"

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.