GlobalOptions
là các tuỳ chọn có thể được thiết lập trên toàn bộ dự án. Các tuỳ chọn này phổ biến với HTTPS và các hàm xử lý sự kiện.
Chữ ký:
export interface GlobalOptions
Thuộc tính
Tài sản | Loại | Mô tả |
---|---|---|
tính đồng thời | số | Biểu thức<number> | Đặt lại giá trị | Số yêu cầu mà một hàm có thể cung cấp cùng một lúc. |
cpu | số | "gcf_gen1" | Số phân số của CPU cần phân bổ cho một hàm. |
thực thiAppCheck | boolean | Xác định xem tính năng Kiểm tra ứng dụng Firebase có được thực thi hay không. Giá trị mặc định là false. |
ingressSettings | Cài đặt lưu lượng truy cập | Đặt lại giá trị | Chế độ cài đặt đầu vào kiểm soát nơi hàm này có thể được gọi. |
người gọi | "công khai" | "riêng tư" | chuỗi | chuỗi[] | Trình gọi để thiết lập kiểm soát truy cập vào các hàm HTTPS. |
nhãn | Ghi <string, string> | Các nhãn người dùng để đặt cho hàm. |
maxInstances | số | Biểu thức<number> | Đặt lại giá trị | Số lượng thực thể tối đa có thể chạy song song. |
bộ nhớ | MemoryOption | Biểu thức<number> | Đặt lại giá trị | Dung lượng bộ nhớ cần phân bổ cho một hàm. |
minInstances | số | Biểu thức<number> | Đặt lại giá trị | Số lượng phiên bản thực tế tối thiểu sẽ chạy tại một thời điểm nhất định. |
bỏ qua | boolean | Biểu thức<boolean> | Nếu đúng, không triển khai hoặc mô phỏng hàm này. |
preserveExternalChanges | boolean | Kiểm soát việc cấu hình hàm được sửa đổi bên ngoài nguồn hàm có được giữ nguyên hay không. Giá trị mặc định là false. |
khu vực | Khu vực được hỗ trợ | chuỗi | Biểu thức<string> | Đặt lại giá trị | Khu vực cần triển khai hàm. |
bí mật | (chuỗi | SecretParam)[] | |
serviceAccount | chuỗi | Biểu thức<string> | Đặt lại giá trị | Tài khoản dịch vụ cụ thể để chạy hàm. |
timeoutSeconds | số | Biểu thức<number> | Đặt lại giá trị | Thời gian chờ cho hàm tính bằng giây, các giá trị có thể là từ 0 đến 540. Các hàm HTTPS có thể chỉ định thời gian chờ cao hơn. |
vpcConnector | chuỗi | Biểu thức<string> | Đặt lại giá trị | Kết nối một hàm với một trình kết nối VPC đã chỉ định. |
vpcConnectorEgressSettings | Cài đặt VpcEgress | Đặt lại giá trị | Chế độ cài đặt đầu ra cho trình kết nối VPC. |
GlobalOptions.concurrency
Số yêu cầu mà một hàm có thể cung cấp cùng một lúc.
Chỉ có thể áp dụng cho các hàm chạy trên Cloud Functions (thế hệ thứ 2)). Giá trị của rỗng sẽ khôi phục mô hình đồng thời mặc định (80 khi CPU >= 1, nếu không thì là 1). Không thể đặt mô hình đồng thời thành bất kỳ giá trị nào khác 1 nếu cpu
nhỏ hơn 1. Giá trị tối đa cho cơ chế xử lý đồng thời là 1.000.
Chữ ký:
concurrency?: number | Expression<number> | ResetValue;
GlobalOptions.cpu
Số phân số của CPU cần phân bổ cho một hàm.
Giá trị mặc định là 1 đối với các hàm có RAM <= 2 GB và tăng lên đối với kích thước bộ nhớ lớn hơn. Số lượng này khác với giá trị mặc định khi sử dụng tiện ích gcloud và khác với số tiền cố định được chỉ định trong Cloud Functions (thế hệ thứ 1). Để quay về mức sử dụng CPU trong gcloud hoặc trong Cloud Functions (thế hệ thứ 1), hãy đặt giá trị này thành giá trị "gcf_gen1"
Chữ ký:
cpu?: number | "gcf_gen1";
GlobalOptions.enforceAppCheck
Xác định xem tính năng Kiểm tra ứng dụng Firebase có được thực thi hay không. Giá trị mặc định là false.
Khi bạn đặt chính sách này thành true, những yêu cầu có mã thông báo không hợp lệ sẽ tự động phản hồi bằng thông báo lỗi 401 (Chưa được uỷ quyền). Nếu sai, các yêu cầu có mã thông báo không hợp lệ sẽ đặt event.app
thành undefined
.
Chữ ký:
enforceAppCheck?: boolean;
Cài đặt GlobalOptions.ingress
Chế độ cài đặt đầu vào kiểm soát nơi hàm này có thể được gọi.
Chữ ký:
ingressSettings?: IngressSetting | ResetValue;
GlobalOptions.gọir
Trình gọi để thiết lập kiểm soát truy cập vào các hàm HTTPS.
Chữ ký:
invoker?: "public" | "private" | string | string[];
GlobalOptions.labels
Các nhãn người dùng để đặt cho hàm.
Chữ ký:
labels?: Record<string, string>;
GlobalOptions.maxInstances
Số lượng thực thể tối đa có thể chạy song song.
Chữ ký:
maxInstances?: number | Expression<number> | ResetValue;
GlobalOptions.memory
Dung lượng bộ nhớ cần phân bổ cho một hàm.
Chữ ký:
memory?: MemoryOption | Expression<number> | ResetValue;
GlobalOptions.minInstances
Số lượng phiên bản thực tế tối thiểu sẽ chạy tại một thời điểm nhất định.
Các thực thể sẽ được tính phí phân bổ bộ nhớ và 10% mức phân bổ CPU khi ở trạng thái rảnh.
Chữ ký:
minInstances?: number | Expression<number> | ResetValue;
GlobalOptions.omit
Nếu đúng, không triển khai hoặc mô phỏng hàm này.
Chữ ký:
omit?: boolean | Expression<boolean>;
GlobalOptions.preserveExternalChanges
Kiểm soát việc cấu hình hàm được sửa đổi bên ngoài nguồn hàm có được giữ nguyên hay không. Giá trị mặc định là false.
Khi cài đặt cấu hình có sẵn trong nền tảng cơ bản chưa có trong Firebase SDK cho Cloud Functions, bạn nên đặt preserveExternalChanges
thành true
. Nếu không, khi Google phát hành một phiên bản SDK mới có hỗ trợ cấu hình bị thiếu, chế độ cài đặt được định cấu hình thủ công của hàm có thể vô tình bị xoá.
Chữ ký:
preserveExternalChanges?: boolean;
GlobalOptions.region
Khu vực cần triển khai hàm.
Chữ ký:
region?: SupportedRegion | string | Expression<string> | ResetValue;
GlobalOptions.secrets
Chữ ký:
secrets?: (string | SecretParam)[];
GlobalOptions.serviceAccount
Tài khoản dịch vụ cụ thể để chạy hàm.
Chữ ký:
serviceAccount?: string | Expression<string> | ResetValue;
GlobalOptions.timeoutSeconds
Thời gian chờ cho hàm tính bằng giây, các giá trị có thể là từ 0 đến 540. Các hàm HTTPS có thể chỉ định thời gian chờ cao hơn.
Thời gian chờ tối thiểu cho hàm thế hệ 2 là 1 giây. Thời gian chờ tối đa cho một hàm phụ thuộc vào loại hàm: Các hàm xử lý sự kiện có thời gian chờ tối đa là 540 giây (9 phút). Các hàm HTTPS và có thể gọi có thời gian chờ tối đa là 36.00 giây (1 giờ). Các hàm hàng đợi tác vụ có thời gian chờ tối đa là 1.800 giây (30 phút).
Chữ ký:
timeoutSeconds?: number | Expression<number> | ResetValue;
GlobalOptions.vpcConnector
Kết nối một hàm với một trình kết nối VPC đã chỉ định.
Chữ ký:
vpcConnector?: string | Expression<string> | ResetValue;
GlobalOptions.vpcConnectorEgressSettings
Chế độ cài đặt đầu ra cho trình kết nối VPC.
Chữ ký:
vpcConnectorEgressSettings?: VpcEgressSetting | ResetValue;