Chức năng
Chức năng | Sự miêu tả |
---|---|
định nghĩaBoolean(tên, tùy chọn) | Khai báo một tham số boolean. |
Định nghĩaInt(tên, tùy chọn) | Khai báo một tham số nguyên. |
xác địnhList(tên, tùy chọn) | Khai báo một tham số danh sách. |
xác địnhBí mật(tên) | Khai báo một thông số bí mật, thông số này sẽ chỉ duy trì các giá trị trong Cloud Secret Manager. Bí mật được lưu trữ nội bộ dưới dạng bytestrings. Sử dụng ParamOptions.as để cung cấp gợi ý loại trong quá trình phân giải tham số. |
xác địnhString(tên, tùy chọn) | Khai báo một tham số chuỗi. |
multiSelect(tùy chọn) | Tạo đầu vào có nhiều lựa chọn từ một chuỗi giá trị. |
multiSelect(tùy chọn) | Tạo đầu vào nhiều lựa chọn từ bản đồ nhãn đến giá trị. |
lựa chọn các phương án) | Tạo một đầu vào chọn từ một loạt các giá trị. |
chọn (tùy chọnWithLabels) | Tạo đầu vào được chọn từ bản đồ nhãn tới giá trị. |
Các lớp học
Lớp học | Sự miêu tả |
---|---|
Sự biểu lộ |
Giao diện
Giao diện | Sự miêu tả |
---|---|
MultiSelectĐầu vào | Chỉ định rằng giá trị của tham số phải được xác định bằng cách yêu cầu người dùng chọn một tập hợp con từ danh sách các tùy chọn đóng hộp sẵn một cách tương tác tại thời điểm triển khai. Sẽ dẫn đến lỗi nếu được sử dụng trên các tham số thuộc loại khác string[] . |
Chọn đầu vào | Chỉ định rằng giá trị của tham số phải được xác định bằng cách yêu cầu người dùng chọn từ danh sách các tùy chọn đóng hộp sẵn một cách tương tác tại thời điểm triển khai. |
Lựa chọn các phương án | Một trong các tùy chọn được cung cấp cho SelectInput , chứa một giá trị và tùy chọn nhãn mà con người có thể đọc được để hiển thị trong giao diện lựa chọn. |
văn bản đầu vào | Chỉ định rằng giá trị của tham số phải được xác định bằng cách nhắc người dùng nhập giá trị đó một cách tương tác tại thời điểm triển khai. Dữ liệu nhập không khớp với xác thực được cung cấpRegex, nếu có, sẽ được thử lại. |
Biến
Biến đổi | Sự miêu tả |
---|---|
BUCKET_PICKER | Tự động tạo danh sách các nhóm trong dự án mà người dùng có thể chọn. |
cơ sở dữ liệuURL | Tham số tích hợp phân giải thành URL cơ sở dữ liệu RTDB mặc định được liên kết với dự án mà không cần nhắc người triển khai. Chuỗi trống nếu không tồn tại. |
khai báoParams | |
dự án gcloud | Một tham số tích hợp phân giải thành ID dự án trên đám mây mà không cần nhắc người triển khai. |
ID dự án | Một tham số tích hợp phân giải thành ID dự án trên đám mây được liên kết với dự án mà không cần nhắc người triển khai. |
lưu trữNhóm | Một tham số dựng sẵn phân giải tới bộ chứa lưu trữ Đám mây được liên kết với hàm mà không cần nhắc người triển khai. Chuỗi trống nếu không được xác định. |
Nhập bí danh
Nhập bí danh | Sự miêu tả |
---|---|
Tùy chọn thông số | Các tùy chọn cấu hình có thể được sử dụng để tùy chỉnh hành vi nhắc nhở của một tham số. |
params.defineBoolean()
Khai báo một tham số boolean.
Chữ ký:
export declare function defineBoolean(name: string, options?: ParamOptions<boolean>): BooleanParam;
Thông số
Tham số | Kiểu | Sự miêu tả |
---|---|---|
tên | sợi dây | Tên của biến môi trường sẽ sử dụng để tải tham số. |
tùy chọn | Tùy chọn thông số <boolean> | Tùy chọn cấu hình cho tham số. |
Trả về:
BooleanParam
Một tham số có kiểu trả về boolean
cho .value
.
params.defineInt()
Khai báo một tham số nguyên.
Chữ ký:
export declare function defineInt(name: string, options?: ParamOptions<number>): IntParam;
Thông số
Tham số | Kiểu | Sự miêu tả |
---|---|---|
tên | sợi dây | Tên của biến môi trường sẽ sử dụng để tải tham số. |
tùy chọn | Tùy chọn thông số <số> | Tùy chọn cấu hình cho tham số. |
Trả về:
IntParam
Một tham số có kiểu trả về number
cho .value
.
params.defineList()
Khai báo một tham số danh sách.
Chữ ký:
export declare function defineList(name: string, options?: ParamOptions<string[]>): ListParam;
Thông số
Tham số | Kiểu | Sự miêu tả |
---|---|---|
tên | sợi dây | Tên của biến môi trường sẽ sử dụng để tải tham số. |
tùy chọn | Tùy chọn thông số <chuỗi[]> | Tùy chọn cấu hình cho tham số. |
Trả về:
Danh sáchParam
Một tham số có kiểu trả về string[]
cho .value
.
params.defineSecret()
Khai báo một thông số bí mật, thông số này sẽ chỉ duy trì các giá trị trong Cloud Secret Manager. Bí mật được lưu trữ nội bộ dưới dạng bytestrings. Sử dụng ParamOptions.as
để cung cấp gợi ý loại trong quá trình phân giải tham số.
Chữ ký:
export declare function defineSecret(name: string): SecretParam;
Thông số
Tham số | Kiểu | Sự miêu tả |
---|---|---|
tên | sợi dây | Tên của biến môi trường sẽ sử dụng để tải tham số. |
Trả về:
Thông số bí mật
Một tham số có kiểu trả về string
cho .value
.
params.defineString()
Khai báo một tham số chuỗi.
Chữ ký:
export declare function defineString(name: string, options?: ParamOptions<string>): StringParam;
Thông số
Tham số | Kiểu | Sự miêu tả |
---|---|---|
tên | sợi dây | Tên của biến môi trường sẽ sử dụng để tải tham số. |
tùy chọn | Tùy chọn thông số <chuỗi> | Tùy chọn cấu hình cho tham số. |
Trả về:
ChuỗiParam
Một tham số có kiểu trả về string
cho .value
.
params.multiSelect()
Tạo đầu vào có nhiều lựa chọn từ một chuỗi giá trị.
Chữ ký:
export declare function multiSelect(options: string[]): MultiSelectInput;
Thông số
Tham số | Kiểu | Sự miêu tả |
---|---|---|
tùy chọn | sợi dây[] |
Trả về:
params.multiSelect()
Tạo đầu vào nhiều lựa chọn từ bản đồ nhãn đến giá trị.
Chữ ký:
export declare function multiSelect(options: Record<string, string>): MultiSelectInput;
Thông số
Tham số | Kiểu | Sự miêu tả |
---|---|---|
tùy chọn | Bản ghi<chuỗi, chuỗi> |
Trả về:
thông số.select()
Tạo một đầu vào chọn từ một loạt các giá trị.
Chữ ký:
export declare function select<T>(options: T[]): SelectInput<T>;
Thông số
Tham số | Kiểu | Sự miêu tả |
---|---|---|
tùy chọn | T[] |
Trả về:
Chọn đầu vào <T>
thông số.select()
Tạo đầu vào được chọn từ bản đồ nhãn tới giá trị.
Chữ ký:
export declare function select<T>(optionsWithLabels: Record<string, T>): SelectInput<T>;
Thông số
Tham số | Kiểu | Sự miêu tả |
---|---|---|
tùy chọnWithLabels | Bản ghi<chuỗi, T> |
Trả về:
Chọn đầu vào <T>
thông số.BUCKET_PICKER
Tự động tạo danh sách các nhóm trong dự án mà người dùng có thể chọn.
Chữ ký:
BUCKET_PICKER: ResourceInput
params.databaseURL
Tham số tích hợp phân giải thành URL cơ sở dữ liệu RTDB mặc định được liên kết với dự án mà không cần nhắc người triển khai. Chuỗi trống nếu không tồn tại.
Chữ ký:
databaseURL: Param<string>
params.declaredParams
Chữ ký:
declaredParams: SecretOrExpr[]
params.gcloudDự án
Một tham số tích hợp phân giải thành ID dự án trên đám mây mà không cần nhắc người triển khai.
Chữ ký:
gcloudProject: Param<string>
thông số.projectID
Một tham số tích hợp phân giải thành ID dự án trên đám mây được liên kết với dự án mà không cần nhắc người triển khai.
Chữ ký:
projectID: Param<string>
params.storageBucket
Một tham số dựng sẵn phân giải tới bộ chứa lưu trữ Đám mây được liên kết với hàm mà không cần nhắc người triển khai. Chuỗi trống nếu không được xác định.
Chữ ký:
storageBucket: Param<string>
params.ParamOptions
Các tùy chọn cấu hình có thể được sử dụng để tùy chỉnh hành vi nhắc nhở của một tham số.
Chữ ký:
export type ParamOptions<T extends string | number | boolean | string[]> = Omit<ParamSpec<T>, "name" | "type">;