FunctionBuilder class

서명:

export declare class FunctionBuilder

생성자

생성자 특수키 설명
(생성자)(옵션) FunctionBuilder 클래스의 새 인스턴스를 생성합니다.

속성

속성 특수키 유형 설명
분석 { 이벤트: (analyticsEventType: string) => analytics.AnalyticsEventBuilder; }
인증 { 사용자: (userOptions?: auth.UserOptions) => auth.UserBuilder; }
데이터베이스 { 인스턴스: (인스턴스: 문자열) => database.InstanceBuilder 참조: <Ref 확장 문자열>(경로: Ref) => database.RefBuilder<Ref>; }
firestore { 문서: <Path 확장 문자열>(경로: 경로) => firestore.DocumentBuilder<Path>; 네임스페이스: (네임스페이스: 문자열) => firestore.NamespaceBuilder; 데이터베이스: (데이터베이스: 문자열) => firestore.DatabaseBuilder; }
https { onRequest: (핸들러: (요청: https.Request, resp: express.Response) => void | 프라미스<void>) => import("./cloud-functions").HttpsFunction; onCall: (핸들러: (데이터: 모두, 컨텍스트: https.CallableContext) => any | Promise<any>) => import("./cloud-functions").HttpsFunction 및 import("./cloud-functions").실행 가능<any>; }
Pub { 주제: (주제: 문자열) => pubsub.TopicBuilder; 일정: (일정: 문자열) => pubsub.ScheduleBuilder; }
remoteConfig { onUpdate: (handler: (버전: remoteConfig.TemplateVersion, context: EventContext) => PromiseLike<any> | any) => import("./cloud-functions").CloudFunction<remoteConfig.TemplateVersion>; }
스토리지 { 버킷: (버킷?: 문자열) => storage.BucketBuilder; 객체: () => storage.ObjectBuilder; }
할 일 { taskQueue: (options?: tasks.TaskQueueOptions) => tasks.TaskQueueBuilder; }
testLab { testMatrix: () => testLab.TestMatrixBuilder }

메소드

메서드 특수키 설명
region(리전) 함수가 배포되는 리전을 구성합니다.
runWith(runtimeOptions)를 함수의 런타임 옵션을 구성합니다.

FunctionBuilder.(생성자)

FunctionBuilder 클래스의 새 인스턴스를 생성합니다.

서명:

constructor(options: DeploymentOptions);

매개변수

매개변수 유형 설명
옵션 배포 옵션

FunctionBuilder.analytics

서명:

get analytics(): {
        event: (analyticsEventType: string) => analytics.AnalyticsEventBuilder;
    };

FunctionBuilder.auth

서명:

get auth(): {
        user: (userOptions?: auth.UserOptions) => auth.UserBuilder;
    };

FunctionBuilder.database.

서명:

get database(): {
        instance: (instance: string) => database.InstanceBuilder;
        ref: <Ref extends string>(path: Ref) => database.RefBuilder<Ref>;
    };

FunctionBuilder.firestore

서명:

get firestore(): {
        document: <Path extends string>(path: Path) => firestore.DocumentBuilder<Path>;
        namespace: (namespace: string) => firestore.NamespaceBuilder;
        database: (database: string) => firestore.DatabaseBuilder;
    };

FunctionBuilder.https

서명:

get https(): {
        onRequest: (handler: (req: https.Request, resp: express.Response) => void | Promise<void>) => import("./cloud-functions").HttpsFunction;
        onCall: (handler: (data: any, context: https.CallableContext) => any | Promise<any>) => import("./cloud-functions").HttpsFunction & import("./cloud-functions").Runnable<any>;
    };

FunctionBuilder.pubsub

서명:

get pubsub(): {
        topic: (topic: string) => pubsub.TopicBuilder;
        schedule: (schedule: string) => pubsub.ScheduleBuilder;
    };

FunctionBuilder.remoteConfig

서명:

get remoteConfig(): {
        onUpdate: (handler: (version: remoteConfig.TemplateVersion, context: EventContext) => PromiseLike<any> | any) => import("./cloud-functions").CloudFunction<remoteConfig.TemplateVersion>;
    };

FunctionBuilder.storage

서명:

get storage(): {
        bucket: (bucket?: string) => storage.BucketBuilder;
        object: () => storage.ObjectBuilder;
    };

FunctionBuilder.tasks

서명:

get tasks(): {
        taskQueue: (options?: tasks.TaskQueueOptions) => tasks.TaskQueueBuilder;
    };

FunctionBuilder.testLab

서명:

get testLab(): {
        testMatrix: () => testLab.TestMatrixBuilder;
    };

FunctionBuilder.region()

함수가 배포되는 리전을 구성합니다.

서명:

region(...regions: Array<(typeof SUPPORTED_REGIONS)[number] | string | Expression<string> | ResetValue>): FunctionBuilder;

매개변수

매개변수 유형 설명
리전 배열<(유형: SUPPORTED_REGIONS)[숫자] | 문자열 | 표현식<string> | 재설정 값> 하나 이상의 지역 문자열입니다.

반환:

함수 빌더

예 1

functions.region('us-east1')

예 2

functions.region('us-east1', 'us-central1')

FunctionBuilder.runWith()

함수의 런타임 옵션을 구성합니다.

서명:

runWith(runtimeOptions: RuntimeOptions): FunctionBuilder;

매개변수

매개변수 유형 설명
런타임 옵션 RuntimeOptions 선택 필드가 있는 객체: 1. memory: 함수에 할당할 메모리 용량입니다. 가능한 값은 '128MB', '256MB', '512MB', '1GB', '2GB', '4GB', '8GB'입니다. 2. timeoutSeconds: 초 단위의 함수 제한 시간. 가능한 값은 0~540입니다. 3. failurePolicy: 함수의 실패 정책으로, 불리언 true는 빈 재시도 객체를 제공하는 것과 같습니다. 4. vpcConnector: 동일한 프로젝트 및 리전 5에 있는 VPC 커넥터의 ID입니다. vpcConnectorEgressSettings: vpcConnector가 설정되면 vpcConnector를 통해 전송되는 이그레스 트래픽을 제어합니다.값은 null이 아니어야 합니다.

반환:

함수 빌더