Le package Appengine fournit des fonctionnalités de base pour Google App Engine.
Pour plus d'informations sur le développement d'applications Go pour Google App Engine, consultez la page https://cloud.google.com/appengine/docs/go/.
Variables
Middleware
Middleware encapsule un gestionnaire HTTP pour pouvoir effectuer des appels d'API GAE
Fonctions
func APICall
La fonction APICall effectue un appel d'API.
Cette fonctionnalité n'est pas destinée à un usage général. Elle est exportée pour être utilisée avec WithAPICallFunc.
func AccessToken
La fonction AccessToken génère un jeton d'accès OAuth2 pour les champs d'application spécifiés pour le compte de service de cette application. Ce jeton expire après l'heure affichée.
func AppID
La fonction AppID affiche l'ID application de l'application en cours. La chaîne comporte un ID application simple (par exemple, "appid") associé à un préfixe de domaine pour les déploiements de domaines personnalisés (par exemple, "example.com:appid").
func BackgroundContext (obsolète)
La fonction BackgroundContext affiche un contexte non associé à une requête.
Obsolète : App Engine ne dispose plus d'un contexte d'arrière-plan spécial. Il suffit d'utiliser context.Background().
func Datacenter
La fonction Datacenter affiche un identifiant correspondant au centre de données dans lequel l'instance est en cours d'exécution.
func DefaultVersionHostname
La fonction DefaultVersionHostname affiche le nom d'hôte standard de la version par défaut de l'application en cours (par exemple, "my-app.appspot.com"). Il peut s'utiliser lors de la construction des URL.
func InstanceID
func InstanceID() stringLa fonction InstanceID affiche un identifiant unique correspondant à l'instance concernée.
func IsAppEngine
func IsAppEngine() boolLa fonction IsAppEngine indique si l'application App Engine est exécutée sur App Engine, dans l'environnement standard ou flexible.
func IsDevAppServer
func IsDevAppServer() boolLa fonction IsDevAppServer indique si l'application App Engine est en cours d'exécution sur le serveur d'applications de développement.
func IsFlex
func IsFlex() boolLa fonction IsFlex indique si l'application App Engine est en cours d'exécution dans l'environnement flexible.
func IsOverQuota
La fonction IsOverQuota indique si "err" représente une erreur d'appel d'API générée en raison d'un quota disponible insuffisant.
func IsSecondGen
func IsSecondGen() boolLa fonction IsSecondGen indique si l'application App Engine est exécutée sur des environnements d'exécution de deuxième génération (>= Go 1.11).
func IsStandard
func IsStandard() boolLa fonction IsStandard indique si l'application App Engine est en cours d'exécution dans l'environnement standard. Cela inclut à la fois les environnements d'exécution de première génération (<= Go 1.9) et de deuxième génération (>= Go 1.11).
func IsTimeoutError
La fonction IsTimeoutError indique si "err" représente une erreur de dépassement de délai.
func Main
func Main()La fonction Main est le point d'entrée principal d'une application s'exécutant dans App Engine.
Dans l'environnement flexible App Engine, elle installe un vérificateur d'état simple si celui-ci n'est pas déjà enregistré et commence à écouter sur le port 8080 (remplacé par la variable d'environnement $PORT).
Consultez la page https://cloud.google.com/appengine/docs/flexible/custom-runtimes#health_check_requests pour savoir comment effectuer votre propre vérification d'état.
Dans l'environnement standard App Engine, elle vérifie que le serveur est démarré et prêt à recevoir des requêtes.
La fonction Main ne renvoie jamais de données.
Elle est conçue de sorte que le package principal de l'application se présente comme suit :
package main
import (
"google.golang.org/appengine"
_ "myapp/package0"
_ "myapp/package1"
)
func main() {
appengine.Main()
}
Les packages "myapp/packageX" doivent enregistrer les gestionnaires HTTP dans leurs fonctions init.
func ModuleHostname
La fonction ModuleHostname affiche le nom d'hôte d'une instance de module. Si la chaîne spécifiant le module n'est pas renseignée, l'argument fait référence au module de l'instance en cours. Si la chaîne spécifiant la version n'est pas renseignée, l'argument fait référence à la version de l'instance en cours si elle est valide, ou à la version par défaut du module de l'instance en cours. Si la chaîne spécifiant l'instance n'est pas renseignée, ModuleHostname affiche le nom d'hôte de l'équilibrage de charge.
func ModuleName
La fonction ModuleName affiche le nom de module de l'instance en cours.
func Namespace
La fonction Namespace affiche un contexte de remplacement qui opère dans l'espace de nommage donné.
func NewContext
La fonction NewContext affiche un contexte pour une requête HTTP en transit. Cette fonction est peu coûteuse.
func RequestID
La fonction RequestID affiche une chaîne qui identifie de manière unique la requête.
func ServerSoftware
func ServerSoftware() stringLa fonction ServerSoftware affiche la version d'App Engine. Dans un environnement de production, le résultat obtenu ressemble à "Google App Engine/XYZ". Dans le serveur d'applications de développement, le résultat obtenu ressemble à "Developpement/XY".
func ServiceAccount
La fonction ServiceAccount affiche une chaîne représentant le nom du compte de service, sous la forme d'une adresse e-mail (généralement app_id@appspot.gserviceaccount.com).
func SignBytes
La fonction SignBytes signe des octets à l'aide d'une clé privée propre à votre application.
func VersionID
La fonction VersionID affiche l'ID de version de l'application en cours. Cet ID est présenté sous la forme "X.Y", où X est spécifié dans le fichier "app.yaml", et Y est un nombre généré lors du transfert de chaque version de l'application. Cet ID n'inclut pas de nom de module.
func WithAPICallFunc
func WithAPICallFunc(ctx context.Context, f APICallFunc) context.ContextLa fonction WithAPICallFunc renvoie une copie du contexte parent qui conduira les appels d'API à appeler f au lieu de fonctionner normalement.
Elle est réservée aux utilisateurs avancés.
func WithContext
La fonction WithContext affiche une copie du contexte parent et l'associe à une requête HTTP en transit. Cette fonction est peu coûteuse.
APICallFunc
La fonction APICallFunc définit un type de fonction permettant de gérer un appel d'API. Voir WithCallOverride.
BlobKey
type BlobKey stringLe type BlobKey représente une clé pour un objet blob Blobstore.
Ce type appartient au package Blobstore, mais il réside dans le package App Engine afin d'éviter une dépendance circulaire : Blobstore dépend du datastore et ce dernier doit se référer au type BlobKey.
Certificate
Le type Certificate représente un certificat public pour l'application.
func PublicCertificates
func PublicCertificates(c context.Context) ([]Certificate, error)La fonction PublicCertificates récupère les certificats publics de l'application. Ceux-ci peuvent être utilisés pour vérifier une signature renvoyée par SignBytes.
GeoPoint
type GeoPoint struct {
Lat, Lng float64
}Le type GeoPoint représente une position sous forme de latitude/longitude en degrés.
func (GeoPoint) Valid
La fonction Valid indique si un point GeoPoint est situé entre [-90, 90] de latitude et [-180, 180] de longitude.
MultiError
type MultiError []errorLe type MultiError est affiché par des opérations de traitement par lot en cas d'erreurs avec des éléments particuliers. Les erreurs sont présentées en correspondance avec chaque élément d'entrée ; les éléments exécutés avec succès sont représentés par une entrée nulle.
func (MultiError) Error
func (m MultiError) Error() string