ฟังก์ชั่น
| การทำงาน | คำอธิบาย |
|---|---|
| กำหนดค่า() | จัดเก็บและดึงข้อมูลการกำหนดค่าโปรเจ็กต์ เช่น คีย์ API ของบริษัทอื่นหรือการตั้งค่าอื่นๆ คุณสามารถตั้งค่าการกำหนดค่าได้โดยใช้ Firebase CLI ตามที่อธิบายไว้ใน [การกำหนดค่าสภาพแวดล้อม](/docs/functions/config-env) |
| optionsToEndpoint(ตัวเลือก) | |
| optionsToTrigger (ตัวเลือก) | |
| ภูมิภาค(ภูมิภาค) | กำหนดค่าภูมิภาคที่จะปรับใช้ฟังก์ชันนี้ |
| runWith (รันไทม์ตัวเลือก) | กำหนดค่าตัวเลือกรันไทม์สำหรับฟังก์ชัน |
ชั้นเรียน
| ระดับ | คำอธิบาย |
|---|---|
| เปลี่ยน | อินเทอร์เฟซ Cloud Functions สำหรับเหตุการณ์ที่เปลี่ยนสถานะ เช่น Realtime Database หรือ Cloud Firestore onWrite และ onUpdate events สำหรับข้อมูลเพิ่มเติมเกี่ยวกับรูปแบบที่ใช้ในการสร้างวัตถุ Change โปรดดูด้านล่าง |
| FunctionBuilder |
อินเทอร์เฟซ
| อินเตอร์เฟซ | คำอธิบาย |
|---|---|
| การปิดกั้นฟังก์ชั่น | ประเภทฟังก์ชันสำหรับทริกเกอร์การบล็อกการตรวจสอบสิทธิ์ |
| คลาวด์ฟังก์ชัน | ประเภทฟังก์ชันสำหรับทริกเกอร์ที่ไม่ใช่ HTTPS ทั้งหมด สิ่งนี้ควรส่งออกจากไฟล์ JavaScript ของคุณเพื่อกำหนดฟังก์ชันคลาวด์ ประเภทนี้เป็นฟังก์ชัน JavaScript พิเศษซึ่งรับออบ Event ที่มีเทมเพลตเป็นอาร์กิวเมนต์เดียว |
| ตัวเลือกการปรับใช้ | ตัวเลือกการกำหนดค่าสำหรับฟังก์ชันที่ใช้ในระหว่างการปรับใช้ฟังก์ชัน |
| เหตุการณ์ | รูปแบบลวดสำหรับกิจกรรม |
| บริบทเหตุการณ์ | บริบทที่เกิดเหตุการณ์ |
| นโยบายความล้มเหลว | ตัวเลือกการกำหนดค่าสำหรับนโยบายความล้มเหลวในฟังก์ชันเบื้องหลัง |
| HttpsFunction | ประเภทฟังก์ชันสำหรับทริกเกอร์ HTTPS สิ่งนี้ควรส่งออกจากไฟล์ JavaScript ของคุณเพื่อกำหนดฟังก์ชันคลาวด์ |
| ทรัพยากร | ทรัพยากรเป็นรูปแบบมาตรฐานสำหรับการกำหนดทรัพยากร (google.rpc.context.AttributeContext.Resource) ใน Cloud Functions เป็นทรัพยากรที่ทริกเกอร์ฟังก์ชัน เช่น ที่เก็บข้อมูล |
| รันได้ | Runnable มีวิธี run ซึ่งเรียกใช้ฟังก์ชันที่ผู้ใช้กำหนดโดยตรง - มีประโยชน์สำหรับการทดสอบหน่วย |
| ตัวเลือกรันไทม์ | ตัวเลือกการกำหนดค่าสำหรับฟังก์ชันที่ใช้งานได้ในขณะรันไทม์ |
| กำหนดการ | ตัวเลือกการกำหนดค่าสำหรับฟังก์ชันที่กำหนดเวลาไว้ |
| ScheduleRetryConfig | ตัวเลือกการลองใหม่อีกครั้งของตัวกำหนดเวลา ใช้กับฟังก์ชันที่กำหนดเวลาไว้เท่านั้น |
เนมสเปซ
| เนมสเปซ | คำอธิบาย |
|---|---|
| การวิเคราะห์ | |
| รับรองความถูกต้อง | |
| ฐานข้อมูล | |
| ร้านขายไฟ | |
| https | |
| คนตัดไม้ | |
| พารามิเตอร์ | |
| ผับซับ | |
| การกำหนดค่าระยะไกล | |
| พื้นที่จัดเก็บ | |
| งาน | |
| ทดสอบแล็บ |
ตัวแปร
| ตัวแปร | คำอธิบาย |
|---|---|
| แอป | |
| DEFAULT_FAILURE_POLICY | |
| INGRESS_SETTINGS_OPTIONS | รายการตัวเลือกที่ใช้ได้สำหรับ IngressSettings |
| MAX_NUMBER_USER_LABELS | |
| MAX_TIMEOUT_SECONDS | ค่าการหมดเวลาสูงสุดของฟังก์ชันคลาวด์ |
| MIN_TIMEOUT_SECONDS | ค่าการหมดเวลาขั้นต่ำของฟังก์ชันคลาวด์ |
| รีเซ็ต_VALUE | ค่าการกำหนดค่าพิเศษเพื่อรีเซ็ตการกำหนดค่าเป็นค่าเริ่มต้นของแพลตฟอร์ม |
| สนับสนุน_ภูมิภาค | รายชื่อภูมิภาคทั้งหมดที่รองรับโดย Cloud Functions |
| VALID_MEMORY_OPTIONS | รายการตัวเลือกหน่วยความจำที่ใช้งานได้ซึ่งรองรับโดย Cloud Functions |
| VPC_EGRESS_SETTINGS_OPTIONS | รายการตัวเลือกที่ใช้ได้สำหรับ VpcConnectorEgressSettings |
กำหนดค่า()
จัดเก็บและดึงข้อมูลการกำหนดค่าโปรเจ็กต์ เช่น คีย์ API ของบริษัทอื่นหรือการตั้งค่าอื่นๆ คุณสามารถตั้งค่าการกำหนดค่าได้โดยใช้ Firebase CLI ตามที่อธิบายไว้ใน [การกำหนดค่าสภาพแวดล้อม](/docs/functions/config-env)
ลายเซ็น:
export declare function config(): Record<string, any>;
ผลตอบแทน:
บันทึก<สตริงใดๆ>
optionsToEndpoint()
ลายเซ็น:
export declare function optionsToEndpoint(options: DeploymentOptions): ManifestEndpoint;
พารามิเตอร์
| พารามิเตอร์ | พิมพ์ | คำอธิบาย |
|---|---|---|
| ตัวเลือก | ตัวเลือกการปรับใช้ |
ผลตอบแทน:
ManifestEndpoint
optionsToTrigger()
ลายเซ็น:
export declare function optionsToTrigger(options: DeploymentOptions): any;
พารามิเตอร์
| พารามิเตอร์ | พิมพ์ | คำอธิบาย |
|---|---|---|
| ตัวเลือก | ตัวเลือกการปรับใช้ |
ผลตอบแทน:
ใดๆ
ภูมิภาค()
กำหนดค่าภูมิภาคที่จะปรับใช้ฟังก์ชันนี้
ลายเซ็น:
export declare function region(...regions: Array<(typeof SUPPORTED_REGIONS)[number] | string | Expression<string> | ResetValue>): FunctionBuilder;
พารามิเตอร์
| พารามิเตอร์ | พิมพ์ | คำอธิบาย |
|---|---|---|
| ภูมิภาค | อาร์เรย์<(ประเภทของ SUPPORTED_REGIONS )[จำนวน] | สตริง | การแสดงออก <สตริง> | รีเซ็ตค่า> | อีกหนึ่งสตริงภูมิภาค |
ผลตอบแทน:
ตัวอย่างที่ 1
ฟังก์ชั่นภูมิภาค ('us-east1')
ตัวอย่างที่ 2
ฟังก์ชั่นภูมิภาค ('us-east1', 'us-central1')
วิ่งด้วย()
กำหนดค่าตัวเลือกรันไทม์สำหรับฟังก์ชัน
ลายเซ็น:
export declare function runWith(runtimeOptions: RuntimeOptions): FunctionBuilder;
พารามิเตอร์
| พารามิเตอร์ | พิมพ์ | คำอธิบาย |
|---|---|---|
| ตัวเลือกรันไทม์ | ตัวเลือกรันไทม์ | วัตถุที่มีฟิลด์ตัวเลือก: 1. memory : จำนวนหน่วยความจำที่จะจัดสรรให้กับฟังก์ชัน ค่าที่เป็นไปได้คือ: '128MB', '256MB', '512MB', '1GB', '2GB', '4GB' และ '8GB' . 2. timeoutSeconds : หมดเวลาสำหรับฟังก์ชันเป็นวินาที ค่าที่เป็นไปได้คือ 0 ถึง 540 3. failurePolicy : นโยบายความล้มเหลวของฟังก์ชัน โดยที่บูลีน true จะเทียบเท่ากับการจัดเตรียมวัตถุลองใหม่ที่ว่างเปล่า 4. vpcConnector : id ของตัวเชื่อมต่อ VPC ในโปรเจ็กต์และภูมิภาคเดียวกัน 5. vpcConnectorEgressSettings : เมื่อตั้งค่า vpcConnector แล้ว ให้ควบคุมว่าการรับส่งข้อมูลขาออกใดจะถูกส่งผ่าน vpcConnector 6. serviceAccount : บัญชีบริการเฉพาะสำหรับฟังก์ชัน 7. ingressSettings : การตั้งค่าทางเข้าสำหรับฟังก์ชัน ซึ่งควบคุมตำแหน่งที่สามารถเรียกใช้ฟังก์ชัน HTTPS ได้ ค่าต้องไม่เป็นค่าว่าง |
ผลตอบแทน:
แอป
ลายเซ็น:
app: {
setEmulatedAdminApp: typeof setEmulatedAdminApp;
}
DEFAULT_FAILURE_POLICY
ลายเซ็น:
DEFAULT_FAILURE_POLICY: FailurePolicy
INGRESS_SETTINGS_OPTIONS
รายการตัวเลือกที่ใช้ได้สำหรับ IngressSettings
ลายเซ็น:
INGRESS_SETTINGS_OPTIONS: readonly ["INGRESS_SETTINGS_UNSPECIFIED", "ALLOW_ALL", "ALLOW_INTERNAL_ONLY", "ALLOW_INTERNAL_AND_GCLB"]
MAX_NUMBER_USER_LABELS
ลายเซ็น:
MAX_NUMBER_USER_LABELS = 58
MAX_TIMEOUT_SECONDS
ค่าการหมดเวลาสูงสุดของฟังก์ชันคลาวด์
ลายเซ็น:
MAX_TIMEOUT_SECONDS = 540
MIN_TIMEOUT_SECONDS
ค่าการหมดเวลาขั้นต่ำของฟังก์ชันคลาวด์
ลายเซ็น:
MIN_TIMEOUT_SECONDS = 0
รีเซ็ต_VALUE
ค่าการกำหนดค่าพิเศษเพื่อรีเซ็ตการกำหนดค่าเป็นค่าเริ่มต้นของแพลตฟอร์ม
ลายเซ็น:
RESET_VALUE: ResetValue
สนับสนุน_ภูมิภาค
รายชื่อภูมิภาคทั้งหมดที่รองรับโดย Cloud Functions
ลายเซ็น:
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"]
VALID_MEMORY_OPTIONS
รายการตัวเลือกหน่วยความจำที่ใช้งานได้ซึ่งรองรับโดย Cloud Functions
ลายเซ็น:
VALID_MEMORY_OPTIONS: readonly ["128MB", "256MB", "512MB", "1GB", "2GB", "4GB", "8GB"]
VPC_EGRESS_SETTINGS_OPTIONS
รายการตัวเลือกที่ใช้ได้สำหรับ VpcConnectorEgressSettings
ลายเซ็น:
VPC_EGRESS_SETTINGS_OPTIONS: readonly ["VPC_CONNECTOR_EGRESS_SETTINGS_UNSPECIFIED", "PRIVATE_RANGES_ONLY", "ALL_TRAFFIC"]