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

Version latest

• 1.6.8 (latest)
• 1.6.7

Catatan: Untuk mendapatkan informasi selengkapnya tentang paket ini, seperti akses ke versi yang lebih lama, lihat paket ini di pkg.go.dev.

Paket appengine menyediakan fungsi dasar untuk Google App Engine.

Untuk informasi selengkapnya tentang cara menulis aplikasi Go untuk Google App Engine, lihat: https://cloud.google.com/appengine/docs/go/

Variabel

Middleware

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

Middleware menggabungkan pengendali http agar dapat melakukan panggilan API GAE

Functions

func APICall

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

APICall melakukan panggilan API.

Hal ini tidak dimaksudkan untuk penggunaan umum; fungsi ini diekspor untuk digunakan bersama WithAPICallFunc.

func AccessToken

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

AccessToken menghasilkan token akses OAuth2 untuk cakupan yang ditentukan atas nama akun layanan aplikasi ini. Masa berlaku token ini akan berakhir setelah waktu yang ditampilkan.

func AppID

func AppID(c context.Context) string

AppID menampilkan ID aplikasi untuk aplikasi saat ini. String akan berupa ID aplikasi biasa (misalnya "appid"), dengan awalan domain untuk deployment domain kustom (misalnya "example.com:appid").

func BackgroundContext (tidak digunakan lagi)

func BackgroundContext() context.Context

BackgroundContext menampilkan konteks yang tidak terkait dengan permintaan.

Tidak digunakan lagi: App Engine tidak lagi memiliki konteks latar belakang khusus. Cukup gunakan context.Background().

func Datacenter

func Datacenter(c context.Context) string

Datacenter menampilkan ID untuk pusat data tempat instance berjalan.

func DefaultVersionHostname

func DefaultVersionHostname(c context.Context) string

DefaultVersionHostname menampilkan nama host standar dari versi default aplikasi saat ini (misalnya "my-app.appspot.com"). Ini cocok untuk digunakan dalam membuat URL.

func InstanceID

func InstanceID() string

InstanceID menampilkan ID yang sebagian besar unik untuk instance ini.

func IsAppEngine

func IsAppEngine() bool

IsAppEngine melaporkan apakah aplikasi App Engine berjalan di App Engine, baik dalam lingkungan standar maupun fleksibel.

func IsDevAppServer

func IsDevAppServer() bool

IsDevAppServer melaporkan apakah aplikasi App Engine berjalan di Server Aplikasi pengembangan.

func IsFlex

func IsFlex() bool

IsFlex melaporkan apakah aplikasi App Engine berjalan di lingkungan fleksibel.

func IsOverQuota

func IsOverQuota(err error) bool

IsOverQuota melaporkan apakah error menampilkan kegagalan panggilan API karena kuota yang tersedia tidak mencukupi.

func IsSecondGen

func IsSecondGen() bool

IsSecondGen melaporkan apakah aplikasi App Engine berjalan pada runtime generasi kedua (>= Go 1.11).

func IsStandard

func IsStandard() bool

IsStandard melaporkan apakah aplikasi App Engine berjalan di lingkungan standar. Ini mencakup runtime generasi pertama (<= Go 1.9) dan runtime generasi kedua (>= Go 1.11).

func IsTimeoutError

func IsTimeoutError(err error) bool

IsTimeoutError melaporkan apakah error adalah error waktu tunggu.

func Main

func Main()

Main adalah titik entri utama untuk aplikasi yang berjalan di App Engine.

Di App Engine Fleksibel, fungsi ini akan menginstal health checker sederhana jika belum ada health checker yang terdaftar, dan mulai memproses port 8080 (diganti oleh variabel lingkungan $PORT).

Lihat https://cloud.google.com/appengine/docs/flexible/custom-runtimes#health_check_requests untuk mengetahui detail tentang cara melakukan health check Anda sendiri.

Pada App Engine Standar, fungsi ini memastikan server telah dimulai dan siap untuk menerima permintaan.

Fungsi Main tidak pernah menampilkan hasil.

Main didesain agar paket utama aplikasi terlihat seperti ini:

package main

import (
        "google.golang.org/appengine"

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

func main() {
        appengine.Main()
}

Paket "myapp/packageX" diharapkan untuk mendaftarkan pengendali HTTP dalam fungsi init-nya.

func ModuleHostname

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

ModuleHostname menampilkan nama host instance modul. Jika modul adalah string kosong, fungsi ini akan mengacu pada modul instance saat ini. Jika versi kosong, fungsi ini akan mengacu pada versi instance saat ini jika valid, atau versi default modul instance saat ini. Jika instance kosong, ModuleHostname akan menampilkan nama host load balancing.

func ModuleName

func ModuleName(c context.Context) string

ModuleName menampilkan nama modul instance saat ini.

func Namespace

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

Namespace menampilkan konteks pengganti yang beroperasi dalam namespace yang diberikan.

func NewContext

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

NewContext menampilkan konteks untuk permintaan HTTP yang sedang berlangsung. Fungsi ini murah.

func RequestID

func RequestID(c context.Context) string

RequestID menampilkan string yang mengidentifikasi permintaan secara unik.

func ServerSoftware

func ServerSoftware() string

ServerSoftware menampilkan versi rilis App Engine. Dalam produksi, tulisannya akan terlihat seperti "Google App Engine/X.Y.Z". Di appserver pengembangan, tulisannya akan terlihat seperti "Development/X.Y".

func ServiceAccount

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

ServiceAccount menampilkan string yang mewakili nama akun layanan, dalam bentuk alamat email (biasanya [e-mail]).

func SignBytes

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

SignBytes menandatangani byte menggunakan kunci pribadi yang unik untuk aplikasi Anda.

func VersionID

func VersionID(c context.Context) string

VersionID menampilkan ID versi untuk aplikasi saat ini. Nilainya akan berupa "X.Y", dengan X ditentukan dalam app.yaml, dan Y adalah angka yang dihasilkan saat setiap versi aplikasi diupload. Versi tidak menyertakan nama modul.

func WithAPICallFunc

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

WithAPICallFunc menampilkan salinan konteks induk yang akan menyebabkan panggilan API memanggil f, bukan operasi normalnya.

Fungsi ini hanya ditujukan untuk pengguna tingkat lanjut.

func WithContext

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

WithContext menampilkan salinan konteks induk dan mengaitkannya dengan permintaan HTTP yang sedang berlangsung. Fungsi ini murah.

APICallFunc

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

APICallFunc menentukan jenis fungsi untuk menangani panggilan API. Lihat WithCallOverride.

BlobKey

type BlobKey string

BlobKey adalah kunci untuk blob blobstore.

Secara konseptual, jenis ini termasuk dalam paket blobstore, tetapi berada dalam paket appengine untuk menghindari dependensi melingkar: blobstore bergantung pada datastore, dan datastore harus merujuk ke jenis BlobKey.

Certificate

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

Certificate mewakili sertifikat publik untuk aplikasi.

func PublicCertificates

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

PublicCertificate mengambil sertifikat publik untuk aplikasi. Sertifikat ini dapat digunakan untuk memverifikasi tanda tangan yang ditampilkan oleh SignBytes.

GeoPoint

type GeoPoint struct {
	Lat, Lng float64
}

GeoPoint mewakili lokasi sebagai garis lintang/bujur dalam derajat.

func (GeoPoint) Valid

func (g GeoPoint) Valid() bool

Valid menampilkan apakah GeoPoint berada dalam lintang [-90, 90] dan garis bujur [-180, 180].

MultiError

type MultiError []error

MultiError ditampilkan oleh operasi batch jika terjadi error pada elemen tertentu. Error akan terjadi dalam korespondensi one-to-one dengan elemen input; elemen yang berhasil akan memiliki entri nil.

func (MultiError) Error

func (m MultiError) Error() string