params namespace

Fonksiyonlar

İşlev Tanım
defineBoolean(ad, seçenekler) Bir boole parametresi bildirin.
defineInt(ad, seçenekler) Bir tamsayı parametresi bildirin.
defineList(isim, seçenekler) Bir liste parametresi bildirin.
defineSecret(isim) Değerleri yalnızca Cloud Secret Manager'da tutacak gizli bir parametre bildirir. Sırlar dahili olarak bayt dizeleri olarak saklanır. Parametre çözümlemesi sırasında tür ipuçları sağlamak için ParamOptions.as kullanın.
defineString(ad, seçenekler) Bir dize parametresi bildirin.
multiSelect(seçenekler) Bir dizi değerden çoklu seçim girişi oluşturun.
multiSelect(seçenekler) Etiketlerin haritasından değerlere kadar çoklu seçimli bir giriş oluşturun.
seç(seçenekler) Bir dizi değerden seçme girişi oluşturun.
seç(seçeneklerEtiketlerle) Etiketlerin değerlere haritasından bir seçme girişi oluşturun.

Sınıflar

Sınıf Tanım
İfade

Arayüzler

Arayüz Tanım
ÇokluSeçimGirişi Bir parametrenin değerinin, kullanıcının dağıtım zamanında etkileşimli olarak önceden hazırlanmış seçenekler listesinden bir alt küme seçmesini sağlayarak belirlenmesi gerektiğini belirtir. string[] dışındaki türdeki parametrelerde kullanılırsa hatalarla sonuçlanır.
Girişi Seç Bir parametrenin değerinin, kullanıcının dağıtım zamanında etkileşimli olarak önceden hazırlanmış seçenekler listesinden seçim yapmasıyla belirlenmesi gerektiğini belirtir.
Seçenekleri Seçin Seçim arayüzünde görüntülenecek bir değer ve isteğe bağlı olarak insan tarafından okunabilen bir etiket içeren, SelectInput sağlanan seçeneklerden biri.
Metin Girişi Bir parametrenin değerinin, kullanıcının dağıtım zamanında etkileşimli olarak yazması istenerek belirlenmesi gerektiğini belirtir. Sağlanan validationRegex ile eşleşmeyen giriş (varsa) yeniden denenecek.

Değişkenler

Değişken Tanım
BUCKET_PICKER Bir projede kullanıcının seçebileceği paketlerin listesini otomatik olarak oluşturun.
veritabanıURL'si Dağıtıcıya sormadan projeyle ilişkili varsayılan RTDB veritabanı URL'sine çözümleyen yerleşik bir parametre. Hiçbiri yoksa boş dize.
beyan edilen Paramlar
gcloudProjesi Dağıtıcıya sorulmadan Bulut proje kimliğine çözümlenen yerleşik bir parametre.
proje kimliği Dağıtıcıya sorulmadan projeyle ilişkili Bulut proje kimliğine çözümlenen yerleşik bir parametre.
depolamaKepçe Dağıtıcıya sorulmadan, işlevle ilişkili Bulut depolama grubuna çözümlenen yerleşik bir parametre. Tanımlanmamışsa boş dize.

Takma Adları Yazın

Takma Ad yazın Tanım
ParamSeçenekler Bir parametrenin istem davranışını özelleştirmek için kullanılabilecek yapılandırma seçenekleri.

params.defineBoolean()

Bir boole parametresi bildirin.

İmza:

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

Parametreler

Parametre Tip Tanım
isim sicim Parametreyi yüklemek için kullanılacak ortam değişkeninin adı.
seçenekler ParamSeçenekler <boolean> Parametre için yapılandırma seçenekleri.

İadeler:

BooleanParam

.value için boolean dönüş türüne sahip bir parametre .

params.defineInt()

Bir tamsayı parametresi bildirin.

İmza:

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

Parametreler

Parametre Tip Tanım
isim sicim Parametreyi yüklemek için kullanılacak ortam değişkeninin adı.
seçenekler ParamSeçenekler <sayı> Parametre için yapılandırma seçenekleri.

İadeler:

IntParam

.value için number dönüş türüne sahip bir parametre .

params.defineList()

Bir liste parametresi bildirin.

İmza:

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

Parametreler

Parametre Tip Tanım
isim sicim Parametreyi yüklemek için kullanılacak ortam değişkeninin adı.
seçenekler ParamSeçenekler <dize[]> Parametre için yapılandırma seçenekleri.

İadeler:

ListeParam

.value için string[] dönüş türüne sahip bir parametre .

params.defineSecret()

Değerleri yalnızca Cloud Secret Manager'da tutacak gizli bir parametre bildirir. Sırlar dahili olarak bayt dizeleri olarak saklanır. Parametre çözümlemesi sırasında tür ipuçları sağlamak için ParamOptions.as kullanın.

İmza:

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

Parametreler

Parametre Tip Tanım
isim sicim Parametreyi yüklemek için kullanılacak ortam değişkeninin adı.

İadeler:

Gizli Param

.value için string dönüş türüne sahip bir parametre .

params.defineString()

Bir dize parametresi bildirin.

İmza:

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

Parametreler

Parametre Tip Tanım
isim sicim Parametreyi yüklemek için kullanılacak ortam değişkeninin adı.
seçenekler ParamSeçenekler <dize> Parametre için yapılandırma seçenekleri.

İadeler:

StringParam

.value için string dönüş türüne sahip bir parametre .

params.multiSelect()

Bir dizi değerden çoklu seçim girişi oluşturun.

İmza:

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

Parametreler

Parametre Tip Tanım
seçenekler sicim[]

İadeler:

ÇokluSeçimGirişi

params.multiSelect()

Etiketlerin haritasından değerlere kadar çoklu seçimli bir giriş oluşturun.

İmza:

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

Parametreler

Parametre Tip Tanım
seçenekler Kayıt<string, string>

İadeler:

ÇokluSeçimGirişi

params.select()

Bir dizi değerden seçme girişi oluşturun.

İmza:

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

Parametreler

Parametre Tip Tanım
seçenekler T[]

İadeler:

Girişi Seç <T>

params.select()

Etiketlerin değerlere haritasından bir seçme girişi oluşturun.

İmza:

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

Parametreler

Parametre Tip Tanım
seçeneklerEtiketlerle Kayıt<string, T>

İadeler:

Girişi Seç <T>

parametreler.BUCKET_PICKER

Bir projede kullanıcının seçebileceği paketlerin listesini otomatik olarak oluşturun.

İmza:

BUCKET_PICKER: ResourceInput

params.veritabanıURL'si

Dağıtıcıya sormadan projeyle ilişkili varsayılan RTDB veritabanı URL'sine çözümleyen yerleşik bir parametre. Hiçbiri yoksa boş dize.

İmza:

databaseURL: Param<string>

params.declaredParams

İmza:

declaredParams: SecretOrExpr[]

params.gcloudProject

Dağıtıcıya sorulmadan Bulut proje kimliğine çözümlenen yerleşik bir parametre.

İmza:

gcloudProject: Param<string>

params.proje kimliği

Dağıtıcıya sorulmadan projeyle ilişkili Bulut proje kimliğine çözümlenen yerleşik bir parametre.

İmza:

projectID: Param<string>

params.storageBucket

Dağıtıcıya sorulmadan, işlevle ilişkili Bulut depolama grubuna çözümlenen yerleşik bir parametre. Tanımlanmamışsa boş dize.

İmza:

storageBucket: Param<string>

params.ParamOptions

Bir parametrenin istem davranışını özelleştirmek için kullanılabilecek yapılandırma seçenekleri.

İmza:

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