İşlevler
| İşlev | Açıklama |
|---|---|
| config() | Üçüncü taraf API anahtarları veya diğer ayarlar gibi proje yapılandırma verilerini depolayın ve alın. Firebase CLI'yı kullanarak yapılandırma değerlerini [Ortam Yapılandırması](/docs/functions/config-env) bölümünde açıklandığı şekilde ayarlayabilirsiniz. |
| optionsToEndpoint(options) | |
| optionsToTrigger(options) | |
| region(bölge) | İşlevin dağıtıldığı bölgeleri yapılandırın. |
| runWith(runtimeOptions) | İşlev için çalışma zamanı seçeneklerini yapılandırın. |
Sınıflar
| Sınıf | Açıklama |
|---|---|
| Değiştir | Realtime Database veya Cloud Firestore onWrite ve onUpdate etkinlikleri gibi durumu değişen etkinliklerin Cloud Functions arayüzü.Change nesnelerini oluşturmak için kullanılan biçim hakkında daha fazla bilgi için aşağıya bakın. |
| İşlev Oluşturucu |
Arayüzler
| Arayüz | Açıklama |
|---|---|
| Engelleme İşlevi | Kimlik Doğrulama Engelleme tetikleyicilerinin işlev türü. |
| CloudFunction | HTTPS olmayan tüm tetikleyicilerin işlev türü. Bu kod, bir Cloud Functions işlevi tanımlamak için JavaScript dosyanızdan dışa aktarılmalıdır.Bu tür, şablonlu bir Event nesnesini tek bağımsız değişkeni olarak alan özel bir JavaScript işlevidir. |
| DeploymentOptions | İşlev dağıtımı sırasında geçerli olan bir işlevin yapılandırma seçenekleri. |
| Etkinlik | Etkinlik için kablolu yayın biçimi. |
| EtkinlikBağlamı | Bir etkinliğin gerçekleştiği bağlam. |
| FailurePolicy | Arka plan işlevleriyle ilgili hata politikası için yapılandırma seçeneği. |
| HttpsFunction | HTTPS tetikleyicilerinin işlev türü. Bir Cloud Functions işlevi tanımlamak için bu komut, JavaScript dosyanızdan dışa aktarılmalıdır. |
| Kaynak | Kaynak, bir kaynağı tanımlamak için kullanılan standart bir biçimdir (google.rpc.context.AttributeContext.Resource). Cloud Functions'da işlevi tetikleyen kaynak (ör. depolama paketidir). |
| Çalıştırılabilir | Çalıştırılabilir öğe, birim testi için yararlı olan ve kullanıcı tanımlı işlevi doğrudan çağıran bir run yöntemine sahiptir. |
| Çalışma Zamanı Seçenekleri | Çalışma zamanında uygulanabilecek bir işlev için yapılandırma seçenekleri. |
| Görüşme ayarlayın | Programlanan işlevler için yapılandırma seçenekleri. |
| ScheduleRetryConfig | Planlayıcı yeniden deneme seçenekleri. Yalnızca programlanan işlevler için geçerlidir. |
Ad alanları
| Ad alanı | Açıklama |
|---|---|
| analiz | |
| kimlik doğrulama | |
| veritabanı | |
| firestore | |
| https | |
| logger | |
| params | |
| pubsub | |
| remoteConfig | |
| depolama alanı | |
| görevler | |
| testLab |
Değişkenler
| Değişken | Açıklama |
|---|---|
| uygulama | |
| VARSAYILAN_HATA_POLİTİKASI | |
| INGRESS_SETTINGS_OPTIONS | IngressSettings için kullanılabilir seçeneklerin listesi. |
| MAX_NUMBER_USER_LABELS | |
| MAX_TIMEOUT_SECONDS | Cloud Functions maksimum zaman aşımı değeri. |
| MIN_TIMEOUT_SECONDS | Cloud Functions minimum zaman aşımı değeri. |
| SIFIR_DEĞERİ | Yapılandırmayı platform varsayılanına sıfırlamak için kullanılan özel yapılandırma değeri. |
| SUPPORTED_BÖLGELER | Cloud Functions tarafından desteklenen tüm bölgelerin listesi. |
| DOĞRU_MEMORY_OPTIONS | Cloud Functions tarafından desteklenen kullanılabilir bellek seçeneklerinin listesi. |
| VPC_EGRESS_SETTINGS_OPTIONS | VpcConnectorEgressSettings için kullanılabilir seçeneklerin listesi. |
yapılandırma()
Üçüncü taraf API anahtarları veya diğer ayarlar gibi proje yapılandırma verilerini depolayın ve alın. Firebase CLI'yı kullanarak yapılandırma değerlerini [Ortam Yapılandırması](/docs/functions/config-env) bölümünde açıklandığı şekilde ayarlayabilirsiniz.
İmza:
export declare function config(): Record<string, any>;
Şunu döndürür:
Kayıt<dize, herhangi bir>
optionsToEndpoint()
İmza:
export declare function optionsToEndpoint(options: DeploymentOptions): ManifestEndpoint;
Parametreler
| Parametre | Tür | Açıklama |
|---|---|---|
| seçenekler | DeploymentOptions |
Şunu döndürür:
Manifest Uç Noktası
optionsToTrigger()
İmza:
export declare function optionsToTrigger(options: DeploymentOptions): any;
Parametreler
| Parametre | Tür | Açıklama |
|---|---|---|
| seçenekler | DeploymentOptions |
Şunu döndürür:
herhangi bir
bölge()
İşlevin dağıtıldığı bölgeleri yapılandırın.
İmza:
export declare function region(...regions: Array<(typeof SUPPORTED_REGIONS)[number] | string | Expression<string> | ResetValue>): FunctionBuilder;
Parametreler
| Parametre | Tür | Açıklama |
|---|---|---|
| bölgeler | Dizi<(typeof SUPPORTED_REGIONS)[number] | dize | İfade<string> | Değeri Sıfırla> | Bir veya daha fazla bölge dizesi. |
Şunu döndürür:
1. örnek
Functions.region('us-east1')
2. örnek
Functions.region('us-east1', 'us-central1')
çalıştır
İşlev için çalışma zamanı seçeneklerini yapılandırın.
İmza:
export declare function runWith(runtimeOptions: RuntimeOptions): FunctionBuilder;
Parametreler
| Parametre | Tür | Açıklama |
|---|---|---|
| çalışma zamanıSeçenekleri | Çalışma Zamanı Seçenekleri | İsteğe bağlı alanları olan nesne: 1. memory: İşleve ayrılacak bellek miktarı; olası değerler şunlardır: "128 MB", "256 MB", "512 MB", "1 GB", "2 GB", "4 GB" ve "8 GB". 2. timeoutSeconds: İşlev için saniye cinsinden zaman aşımı, olası değerler 0 ile 540 arasındadır. 3. failurePolicy: İşlevin hata politikası; true boole değeri, boş bir yeniden deneme nesnesi sağlamaya eşdeğerdir. 4. vpcConnector: Aynı proje ve bölgedeki bir VPC bağlayıcısının kimliği. 5. vpcConnectorEgressSettings: Bir vpcConnector ayarlandığında vpcConnector üzerinden hangi çıkış trafiğinin gönderileceğini kontrol edin. 6. serviceAccount: İşlev için belirli hizmet hesabı. 7. ingressSettings: İşlev için, HTTPS işlevinin nereden çağrılabileceğini kontrol eden giriş ayarları.Değer boş olmamalıdır. |
Şunu döndürür:
uygulama
İmza:
app: {
setEmulatedAdminApp: typeof setEmulatedAdminApp;
}
VARSAYILAN_HATA_POLİTİKASI
İmza:
DEFAULT_FAILURE_POLICY: FailurePolicy
INGRESS_SETTINGS_OPTIONS
IngressSettings için kullanılabilir seçeneklerin listesi.
İmza:
INGRESS_SETTINGS_OPTIONS: readonly ["INGRESS_SETTINGS_UNSPECIFIED", "ALLOW_ALL", "ALLOW_INTERNAL_ONLY", "ALLOW_INTERNAL_AND_GCLB"]
MAK_NUMBER_USER_LABELS
İmza:
MAX_NUMBER_USER_LABELS = 58
MAK_TIMEOUT_SECONDS
Cloud Functions maksimum zaman aşımı değeri.
İmza:
MAX_TIMEOUT_SECONDS = 540
MIN_TIMEOUT_SECONDS
Cloud Functions minimum zaman aşımı değeri.
İmza:
MIN_TIMEOUT_SECONDS = 0
RESET_VALUE
Yapılandırmayı platform varsayılanına sıfırlamak için kullanılan özel yapılandırma değeri.
İmza:
RESET_VALUE: ResetValue
SUPPORTED_BÖLGELER
Cloud Functions tarafından desteklenen tüm bölgelerin listesi.
İmza:
SUPPORTED_REGIONS: readonly ["us-central1", "us-east1", "us-east4", "us-west2", "us-west3", "us-west4", "europe-central2", "europe-west1", "europe-west2", "europe-west3", "europe-west6", "asia-east1", "asia-east2", "asia-northeast1", "asia-northeast2", "asia-northeast3", "asia-south1", "asia-southeast1", "asia-southeast2", "northamerica-northeast1", "southamerica-east1", "australia-southeast1"]
GEÇERLİ_MEMORY_OPTIONS
Cloud Functions tarafından desteklenen kullanılabilir bellek seçeneklerinin listesi.
İmza:
VALID_MEMORY_OPTIONS: readonly ["128MB", "256MB", "512MB", "1GB", "2GB", "4GB", "8GB"]
VPC_EGRESS_SETTINGS_OPTIONS
VpcConnectorEgressSettings için kullanılabilir seçeneklerin listesi.
İmza:
VPC_EGRESS_SETTINGS_OPTIONS: readonly ["VPC_CONNECTOR_EGRESS_SETTINGS_UNSPECIFIED", "PRIVATE_RANGES_ONLY", "ALL_TRAFFIC"]