Pacchetto google.golang.org/appengine (v1.6.8)

Il pacchetto appengine fornisce funzionalità di base per Google App Engine.

Per ulteriori informazioni su come scrivere app Go per Google App Engine, consulta: https://cloud.google.com/appengine/docs/go/

Variabili

Middleware

var Middleware func(http.Handler) http.Handler = internal.Middleware

Il middleware aggrega un gestore http in modo che possa effettuare chiamate API GAE

Funzioni

chiamata API func 

func APICall(ctx context.Context, service, method string, in, out proto.Message) error

APICall esegue una chiamata API.

Non è destinato a un uso generale; viene esportato per l'utilizzo insieme a WithAPICallFunc.

AccessToken func 

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

AccessToken genera un token di accesso OAuth2 per gli ambiti specificati per conto dell'account di servizio di questa applicazione. Questo token scadrà dopo il periodo di tempo restituito.

ID app funzione 

func AppID(c context.Context) string

AppID restituisce l'ID applicazione dell'applicazione corrente. La stringa sarà un ID applicazione semplice (ad es. "appid"), con un prefisso di dominio per i deployment di domini personalizzati (ad es. "example.com:appid").

funzione BackgroundContext (deprecata)

func BackgroundContext() context.Context

BackgroundContext restituisce un contesto non associato a una richiesta.

Deprecato: App Engine non ha più un contesto di background speciale. È sufficiente utilizzare contesto.Background().

Data center func 

func Datacenter(c context.Context) string

Il data center restituisce un identificatore per il data center in cui è in esecuzione l'istanza.

funcDefaultVersionNome host 

func DefaultVersionHostname(c context.Context) string

defaultVersionHostname restituisce il nome host standard della versione predefinita dell'applicazione corrente (ad es. "my-app.appspot.com"). È adatto alla creazione di URL.

ID istanza func 

func InstanceID() string

InstanceID restituisce un identificatore principalmente univoco per questa istanza.

funzione IsAppEngine 

func IsAppEngine() bool

IsAppEngine indica se l'app App Engine è in esecuzione su App Engine, nell'ambiente standard o flessibile.

funzione IsDevAppServer 

func IsDevAppServer() bool

IsDevAppServer indica se l'app App Engine è in esecuzione in App Server di sviluppo.

funzione IsFlex 

func IsFlex() bool

IsFlex indica se l'app App Engine è in esecuzione nell'ambiente flessibile.

Quota in eccesso func 

func IsOverQuota(err error) bool

IsOverQuota indica se err rappresenta un errore di chiamata API a causa di una quota disponibile insufficiente.

funzione seconda generazione 

func IsSecondGen() bool

IsSecondGen indica se l'app App Engine è in esecuzione sui runtime di seconda generazione (>= Go 1.11).

funzione IsStandard 

func IsStandard() bool

IsStandard indica se l'app App Engine è in esecuzione nell'ambiente standard. Sono inclusi sia i runtime di prima generazione (<= Go 1.9) che i runtime di seconda generazione (>= Go 1.11).

funzione IsTimeoutError 

func IsTimeoutError(err error) bool

IsTimeoutError indica se err è un errore di timeout.

funzione Principale 

func Main()

Il principale è il punto di ingresso principale per un'app in esecuzione in App Engine.

Nell'ambiente flessibile di App Engine, installa un controllo di integrità banale se uno non è già registrato e avvia l'ascolto sulla porta 8080 (sovrascritto dalla variabile di ambiente $PORT).

Consulta la pagina https://cloud.google.com/appengine/docs/flexible/custom-runtimes#health_check_requests per maggiori dettagli su come eseguire il controllo di integrità personale.

Nell'ambiente standard di App Engine, assicura che il server sia stato avviato e sia pronto a ricevere le richieste.

L'elemento principale non torna mai.

L'elemento principale è progettato in modo che il pacchetto principale dell'app sia simile al seguente:

package main

import (
        "google.golang.org/appengine"

        _ "myapp/package0"
        _ "myapp/package1"
)

func main() {
        appengine.Main()
}

I pacchetti "myapp/packageX" devono registrare i gestori HTTP nelle loro funzioni init.

funzione ModuloNome host 

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

ModuleHostname restituisce un nome host di un'istanza di modulo. Se il modulo è la stringa vuota, si riferisce al modulo dell'istanza corrente. Se la versione è vuota, si riferisce alla versione dell'istanza corrente, se valida, o alla versione predefinita del modulo dell'istanza corrente. Se l'istanza è vuota, ModuleHostname restituisce il nome host di bilanciamento del carico.

NomeModulo funzione 

func ModuleName(c context.Context) string

ModuleName restituisce il nome del modulo dell'istanza corrente.

Spazio dei nomi func 

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

Lo spazio dei nomi restituisce un contesto sostitutivo che opera all'interno dello spazio dei nomi specificato.

funzione NewContext 

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

NewContext restituisce un contesto per una richiesta HTTP in corso. Questa funzione è economica.

ID richiesta funzione 

func RequestID(c context.Context) string

RequestID restituisce una stringa che identifica in modo univoco la richiesta.

ServerSoftware func 

func ServerSoftware() string

ServerSoftware restituisce la versione di release di App Engine. In produzione, il codice è simile a "Google App Engine/X.Y.Z". Nell'appserver di sviluppo, ha il formato "Sviluppo/X.Y".

account di servizio func 

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

ServiceAccount restituisce una stringa che rappresenta il nome dell'account di servizio sotto forma di indirizzo email (in genere app_id@appspot.gserviceaccount.com).

SignBytes func 

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

SignBytes firma i byte utilizzando una chiave privata univoca per l'applicazione.

ID versione funzione 

func VersionID(c context.Context) string

VersionID restituisce l'ID versione dell'applicazione corrente. avrà il formato "X.Y", dove X è specificato in app.yaml e Y è un numero generato quando viene caricata ogni versione dell'app. Non include un nome di modulo.

funzione ConAPICallFunc 

func WithAPICallFunc(ctx context.Context, f APICallFunc) context.Context

WithAPICallFunc restituisce una copia del contesto principale che fa sì che le chiamate API chiamino f invece della loro normale operazione.

Solo per utenti esperti.

funzione ConContesto 

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

WithContext restituisce una copia del contesto padre e la associa a una richiesta HTTP in corso. Questa funzione è economica.

Func.call.API

type APICallFunc func(ctx context.Context, service, method string, in, out proto.Message) error

APICallFunc definisce un tipo di funzione per la gestione di una chiamata API. Vedi WithCallOverride.

BlobKey

type BlobKey string

BlobKey è la chiave per un BLOB di archivio.

Concettualmente, questo tipo appartiene al pacchetto blobstore, ma risiede nel pacchetto appengine per evitare una dipendenza circolare: il blobstore dipende dal datastore e il datastore deve fare riferimento al tipo BlobKey.

Certificato

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

Il certificato rappresenta un certificato pubblico per l'app.

Certificati pubblici func 

func PublicCertificates(c context.Context) ([]Certificate, error)

PublicCertificates recupera i certificati pubblici dell'app. Possono essere utilizzati per verificare una firma restituita da SignBytes.

GeoPoint

type GeoPoint struct {
	Lat, Lng float64
}

GeoPoint rappresenta una posizione espressa in gradi latitudine/longitudine.

func (GeoPoint) Valido 

func (g GeoPoint) Valid() bool

Valido restituisce se un GeoPoint è compreso tra [-90, 90] latitudine e [-180, 180] longitudine.

Errore multiplo

type MultiError []error

MultiError viene restituito dalle operazioni batch quando si verificano errori con determinati elementi. Gli errori saranno in una corrispondenza one-to-one con gli elementi di input; gli elementi con esito positivo avranno una voce nulla.

Errore func (MultiError) 

func (m MultiError) Error() string