alerts.FirebaseAlertOptions interface

Cấu hình cho các chức năng Cảnh báo Firebase.

Chữ ký:

export interface FirebaseAlertOptions extends options.EventHandlerOptions 

Mở rộng: tùy chọn.EventHandlerOptions

Của cải

Tài sản Kiểu Sự miêu tả
loại cảnh báo Loại cảnh báo Phạm vi trình xử lý để kích hoạt loại cảnh báo.
id ứng dụng sợi dây Phạm vi chức năng để kích hoạt trên một ứng dụng cụ thể.
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. Chỉ có thể áp dụng cho các chức năng chạy trên Cloud Functions v2. 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.
CPU số | "gcf_gen1" 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. 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 số lượng cố định được chỉ định trong Google 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"
xâm nhậpCài đặt tùy chọn.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. Giá trị null sẽ tắt cài đặt xâm nhập.
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 chạy song song. Giá trị null khôi phục các phiên bản tối đa mặc định.
ký ức tùy chọn.MemoryOption | Sự biểu lộ <số> | Đặt lại giá trị Lượng bộ nhớ để phân bổ cho một chức năng. Giá trị null khôi phục mặc định là 256MB.
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. Các phiên bản sẽ bị tính phí cho việc phân bổ bộ nhớ và 10% phân bổ CPU khi không hoạt động. Giá trị null khôi phục các phiên bản tối thiểu mặc đị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.
vùng đất tùy chọn.SupportedRegion | 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.
thử lại boolean | Sự biểu lộ <boolean> | Đặt lại giá trị Liệu các lần thực thi thất bại có nên được gửi lại hay không.
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. Giá trị null sẽ khôi phục tài khoản dịch vụ mặc định.
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. Giá trị null khôi phục mặc định là 60 giây. 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 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 tác vụ có thời gian chờ tối đa là 1.800 giây (30 phút)
vpcConnector chuỗi | Sự biểu lộ <chuỗi> | Đặt lại giá trị Kết nối chức năng đám mây với đầu nối VPC được chỉ định. Giá trị null sẽ loại bỏ trình kết nối VPC
vpcConnectorEgressSettings tùy chọn.VpcEgressSetting | Đặt lại giá trị Cài đặt đầu ra cho đầu nối VPC. Giá trị null sẽ tắt cài đặt đầu ra của trình kết nối VPC

cảnh báo.FirebaseAlertOptions.alertType

Phạm vi trình xử lý để kích hoạt loại cảnh báo.

Chữ ký:

alertType: AlertType;

cảnh báo.FirebaseAlertOptions.appId

Phạm vi chức năng để kích hoạt trên một ứng dụng cụ thể.

Chữ ký:

appId?: string;

cảnh báo.FirebaseAlertOptions.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 v2. 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;

cảnh báo.FirebaseAlertOptions.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. 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 số lượng cố định được chỉ định trong Google 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";

cảnh báo.FirebaseAlertOptions.ingressSettings

Cài đặt đầu vào kiểm soát nơi có thể gọi chức năng này. Giá trị null sẽ tắt cài đặt xâm nhập.

Chữ ký:

ingressSettings?: options.IngressSetting | ResetValue;

cảnh báo.FirebaseAlertOptions.labels

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

Chữ ký:

labels?: Record<string, string>;

cảnh báo.FirebaseAlertOptions.maxInstances

Số lượng phiên bản tối đa được chạy song song. Giá trị null khôi phục các phiên bản tối đa mặc định.

Chữ ký:

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

cảnh báo.FirebaseAlertOptions.memory

Lượng bộ nhớ để phân bổ cho một chức năng. Giá trị null khôi phục mặc định là 256MB.

Chữ ký:

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

cảnh báo.FirebaseAlertOptions.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 sẽ bị tính phí cho việc phân bổ bộ nhớ và 10% phân bổ CPU khi không hoạt động. Giá trị null khôi phục các phiên bản tối thiểu mặc định.

Chữ ký:

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

cảnh báo.FirebaseAlertOptions.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>;

cảnh báo.FirebaseAlertOptions.khu vực

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

Chữ ký:

region?: options.SupportedRegion | string | Expression<string> | ResetValue;

cảnh báo.FirebaseAlertOptions.retry

Liệu các lần thực thi thất bại có nên được gửi lại hay không.

Chữ ký:

retry?: boolean | Expression<boolean> | ResetValue;

cảnh báo.FirebaseAlertOptions.secrets

Chữ ký:

secrets?: (string | SecretParam)[];

cảnh báo.FirebaseAlertOptions.serviceAccount

Tài khoản dịch vụ cụ thể để chức năng chạy dưới dạng. Giá trị null sẽ khôi phục tài khoản dịch vụ mặc định.

Chữ ký:

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

cảnh báo.FirebaseAlertOptions.timeoutGiây

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. Giá trị null khôi phục mặc định là 60 giây. 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 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 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;

cảnh báo.FirebaseAlertOptions.vpcConnector

Kết nối chức năng đám mây với đầu nối VPC được chỉ định. Giá trị null sẽ loại bỏ trình kết nối VPC

Chữ ký:

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

cảnh báo.FirebaseAlertOptions.vpcConnectorEgressSettings

Cài đặt đầu ra cho đầu nối VPC. Giá trị null sẽ tắt cài đặt đầu ra của trình kết nối VPC

Chữ ký:

vpcConnectorEgressSettings?: options.VpcEgressSetting | ResetValue;