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 HTTPS và các chức năng xử lý sự kiện.

Chữ ký:

export interface GlobalOptions 

Của cải

Tài sản Kiểu Sự miêu tả
sự đồng thời số | Sự biểu lộ <số> | Đặt lại giá trị Số lượng yêu cầu mà một hàm 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.
thực thiAppCheck boolean Xác định xem Kiểm tra ứng dụng Firebase 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 đầu vào kiểm soát nơi có thể gọi chức năng này.
kẻ triệu hồi "công khai" | "riêng tư" | chuỗi | sợi dây[] Invoker để thiết lập 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ố | Sự biểu lộ <số> | Đặt lại giá trị Số lượng phiên bản tối đa có thể chạy song song.
ký ức Tùy chọn bộ nhớ | Sự biểu lộ <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ố | Sự biểu lộ <số> | Đặ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ỏ sót boolean | Sự biểu lộ <boolean> Nếu đúng, không triển khai hoặc mô phỏng chức năng này.
bảo tồnThay đổi bên ngoài 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ợ | chuỗi | Sự biểu lộ <chuỗi> | Đặt lại giá trị 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 | Sự biểu lộ <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.
hết thời gianGiây số | Sự biểu lộ <số> | Đặt lại giá trị Thời gian chờ của hàm tính bằng giây, các giá trị có thể là từ 0 đến 540. Hàm HTTPS có thể chỉ định thời gian chờ cao hơn.
vpcConnector chuỗi | Sự biểu lộ <chuỗi> | Đặt lại giá trị Kết nối một chức năng với đầu nối VPC được chỉ định.
vpcConnectorEgressSettings VpcEgressSetting | Đặt lại giá trị Cài đặt đầu ra cho đầu nối VPC.

GlobalOptions.concurrency

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

Chỉ có thể áp dụng cho các chức năng chạy trên Cloud Functions (thế hệ 2)). Giá trị null khôi phục sự tương tranh mặc định (80 khi CPU > = 1, 1 nếu không). Không thể đặt đồ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 đồ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 cho kích thước bộ nhớ lớn hơn. Điều 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ố lượng cố định được chỉ định trong Cloud Functions (thế hệ 1). Để hoàn nguyên về số 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 Kiểm tra ứng dụng Firebase 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 phản hồ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 undefined .

Chữ ký:

enforceAppCheck?: boolean;

GlobalOptions.ingressSettings

Cài đặt đầu vào kiểm soát nơi có thể gọi chức năng này.

Chữ ký:

ingressSettings?: IngressSetting | ResetValue;

GlobalOptions.invoker

Invoker để thiết lập kiểm soát truy cập trên các chức năng HTTPS.

Chữ ký:

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

GlobalOptions.labels

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

Chữ ký:

labels?: Record<string, string>;

GlobalOptions.maxInstances

Số lượng phiên bản tối đa có thể 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ố 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 phiên bản được tính phí cho việc 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 Firebase dành cho Chức năng đám mây, chúng tôi khuyên bạn nên đặt preserveExternalChanges thành true . Ngược lại, khi Google phát hành phiên bản SDK mới có hỗ trợ cấu hình bị thiếu, cài đặt được định cấu hình 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.khu vực

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

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ức năng chạy dưới dạng.

Chữ ký:

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

GlobalOptions.timeoutSeconds

Thời gian chờ của hàm tính bằng giây, các giá trị có thể là từ 0 đến 540. 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 thế hệ thứ 2 là 1 giây. Thời gian chờ tối đa cho một chức năng tùy thuộc vào loại chức năng: Chức năng 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ờ). Chức năng xếp hàng nhiệm 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 chức năng với đầu nối VPC được chỉ định.

Chữ ký:

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

GlobalOptions.vpcConnectorEgressSettings

Cài đặt đầu ra cho đầu nối VPC.

Chữ ký:

vpcConnectorEgressSettings?: VpcEgressSetting | ResetValue;