params namespace

함수

함수 설명
defineboolean(이름, 옵션) 불리언 매개변수를 선언합니다.
defineInt(이름, 옵션) 정수 매개변수를 선언합니다.
defineList(이름, 옵션) list 매개변수를 선언합니다.
defineSecret(이름) Cloud Secret Manager에서만 값을 유지하는 보안 비밀 매개변수를 선언합니다. 보안 비밀은 내부적으로 바이트 문자열로 저장됩니다. ParamOptions.as를 사용하여 매개변수를 확인하는 동안 유형 힌트를 제공합니다.
defineString(이름, 옵션) 문자열 매개변수를 선언합니다.
다중 선택(옵션) 일련의 값에서 다중 선택 입력을 만듭니다.
다중 선택(옵션) 라벨 값 매핑에서 다중 선택 입력을 만듭니다.
선택(옵션) 일련의 값에서 선택 입력을 만듭니다.
select(optionsWithLabels) 라벨 값 매핑에서 선택 입력을 만듭니다.

클래스

클래스 설명
표현식

인터페이스

인터페이스 설명
다중 선택 입력 사용자가 배포 시 대화형으로 미리 준비된 옵션 목록에서 하위 집합을 선택하도록 하여 매개변수 값을 결정하도록 지정합니다. string[] 이외의 매개변수에 사용하면 오류가 발생합니다.
입력 선택 사용자가 배포 시 미리 준비된 옵션 목록에서 대화형으로 선택하도록 하여 매개변수 값을 결정하도록 지정합니다.
SelectOptions SelectInput에 제공되는 옵션 중 하나로, 선택 인터페이스에 표시할 값과 선택적으로 사람이 읽을 수 있는 라벨이 포함됩니다.
TextInput 배포 시 사용자에게 대화형으로 입력하라는 메시지를 표시하여 매개변수 값을 결정하도록 지정합니다. 제공된 ValidationRegex와 일치하지 않는 입력이 있으면 재시도됩니다.

변수

변수 설명
버킷_선택 사용자가 선택할 수 있는 프로젝트의 버킷 목록을 자동 생성합니다.
데이터베이스 URL 배포자에게 메시지를 표시하지 않고 프로젝트와 연결된 기본 RTDB 데이터베이스 URL로 확인되는 내장 매개변수입니다. 없는 경우 빈 문자열입니다.
DeclaredParams
gcloud프로젝트 배포자에게 메시지를 표시하지 않고 Cloud 프로젝트 ID로 확인되는 기본 제공 매개변수입니다.
프로젝트 ID 배포자에게 메시지를 표시하지 않고 프로젝트와 연결된 Cloud 프로젝트 ID로 확인되는 기본 제공 매개변수입니다.
저장소 버킷 배포자에게 메시지를 표시하지 않고 함수와 연결된 Cloud Storage 버킷으로 확인되는 기본 제공 매개변수입니다. 정의되지 않은 경우 빈 문자열입니다.

유형 별칭

별칭 입력 설명
매개변수 옵션 매개변수의 메시지 표시 동작을 맞춤설정하는 데 사용할 수 있는 구성 옵션입니다.

params.defineboolean()

불리언 매개변수를 선언합니다.

서명:

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

매개변수

매개변수 유형 설명
name 문자열 매개변수를 로드하는 데 사용할 환경 변수의 이름입니다.
옵션 ParamOptions<boolean> 매개변수의 구성 옵션입니다.

반환:

부울 매개변수

.value의 반환 유형이 boolean인 매개변수입니다.

params.defineInt()

정수 매개변수를 선언합니다.

서명:

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

매개변수

매개변수 유형 설명
name 문자열 매개변수를 로드하는 데 사용할 환경 변수의 이름입니다.
옵션 ParamOptions<숫자> 매개변수의 구성 옵션입니다.

반환:

IntParam

.value의 반환 유형이 number인 매개변수입니다.

params.defineList()

list 매개변수를 선언합니다.

서명:

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

매개변수

매개변수 유형 설명
name 문자열 매개변수를 로드하는 데 사용할 환경 변수의 이름입니다.
옵션 ParamOptions<string[]> 매개변수의 구성 옵션입니다.

반환:

ListParam

.value의 반환 유형이 string[]인 매개변수입니다.

params.defineSecret()

Cloud Secret Manager에서만 값을 유지하는 보안 비밀 매개변수를 선언합니다. 보안 비밀은 내부적으로 바이트 문자열로 저장됩니다. ParamOptions.as를 사용하여 매개변수를 확인하는 동안 유형 힌트를 제공합니다.

서명:

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

매개변수

매개변수 유형 설명
name 문자열 매개변수를 로드하는 데 사용할 환경 변수의 이름입니다.

반환:

SecretParam

.value의 반환 유형이 string인 매개변수입니다.

params.defineString()

문자열 매개변수를 선언합니다.

서명:

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

매개변수

매개변수 유형 설명
name 문자열 매개변수를 로드하는 데 사용할 환경 변수의 이름입니다.
옵션 ParamOptions<string> 매개변수의 구성 옵션입니다.

반환:

문자열 매개변수

.value의 반환 유형이 string인 매개변수입니다.

params.multiSelect()

일련의 값에서 다중 선택 입력을 만듭니다.

서명:

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

매개변수

매개변수 유형 설명
옵션 문자열[]

반환:

다중 선택 입력

params.multiSelect()

라벨 값 매핑에서 다중 선택 입력을 만듭니다.

서명:

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

매개변수

매개변수 유형 설명
옵션 레코드<문자열, 문자열>

반환:

다중 선택 입력

params.select()

일련의 값에서 선택 입력을 만듭니다.

서명:

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

매개변수

매개변수 유형 설명
옵션 참[]

반환:

SelectInput<T>

params.select()

라벨 값 매핑에서 선택 입력을 만듭니다.

서명:

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

매개변수

매개변수 유형 설명
옵션 포함 라벨 레코드<문자열, T>

반환:

SelectInput<T>

params.BUCKET_PICKER

사용자가 선택할 수 있는 프로젝트의 버킷 목록을 자동 생성합니다.

서명:

BUCKET_PICKER: ResourceInput

params.databaseURL

배포자에게 메시지를 표시하지 않고 프로젝트와 연결된 기본 RTDB 데이터베이스 URL로 확인되는 내장 매개변수입니다. 없는 경우 빈 문자열입니다.

서명:

databaseURL: Param<string>

params.DeclaredParams

서명:

declaredParams: SecretOrExpr[]

params.gcloudProject

배포자에게 메시지를 표시하지 않고 Cloud 프로젝트 ID로 확인되는 기본 제공 매개변수입니다.

서명:

gcloudProject: Param<string>

params.projectID

배포자에게 메시지를 표시하지 않고 프로젝트와 연결된 Cloud 프로젝트 ID로 확인되는 기본 제공 매개변수입니다.

서명:

projectID: Param<string>

params.storageBucket

배포자에게 메시지를 표시하지 않고 함수와 연결된 Cloud Storage 버킷으로 확인되는 기본 제공 매개변수입니다. 정의되지 않은 경우 빈 문자열입니다.

서명:

storageBucket: Param<string>

params.ParamOptions

매개변수의 메시지 표시 동작을 맞춤설정하는 데 사용할 수 있는 구성 옵션입니다.

서명:

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