params namespace

İşlevler

İşlev	Açıklama
defineBoole(ad; seçenekler)	Boole parametresi tanımlayın.
defineInt(ad, seçenekler)	Bir tam sayı parametresi tanımlayın.
defineList(ad; seçenekler)	Bir liste parametresi tanımlayın.
defineSecret(ad)	Yalnızca Cloud Secret Manager'daki değerleri koruyacak bir gizli parametre tanımlar. Gizli anahtarlar bayt dizeleri olarak dahili olarak depolanır. Parametre çözünürlüğü sırasında tür ipucu sağlamak için ParamOptions.as kullanın.
defineString(ad; seçenekler)	Dize parametresi tanımlayın.
multiSelect(options)	Bir değer dizisinden çoklu seçimli bir giriş oluşturma.
multiSelect(options)	Etiket haritasından değerlere giden bir çoklu seçim girişi oluşturun.
select(options)	Bir değer serisinden seçim girdisi oluşturun.
select(optionsWithEtiketler)	Etiket haritasından değerlere sahip bir giriş oluşturun.

Sınıflar

Sınıf	Açıklama
İfade

Arayüzler

Arayüz	Açıklama
MultiSelectInput	Bir parametrenin değerinin, kullanıcının önceden hazır seçenekler listesinden bir alt kümeyi dağıtım sırasında etkileşimli olarak seçmesini sağlayarak belirlenmesi gerektiğini belirtir. string[] dışındaki tür parametrelerde kullanılırsa hatalara neden olur.
SelectInput	Bir parametrenin değerinin, dağıtım sırasında kullanıcının önceden hazırlanmış seçenekler listesinden etkileşimli olarak seçmesini sağlayarak belirlenmesi gerektiğini belirtir.
Seçenekleri belirleyin	Bir değer ve isteğe bağlı olarak seçim arayüzünde görüntülenecek, insan tarafından okunabilen bir etiket içeren SelectInput için sunulan seçeneklerden biri.
TextInput	Bir parametrenin değerinin, dağıtım sırasında kullanıcıdan parametreyi etkileşimli olarak yazması istenerek belirlenmesi gerektiğini belirtir. Sağlanan VerifyRegex ile eşleşmeyen giriş, varsa yeniden denenir.

Değişkenler

Değişken	Açıklama
PAKET_SEÇİCİ	Bir projede kullanıcıların aralarından seçim yapabileceği paketlerin listesini otomatik olarak oluşturma.
veritabanıURL'si	Dağıtıcıya sormadan projeyle ilişkili varsayılan RTDB veritabanı URL'sine çözümlenen yerleşik bir parametre. Yoksa boş dize.
declaredParams
gcloudProject	Dağıtıcıya sormadan Cloud projesi kimliğine çözümlenen yerleşik bir parametre.
proje kimliği	Dağıtıcıya sormadan projeyle ilişkili Cloud projesi kimliğine çözümlenen yerleşik bir parametre.
storageBucket	Dağıtıcıya sormadan işlevle ilişkili Cloud Storage paketine çözümlenen yerleşik bir parametre. Tanımlanmamışsa boş dize.

Tür Takma Adları

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

params.defineBoole()

Boole parametresi tanımlayın.

İmza:

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

Parametreler

Parametre	Tür	Açıklama
ad	dize	Parametreyi yüklemek için kullanılacak ortam değişkeninin adı.
seçenekler	ParamOptions<boole>	Parametrenin yapılandırma seçenekleri.

Şunu döndürür:

BooleParam

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

params.defineInt()

Bir tam sayı parametresi tanımlayın.

İmza:

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

Parametreler

Parametre	Tür	Açıklama
ad	dize	Parametreyi yüklemek için kullanılacak ortam değişkeninin adı.
seçenekler	ParamOptions<sayı>	Parametrenin yapılandırma seçenekleri.

Şunu döndürür:

IntParam

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

params.defineList()

Bir liste parametresi tanımlayın.

İmza:

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

Parametreler

Parametre	Tür	Açıklama
ad	dize	Parametreyi yüklemek için kullanılacak ortam değişkeninin adı.
seçenekler	ParamOptions<dize[]>	Parametrenin yapılandırma seçenekleri.

Şunu döndürür:

ListParam

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

params.defineSecret()

Yalnızca Cloud Secret Manager'daki değerleri koruyacak bir gizli parametre tanımlar. Gizli anahtarlar bayt dizeleri olarak dahili olarak depolanır. Parametre çözünürlüğü sırasında tür ipucu sağlamak için ParamOptions.as kullanın.

İmza:

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

Parametreler

Parametre	Tür	Açıklama
ad	dize	Parametreyi yüklemek için kullanılacak ortam değişkeninin adı.

Şunu döndürür:

Gizli Param

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

params.defineString()

Dize parametresi tanımlayın.

İmza:

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

Parametreler

Parametre	Tür	Açıklama
ad	dize	Parametreyi yüklemek için kullanılacak ortam değişkeninin adı.
seçenekler	ParamOptions<dize>	Parametrenin yapılandırma seçenekleri.

Şunu döndürür:

StringParam

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

params.multiSelect()

Bir değer serisinden çoklu seçimli giriş oluşturma.

İmza:

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

Parametreler

Parametre	Tür	Açıklama
seçenekler	dize[]

Şunu döndürür:

MultiSelectInput

params.multiSelect()

Etiket haritasından değerlere giden bir çoklu seçim girişi oluşturun.

İmza:

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

Parametreler

Parametre	Tür	Açıklama
seçenekler	Kayıt<dize, dize>

Şunu döndürür:

MultiSelectInput

params.select()

Bir değer serisinden seçim girdisi oluşturun.

İmza:

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

Parametreler

Parametre	Tür	Açıklama
seçenekler	Tr[]

Şunu döndürür:

SelectInput<T>

params.select()

Etiket haritasından değerlere sahip bir giriş oluşturun.

İmza:

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

Parametreler

Parametre	Tür	Açıklama
seçeneklerEtiketlerle	Kayıt<string, T>

Şunu döndürür:

SelectInput<T>

params.BUCKET_SEÇİCİ

Bir projede kullanıcıların aralarından seçim yapabileceği paketlerin listesini otomatik olarak oluşturma.

İmza:

BUCKET_PICKER: ResourceInput

params.veritabanıURL'si

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

İmza:

databaseURL: Param<string>

params.declaredParams

İmza:

declaredParams: SecretOrExpr[]

params.gcloudProject

Dağıtıcıya sormadan Cloud projesi kimliğine çözümlenen yerleşik bir parametre.

İmza:

gcloudProject: Param<string>

parametre.projekimliği

Dağıtıcıya sormadan projeyle ilişkili Cloud projesi kimliğine çözümlenen yerleşik bir parametre.

İmza:

projectID: Param<string>

params.storageBucket

Dağıtıcıya sormadan işlevle ilişkili Cloud Storage paketine çö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">;