Documentation
¶
Overview ¶
Package appengine provides basic functionality for Google App Engine.
For more information on how to write Go apps for Google App Engine, see: https://cloud.google.com/appengine/docs/go/
Index ¶
- func AccessToken(c Context, scopes ...string) (token string, expiry time.Time, err error)
- func AppID(c Context) string
- func BackendHostname(c Context, name string, index int) string
- func BackendInstance(c Context) (name string, index int)
- func Datacenter() string
- func DefaultVersionHostname(c Context) string
- func InstanceID() string
- func IsCapabilityDisabled(err error) bool
- func IsDevAppServer() bool
- func IsOverQuota(err error) bool
- func IsTimeoutError(err error) bool
- func ModuleHostname(c Context, module, version, instance string) (string, error)
- func ModuleName(c Context) string
- func RequestID(c Context) string
- func ServerSoftware() string
- func ServiceAccount(c Context) (string, error)
- func SignBytes(c Context, bytes []byte) (keyName string, signature []byte, err error)
- func VersionID(c Context) string
- type BlobKey
- type Certificate
- type Context
- type GeoPoint
- type MultiError
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func AccessToken ¶
AccessToken generates an OAuth2 access token for the specified scopes on behalf of service account of this application. This token will expire after the returned time.
func AppID ¶
AppID returns the application ID for the current application. The string will be a plain application ID (e.g. "appid"), with a domain prefix for custom domain deployments (e.g. "example.com:appid").
func BackendHostname ¶
BackendHostname returns the standard hostname of the specified backend. If index is -1, BackendHostname returns the load-balancing hostname for the backend.
func BackendInstance ¶
BackendInstance returns the name and index of the current backend instance, or "", -1 if this is not a backend instance.
func Datacenter ¶
func Datacenter() string
Datacenter returns an identifier for the datacenter that the instance is running in.
func DefaultVersionHostname ¶
DefaultVersionHostname returns the standard hostname of the default version of the current application (e.g. "my-app.appspot.com"). This is suitable for use in constructing URLs.
func InstanceID ¶
func InstanceID() string
InstanceID returns a mostly-unique identifier for this instance.
func IsCapabilityDisabled ¶
IsCapabilityDisabled reports whether err represents an API call failure due to the API being disabled. See the appengine/capability package for a way to detect this condition in advance.
func IsDevAppServer ¶
func IsDevAppServer() bool
IsDevAppServer reports whether the App Engine app is running in the development App Server.
func IsOverQuota ¶
IsOverQuota reports whether err represents an API call failure due to insufficient available quota.
func IsTimeoutError ¶
IsTimeoutError reports whether err is a timeout error.
func ModuleHostname ¶
ModuleHostname returns a hostname of a module instance. If module is the empty string, it refers to the module of the current instance. If version is empty, it refers to the version of the current instance if valid, or the default version of the module of the current instance. If instance is empty, ModuleHostname returns the load-balancing hostname.
func ModuleName ¶
ModuleName returns the module name of the current instance.
func ServerSoftware ¶
func ServerSoftware() string
ServerSoftware returns the App Engine release version. In production, it looks like "Google App Engine/X.Y.Z". In the development appserver, it looks like "Development/X.Y".
func ServiceAccount ¶
ServiceAccount returns a string representing the service account name, in the form of an email address (typically app_id@appspot.gserviceaccount.com).
Types ¶
type BlobKey ¶
type BlobKey string
BlobKey is a key for a blobstore blob.
Conceptually, this type belongs in the blobstore package, but it lives in the appengine package to avoid a circular dependency: blobstore depends on datastore, and datastore needs to refer to the BlobKey type.
type Certificate ¶
Certificate represents a public certificate for the app.
func PublicCertificates ¶
func PublicCertificates(c Context) ([]Certificate, error)
PublicCertificates retrieves the public certificates for the app. They can be used to verify a signature returned by SignBytes.
type Context ¶
type Context interface {
// Debugf formats its arguments according to the format, analogous to fmt.Printf,
// and records the text as a log message at Debug level.
Debugf(format string, args ...interface{})
// Infof is like Debugf, but at Info level.
Infof(format string, args ...interface{})
// Warningf is like Debugf, but at Warning level.
Warningf(format string, args ...interface{})
// Errorf is like Debugf, but at Error level.
Errorf(format string, args ...interface{})
// Criticalf is like Debugf, but at Critical level.
Criticalf(format string, args ...interface{})
// Internal use only.
Call(service, method string, in, out appengine_internal.ProtoMessage, opts *appengine_internal.CallOptions) error
// Internal use only. Use AppID instead.
FullyQualifiedAppID() string
// Internal use only.
Request() interface{}
}
Context represents the context of an in-flight HTTP request.
func NewContext ¶
NewContext returns a context for an in-flight HTTP request. Repeated calls will return the same value.
type GeoPoint ¶
type GeoPoint struct {
Lat, Lng float64
}
GeoPoint represents a location as latitude/longitude in degrees.
type MultiError ¶
type MultiError []error
MultiError is returned by batch operations when there are errors with particular elements. Errors will be in a one-to-one correspondence with the input elements; successful elements will have a nil entry.
func (MultiError) Error ¶
func (m MultiError) Error() string
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
Package aetest provides an appengine.Context for use in tests.
|
Package aetest provides an appengine.Context for use in tests. |
|
Package blobstore provides a client for App Engine's persistent blob storage service.
|
Package blobstore provides a client for App Engine's persistent blob storage service. |
|
Package capability exposes information about outages and scheduled downtime for specific API capabilities.
|
Package capability exposes information about outages and scheduled downtime for specific API capabilities. |
|
Package channel implements the server side of App Engine's Channel API.
|
Package channel implements the server side of App Engine's Channel API. |
|
Package cloudsql exposes access to Google Cloud SQL databases.
|
Package cloudsql exposes access to Google Cloud SQL databases. |
|
Package datastore provides a client for App Engine's datastore service.
|
Package datastore provides a client for App Engine's datastore service. |
|
Package delay provides a way to execute code outside the scope of a user request by using the taskqueue API.
|
Package delay provides a way to execute code outside the scope of a user request by using the taskqueue API. |
|
Package file provides a client for Google Cloud Storage.
|
Package file provides a client for Google Cloud Storage. |
|
Package image provides image services.
|
Package image provides image services. |
|
Package log provides the means of querying an application's logs from within an App Engine application.
|
Package log provides the means of querying an application's logs from within an App Engine application. |
|
Package mail provides the means of sending email from an App Engine application.
|
Package mail provides the means of sending email from an App Engine application. |
|
Package memcache provides a client for App Engine's distributed in-memory key-value store for small chunks of arbitrary data.
|
Package memcache provides a client for App Engine's distributed in-memory key-value store for small chunks of arbitrary data. |
|
Package module provides functions for interacting with modules.
|
Package module provides functions for interacting with modules. |
|
Package remote_api implements the /_ah/remote_api endpoint.
|
Package remote_api implements the /_ah/remote_api endpoint. |
|
Package runtime exposes information about the resource usage of the application.
|
Package runtime exposes information about the resource usage of the application. |
|
Package search provides a client for App Engine's search service.
|
Package search provides a client for App Engine's search service. |
|
Package socket provides outbound network sockets.
|
Package socket provides outbound network sockets. |
|
Package taskqueue provides a client for App Engine's taskqueue service.
|
Package taskqueue provides a client for App Engine's taskqueue service. |
|
Package urlfetch provides an http.RoundTripper implementation for fetching URLs via App Engine's urlfetch service.
|
Package urlfetch provides an http.RoundTripper implementation for fetching URLs via App Engine's urlfetch service. |
|
Package user provides a client for App Engine's user authentication service.
|
Package user provides a client for App Engine's user authentication service. |
|
Package xmpp provides the means to send and receive instant messages to and from users of XMPP-compatible services.
|
Package xmpp provides the means to send and receive instant messages to and from users of XMPP-compatible services. |