Package App Engine

import "google.golang.org/appengine"

Présentation

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/standard/go/.

Index

func AccessToken(c context.Context, scopes ...string) (token string, expiry time.Time, err error)
func AppID(c context.Context) string
func Datacenter(c context.Context) string
func DefaultVersionHostname(c context.Context) string
func InstanceID() string
func IsDevAppServer() bool
func IsOverQuota(err error) bool
func IsTimeoutError(err error) bool
func ModuleHostname(c context.Context, module, version, instance string) (string, error)
func ModuleName(c context.Context) string
func Namespace(c context.Context, namespace string) (context.Context, error)
func NewContext(req *http.Request) context.Context
func PublicCertificates(c context.Context) ([]Certificate, error)
func RequestID(c context.Context) string
func ServerSoftware() string
func ServiceAccount(c context.Context) (string, error)
func SignBytes(c context.Context, bytes []byte) (keyName string, signature []byte, err error)
func VersionID(c context.Context) string
func WithContext(parent context.Context, req *http.Request) context.Context
type BlobKey
type Certificate
type GeoPoint
    func (g GeoPoint) Valid() bool
type MultiError
    func (m MultiError) Error() string

func AccessToken

func AccessToken(c context.Context, scopes ...string) (token string, expiry time.Time, err error)

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

func AppID(c context.Context) string

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 Datacenter

func Datacenter(c context.Context) string

La fonction Datacenter affiche un identifiant correspondant au centre de données dans lequel l'instance est en cours d'exécution.

func DefaultVersionHostname

func DefaultVersionHostname(c context.Context) string

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() string

La fonction InstanceID affiche un identifiant unique correspondant à l'instance concernée.

func IsDevAppServer

func IsDevAppServer() bool

La fonction IsDevAppServer indique si l'application App Engine est en cours d'exécution sur le serveur d'applications de développement.

func IsOverQuota

func IsOverQuota(err error) bool

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 IsTimeoutError

func IsTimeoutError(err error) bool

La fonction IsTimeoutError indique si "err" représente une erreur de dépassement de délai.

func ModuleHostname

func ModuleHostname(c context.Context, module, version, instance string) (string, error)

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

func ModuleName(c context.Context) string

La fonction ModuleName affiche le nom de module de l'instance en cours.

func Namespace

func Namespace(c context.Context, namespace string) (context.Context, error)

La fonction Namespace affiche un contexte de remplacement qui opère dans l'espace de nommage donné.

func NewContext

func NewContext(req *http.Request) context.Context

La fonction NewContext affiche un contexte pour une requête HTTP en transit. Cette fonction est peu coûteuse.

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.

func RequestID

func RequestID(c context.Context) string

La fonction RequestID affiche une chaîne qui identifie de manière unique la requête.

func ServerSoftware

func ServerSoftware() string

La 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

func ServiceAccount(c context.Context) (string, error)

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

func SignBytes(c context.Context, bytes []byte) (keyName string, signature []byte, err error)

La fonction SignBytes signe des octets à l'aide d'une clé privée propre à votre application.

func VersionID

func VersionID(c context.Context) string

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 WithContext

func WithContext(parent context.Context, req *http.Request) context.Context

La fonction WithContext affiche une copie du contexte parent et l'associe à une requête HTTP en transit. Cette fonction est peu coûteuse.

type BlobKey

type BlobKey string

Le 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.

type Certificate

type Certificate struct {
    KeyName string
    Data    []byte // PEM-encoded X.509 certificate
}

Le type Certificate représente un certificat public pour l'application.

type 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

func (g GeoPoint) Valid() bool

La fonction Valid indique si un point GeoPoint est situé entre [-90, 90] de latitude et [-180, 180] de longitude.

type MultiError

type MultiError []error

Le 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