import "google.golang.org/appengine"
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/
appengine.go appengine_vm.go errors.go identity.go namespace.go timeout.go
APICall performs an API call.
This is not intended for general use; it is exported for use in conjunction with WithAPICallFunc.
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.
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").
BackgroundContext returns a context not associated with a request. This should only be used when not servicing a request. This only works in App Engine "flexible environment".
Datacenter returns an identifier for the datacenter that the instance is running in.
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.
InstanceID returns a mostly-unique identifier for this instance.
IsAppEngine reports whether the App Engine app is running on App Engine, in either the standard or flexible environment.
IsDevAppServer reports whether the App Engine app is running in the development App Server.
IsFlex reports whether the App Engine app is running in the flexible environment.
IsOverQuota reports whether err represents an API call failure due to insufficient available quota.
IsSecondGen reports whether the App Engine app is running on the second generation runtimes (>= Go 1.11).
IsStandard reports whether the App Engine app is running in the standard environment. This includes both the first generation runtimes (<= Go 1.9) and the second generation runtimes (>= Go 1.11).
IsTimeoutError reports whether err is a timeout error.
func Main()
Main is the principal entry point for an app running in App Engine.
On App Engine Flexible it installs a trivial health checker if one isn't already registered, and starts listening on port 8080 (overridden by the $PORT environment variable).
See https://cloud.google.com/appengine/docs/flexible/custom-runtimes#health_check_requests for details on how to do your own health checking.
On App Engine Standard it ensures the server has started and is prepared to receive requests.
Main never returns.
Main is designed so that the app's main package looks like this:
package main
import (
"google.golang.org/appengine"
_ "myapp/package0"
_ "myapp/package1"
)
func main() {
appengine.Main()
}
The "myapp/packageX" packages are expected to register HTTP handlers in their init functions.
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.
ModuleName returns the module name of the current instance.
Namespace returns a replacement context that operates within the given namespace.
NewContext returns a context for an in-flight HTTP request. This function is cheap.
RequestID returns a string that uniquely identifies the request.
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".
ServiceAccount returns a string representing the service account name, in the form of an email address (typically app_id@appspot.gserviceaccount.com).
SignBytes signs bytes using a private key unique to your application.
VersionID returns the version ID for the current application. It will be of the form "X.Y", where X is specified in app.yaml, and Y is a number generated when each version of the app is uploaded. It does not include a module name.
WithAPICallFunc returns a copy of the parent context that will cause API calls to invoke f instead of their normal operation.
This is intended for advanced users only.
WithContext returns a copy of the parent context and associates it with an in-flight HTTP request. This function is cheap.
APICallFunc defines a function type for handling an API call. See WithCallOverride.
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.
Certificate represents a public certificate for the app.
func PublicCertificates(c context.Context) ([]Certificate, error)
PublicCertificates retrieves the public certificates for the app. They can be used to verify a signature returned by SignBytes.
GeoPoint represents a location as latitude/longitude in degrees.
Valid returns whether a GeoPoint is within [-90, 90] latitude and [-180, 180] longitude.
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 (m MultiError) Error() string
| Path | Synopsis |
|---|---|
| aetest | Package aetest provides an API for running dev_appserver for use in tests. |
| blobstore | Package blobstore provides a client for App Engine's persistent blob storage service. |
| capability | Package capability exposes information about outages and scheduled downtime for specific API capabilities. |
| channel | Package channel implements the server side of App Engine's Channel API. |
| cloudsql | Package cloudsql exposes access to Google Cloud SQL databases. |
| cmd/aebundler | Program aebundler turns a Go app into a fully self-contained tar file. |
| cmd/aedeploy | Program aedeploy assists with deploying App Engine "flexible environment" Go apps to production. |
| cmd/aefix | |
| datastore | Package datastore provides a client for App Engine's datastore service. |
| delay | Package delay provides a way to execute code outside the scope of a user request by using the taskqueue API. |
| demos/guestbook | |
| demos/helloworld | |
| file | Package file provides helper functions for using Google Cloud Storage. |
| image | Package image provides image services. |
| internal | Package internal provides support for package appengine. |
| internal/aetesting | Package aetesting provides utilities for testing App Engine packages. |
| internal/app_identity | |
| internal/base | |
| internal/blobstore | |
| internal/capability | |
| internal/channel | |
| internal/datastore | |
| internal/image | |
| internal/log | |
| internal/mail | |
| internal/memcache | |
| internal/modules | |
| internal/remote_api | |
| internal/search | |
| internal/socket | |
| internal/system | |
| internal/taskqueue | |
| internal/urlfetch | |
| internal/user | |
| internal/xmpp | |
| log | Package log provides the means of writing and querying an application's logs from within an App Engine application. |
| Package mail provides the means of sending email from an App Engine application. | |
| memcache | Package memcache provides a client for App Engine's distributed in-memory key-value store for small chunks of arbitrary data. |
| module | Package module provides functions for interacting with modules. |
| remote_api | Package remote_api implements the /_ah/remote_api endpoint. |
| runtime | Package runtime exposes information about the resource usage of the application. |
| search | Package search provides a client for App Engine's search service. |
| socket | Package socket provides outbound network sockets. |
| taskqueue | Package taskqueue provides a client for App Engine's taskqueue service. |
| urlfetch | Package urlfetch provides an http.RoundTripper implementation for fetching URLs via App Engine's urlfetch service. |
| user | Package user provides a client for App Engine's user authentication service. |
| xmpp | Package xmpp provides the means to send and receive instant messages to and from users of XMPP-compatible services. |
Package appengine imports 9 packages (graph) and is imported by 1060 packages. Updated 2019-02-16. Refresh now. Tools for package owners.