GlobalOptions interface

GlobalOptions là các tùy chọn có thể được đặt trên toàn bộ dự án. Các tùy chọn này phổ biến đối với các chức năng xử lý sự kiện và HTTPS.

Chữ ký:

export interface GlobalOptions 

Của cải

Tài sản Kiểu Sự miêu tả
đồng thời số | Biểu thức<số> | Đặt lại giá trị Số lượng yêu cầu mà một chức năng có thể phục vụ cùng một lúc.
CPU số | "gcf_gen1" Phân số CPU để phân bổ cho một chức năng.
thi hànhAppCheck boolean Xác định xem Firebase AppCheck có được thực thi hay không. Mặc định là sai.
xâm nhậpCài đặt IngressSetting | Đặt lại giá trị Cài đặt lối vào kiểm soát nơi chức năng này có thể được gọi từ đó.
kẻ triệu hồi "công cộng" | "riêng tư" | chuỗi | sợi dây[] Invoker để đặt kiểm soát truy cập trên các chức năng https.
nhãn Bản ghi <chuỗi, chuỗi> Nhãn người dùng để đặt trên chức năng.
trường hợp tối đa số | Biểu thức<số> | Đặt lại giá trị Số phiên bản tối đa sẽ chạy song song.
ký ức MemoryOption | Biểu thức<số> | Đặt lại giá trị Lượng bộ nhớ để phân bổ cho một chức năng.
trường hợp tối thiểu số | Biểu thức<số> | Đặt lại giá trị Số 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ỏ sót boolean | Biểu thức <boolean> Nếu đúng, không triển khai hoặc mô phỏng chức năng này.
bảo tồnExternalChanges boolean Kiểm soát xem cấu hình chức năng được sửa đổi bên ngoài nguồn chức năng có được giữ nguyên hay không. Mặc định là sai.
vùng đất Khu vực được hỗ trợ | sợi dây Khu vực nơi các chức năng nên được triển khai.
bí mật (chuỗi | SecretParam)[]
dịch vụtài khoản chuỗi | Đặt lại giá trị Tài khoản dịch vụ cụ thể để chức năng chạy dưới dạng.
thời gian chờ giây số | Biểu thức<số> | Đặ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<chuỗi> | Đặt lại giá trị Kết nối chức năng đám mây với trình kết nối VPC được chỉ định.
vpcConnectorEgressCài đặt VpcEgressSetting | Đặt lại giá trị Cài đặt đầu ra cho trình kết nối VPC.

GlobalOptions.concurrency

Số lượng yêu cầu mà một chức năng có thể phục vụ cùng một lúc.

Chỉ có thể áp dụng cho các hàm chạy trên Cloud Functions v2. Giá trị null khôi phục đồng thời mặc định (80 khi CPU > = 1, 1 ngược lại). Đồng thời không thể được đặt 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 đồng thời là 1.000.

Chữ ký:

concurrency?: number | Expression<number> | ResetValue;

GlobalOptions.cpu

Phân số CPU để phân bổ cho một chức năng.

Mặc định là 1 cho các hàm có < = RAM 2GB và tăng lên đối với kích thước bộ nhớ lớn hơn. Giá trị này khác với giá trị mặc định khi sử dụng tiện ích gcloud và khác với lượng cố định được gán trong Google Cloud Functions thế hệ 1. Để hoàn nguyên về lượng CPU được sử dụng trong gcloud hoặc trong Cloud Functions thế hệ 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 Firebase AppCheck có được thực thi hay không. Mặc định là sai.

Khi đúng, các yêu cầu có mã thông báo không hợp lệ sẽ tự động trả lời với lỗi 401 (Không được phép). Khi sai, các yêu cầu có mã thông báo không hợp lệ sẽ đặt event.app thành không xác định.

Chữ ký:

enforceAppCheck?: boolean;

GlobalOptions.ingressSettings

Cài đặt lối vào kiểm soát nơi chức năng này có thể được gọi từ đó.

Chữ ký:

ingressSettings?: IngressSetting | ResetValue;

GlobalOptions.invoker

Invoker để đặt kiểm soát truy cập trên các chức năng https.

Chữ ký:

invoker?: "public" | "private" | string | string[];

GlobalOptions.nhãn

Nhãn người dùng để đặt trên chức năng.

Chữ ký:

labels?: Record<string, string>;

GlobalOptions.maxInstances

Số phiên bản tối đa sẽ chạy song song.

Chữ ký:

maxInstances?: number | Expression<number> | ResetValue;

GlobalOptions.memory

Lượng bộ nhớ để phân bổ cho một chức năng.

Chữ ký:

memory?: MemoryOption | Expression<number> | ResetValue;

GlobalOptions.minInstances

Số 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 phiên bản sẽ được lập hóa đơn để phân bổ bộ nhớ và 10% phân bổ CPU khi không hoạt động.

Chữ ký:

minInstances?: number | Expression<number> | ResetValue;

GlobalOptions.omit

Nếu đúng, không triển khai hoặc mô phỏng chức năng này.

Chữ ký:

omit?: boolean | Expression<boolean>;

GlobalOptions.preserveExternalChanges

Kiểm soát xem cấu hình chức năng được sửa đổi bên ngoài nguồn chức năng có được giữ nguyên hay không. Mặc định là sai.

Khi cài đặt cấu hình có sẵn trong nền tảng cơ bản chưa có sẵn trong SDK chức năng Firebase, chúng tôi khuyên bạn nên cài preserveExternalChanges thành true . Mặt khác, khi SDK chức năng Firebase phát hành phiên bản SDK mới có hỗ trợ cho cấu hình bị thiếu, cài đặt được định cấu hình theo cách thủ công cho chức năng của bạn có thể vô tình bị xóa.

Chữ ký:

preserveExternalChanges?: boolean;

GlobalOptions.region

Khu vực nơi các chức năng nên được triển khai.

Chữ ký:

region?: SupportedRegion | string;

GlobalOptions.secrets

Chữ ký:

secrets?: (string | SecretParam)[];

GlobalOptions.serviceAccount

Tài khoản dịch vụ cụ thể để chức năng chạy dưới dạng.

Chữ ký:

serviceAccount?: 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 chức năng gen 2 là 1 giây. Thời gian chờ tối đa cho một chức năng phụ thuộc vào loại chức năng: Các chức năng xử lý sự kiện có thời gian chờ tối đa là 540 giây (9 phút). HTTPS và các chức năng có thể gọi được có thời gian chờ tối đa là 36,00 giây (1 giờ). Các chức năng xếp hàng 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 chức năng đám mây với trình kết nối VPC được chỉ định.

Chữ ký:

vpcConnector?: string | Expression<string> | ResetValue;

GlobalOptions.vpcConnectorEgressSettings

Cài đặt đầu ra cho trình kết nối VPC.

Chữ ký:

vpcConnectorEgressSettings?: VpcEgressSetting | ResetValue;