params namespace

Functions

Fungsi Deskripsi
defineBoolean(nama, opsi) Deklarasikan parameter boolean.
defineInt(nama, opsi) Deklarasikan parameter bilangan bulat.
defineList(nama, opsi) Deklarasikan parameter daftar.
defineSecret(nama) Mendeklarasikan parameter secret, yang hanya akan mempertahankan nilai di Cloud Secret Manager. Secret disimpan secara internal sebagai bytestring. Gunakan ParamOptions.as untuk memberikan petunjuk jenis selama resolusi parameter.
defineString(nama, opsi) Deklarasikan parameter string.
multiSelect(opsi) Buat input multi-pilihan dari serangkaian nilai.
multiSelect(opsi) Buat input multi-pilihan dari peta label ke nilai.
select(opsi) Buat input tertentu dari serangkaian nilai.
select(optionsWithLabels) Buat input tertentu dari peta label ke nilai.

Kelas

Class Deskripsi
Ekspresi

Antarmuka

Antarmuka Deskripsi
MultiSelectInput Menentukan bahwa nilai parameter harus ditentukan dengan meminta pengguna memilih subset dari daftar opsi yang telah disiapkan sebelumnya secara interaktif pada waktu deployment. Akan menghasilkan error jika digunakan pada parameter jenis selain string[].
SelectInput Menentukan bahwa nilai parameter harus ditentukan dengan meminta pengguna memilih dari daftar opsi yang telah disiapkan sebelumnya secara interaktif pada waktu deployment.
SelectOptions Salah satu opsi yang diberikan ke SelectInput, yang berisi nilai dan, secara opsional, label yang dapat dibaca manusia untuk ditampilkan di antarmuka pemilihan.
TextInput Menentukan bahwa nilai parameter harus ditentukan dengan meminta pengguna mengetik parameter secara interaktif pada waktu deployment. Input yang tidak cocok dengan validationRegex yang diberikan, jika ada, akan dicoba lagi.

Variabel

Variabel Deskripsi
BUCKET_PICKER Membuat otomatis daftar bucket dalam project yang dapat dipilih pengguna.
databaseURL Parameter bawaan yang me-resolve ke URL database RTDB default yang terkait dengan project, tanpa meminta izin deploymenter. String kosong jika tidak ada.
DeclaredParams
gcloudProject Parameter bawaan yang me-resolve ke project ID Cloud, tanpa meminta izin deploymenter.
projectID Parameter bawaan yang me-resolve ke project ID Cloud yang terkait dengan project, tanpa meminta deploymenter.
storageBucket Parameter bawaan yang di-resolve ke bucket Cloud Storage yang terkait dengan fungsi tersebut, tanpa meminta izin deploymenter. String kosong jika tidak ditentukan.

Ketik Alias

Ketik Alias Deskripsi
ParamOptions Opsi konfigurasi yang dapat digunakan untuk menyesuaikan perilaku pemberian perintah suatu parameter.

params.defineBoolean()

Deklarasikan parameter boolean.

Tanda Tangan:

export declare function defineBoolean(name: string, options?: ParamOptions<boolean>): BooleanParam;

Parameter

Parameter Jenis Deskripsi
name string Nama variabel lingkungan yang akan digunakan untuk memuat parameter.
opsi ParamOptions<boolean> Opsi konfigurasi untuk parameter.

Hasil:

BooleanParam

Parameter dengan jenis nilai yang ditampilkan boolean untuk .value.

params.defineInt()

Deklarasikan parameter bilangan bulat.

Tanda Tangan:

export declare function defineInt(name: string, options?: ParamOptions<number>): IntParam;

Parameter

Parameter Jenis Deskripsi
name string Nama variabel lingkungan yang akan digunakan untuk memuat parameter.
opsi ParamOptions<number> Opsi konfigurasi untuk parameter.

Hasil:

IntParam

Parameter dengan jenis nilai yang ditampilkan number untuk .value.

{i>params.defineList()<i}

Deklarasikan parameter daftar.

Tanda Tangan:

export declare function defineList(name: string, options?: ParamOptions<string[]>): ListParam;

Parameter

Parameter Jenis Deskripsi
name string Nama variabel lingkungan yang akan digunakan untuk memuat parameter.
opsi ParamOptions<string[]> Opsi konfigurasi untuk parameter.

Hasil:

{i>ListParam<i}

Parameter dengan jenis nilai yang ditampilkan string[] untuk .value.

params.defineSecret()

Mendeklarasikan parameter secret, yang hanya akan mempertahankan nilai di Cloud Secret Manager. Secret disimpan secara internal sebagai bytestring. Gunakan ParamOptions.as untuk memberikan petunjuk jenis selama resolusi parameter.

Tanda Tangan:

export declare function defineSecret(name: string): SecretParam;

Parameter

Parameter Jenis Deskripsi
name string Nama variabel lingkungan yang akan digunakan untuk memuat parameter.

Hasil:

{i>SecretParam<i}

Parameter dengan jenis nilai yang ditampilkan string untuk .value.

{i>params.defineString()<i}

Deklarasikan parameter string.

Tanda Tangan:

export declare function defineString(name: string, options?: ParamOptions<string>): StringParam;

Parameter

Parameter Jenis Deskripsi
name string Nama variabel lingkungan yang akan digunakan untuk memuat parameter.
opsi ParamOptions<string> Opsi konfigurasi untuk parameter.

Hasil:

StringParam

Parameter dengan jenis nilai yang ditampilkan string untuk .value.

params.multiSelect()

Buat input multi-pilihan dari serangkaian nilai.

Tanda Tangan:

export declare function multiSelect(options: string[]): MultiSelectInput;

Parameter

Parameter Jenis Deskripsi
opsi {i>string<i}[]

Hasil:

MultiSelectInput

params.multiSelect()

Buat input multi-pilihan dari peta label ke nilai.

Tanda Tangan:

export declare function multiSelect(options: Record<string, string>): MultiSelectInput;

Parameter

Parameter Jenis Deskripsi
opsi Rekam<string, string>

Hasil:

MultiSelectInput

{i>params.select()<i}

Buat input tertentu dari serangkaian nilai.

Tanda Tangan:

export declare function select<T>(options: T[]): SelectInput<T>;

Parameter

Parameter Jenis Deskripsi
opsi K[]

Hasil:

SelectInput<T>

{i>params.select()<i}

Buat input tertentu dari peta label ke nilai.

Tanda Tangan:

export declare function select<T>(optionsWithLabels: Record<string, T>): SelectInput<T>;

Parameter

Parameter Jenis Deskripsi
optionsWithLabels Rekam<string, T>

Hasil:

SelectInput<T>

params.BUCKET_PICKER

Membuat otomatis daftar bucket dalam project yang dapat dipilih pengguna.

Tanda Tangan:

BUCKET_PICKER: ResourceInput

params.databaseURL

Parameter bawaan yang me-resolve ke URL database RTDB default yang terkait dengan project, tanpa meminta izin deploymenter. String kosong jika tidak ada.

Tanda Tangan:

databaseURL: Param<string>

params.DeclaredParams

Tanda Tangan:

declaredParams: SecretOrExpr[]

params.gcloudProject

Parameter bawaan yang me-resolve ke project ID Cloud, tanpa meminta izin deploymenter.

Tanda Tangan:

gcloudProject: Param<string>

params.projectID

Parameter bawaan yang me-resolve ke project ID Cloud yang terkait dengan project, tanpa meminta deploymenter.

Tanda Tangan:

projectID: Param<string>

params.storageBucket

Parameter bawaan yang di-resolve ke bucket Cloud Storage yang terkait dengan fungsi tersebut, tanpa meminta izin deploymenter. String kosong jika tidak ditentukan.

Tanda Tangan:

storageBucket: Param<string>

params.ParamOptions

Opsi konfigurasi yang dapat digunakan untuk menyesuaikan perilaku pemberian perintah suatu parameter.

Tanda Tangan:

export type ParamOptions<T extends string | number | boolean | string[]> = Omit<ParamSpec<T>, "name" | "type">;