import { ResetValue } from "../../common/options"; import { CloudEvent, CloudFunction } from "../core"; import { Expression } from "../../params"; import * as options from "../options"; import { SecretParam } from "../../params/types"; /** Options that can be set on an Eventarc trigger. */ export interface EventarcTriggerOptions extends options.EventHandlerOptions { /** * Type of the event to trigger on. */ eventType: string; /** * ID of the channel. Can be either: * * fully qualified channel resource name: * `projects/{project}/locations/{location}/channels/{channel-id}` * * partial resource name with location and channel ID, in which case * the runtime project ID of the function will be used: * `locations/{location}/channels/{channel-id}` * * partial channel ID, in which case the runtime project ID of the * function and `us-central1` as location will be used: * `{channel-id}` * * If not specified, the default Firebase channel will be used: * `projects/{project}/locations/us-central1/channels/firebase` */ channel?: string; /** * Eventarc event exact match filter. */ filters?: Record; /** * If true, do not deploy or emulate this function. */ omit?: boolean | Expression; /** * Region where functions should be deployed. */ region?: options.SupportedRegion | string | Expression | ResetValue; /** * Amount of memory to allocate to a function. */ memory?: options.MemoryOption | Expression | ResetValue; /** * Timeout for the function in seconds, possible values are 0 to 540. * HTTPS functions can specify a higher timeout. * * @remarks * The minimum timeout for a gen 2 function is 1s. The maximum timeout for a * function depends on the type of function: Event handling functions have a * maximum timeout of 540s (9 minutes). HTTPS and callable functions have a * maximum timeout of 36,00s (1 hour). Task queue functions have a maximum * timeout of 1,800s (30 minutes) */ timeoutSeconds?: number | Expression | ResetValue; /** * Min number of actual instances to be running at a given time. * * @remarks * Instances will be billed for memory allocation and 10% of CPU allocation * while idle. */ minInstances?: number | Expression | ResetValue; /** * Max number of instances to be running in parallel. */ maxInstances?: number | Expression | ResetValue; /** * Number of requests a function can serve at once. * * @remarks * Can only be applied to functions running on Cloud Functions v2. * A value of null restores the default concurrency (80 when CPU >= 1, 1 otherwise). * Concurrency cannot be set to any value other than 1 if `cpu` is less than 1. * The maximum value for concurrency is 1,000. */ concurrency?: number | Expression | ResetValue; /** * Fractional number of CPUs to allocate to a function. * * @remarks * Defaults to 1 for functions with <= 2GB RAM and increases for larger memory sizes. * This is different from the defaults when using the gcloud utility and is different from * the fixed amount assigned in Google Cloud Functions generation 1. * To revert to the CPU amounts used in gcloud or in Cloud Functions generation 1, set this * to the value "gcf_gen1" */ cpu?: number | "gcf_gen1"; /** * Connect cloud function to specified VPC connector. */ vpcConnector?: string | Expression | ResetValue; /** * Egress settings for VPC connector. */ vpcConnectorEgressSettings?: options.VpcEgressSetting | ResetValue; /** * Specific service account for the function to run as. */ serviceAccount?: string | Expression | ResetValue; /** * Ingress settings which control where this function can be called from. */ ingressSettings?: options.IngressSetting | ResetValue; /** * User labels to set on the function. */ labels?: Record; secrets?: (string | SecretParam)[]; /** Whether failed executions should be delivered again. */ retry?: boolean | Expression | ResetValue; } /** Handles an Eventarc event published on the default channel. * @param eventType - Type of the event to trigger on. * @param handler - A function to execute when triggered. * @returns A function that you can export and deploy. */ export declare function onCustomEventPublished(eventType: string, handler: (event: CloudEvent) => any | Promise): CloudFunction>; /** Handles an Eventarc event. * @param opts - Options to set on this function * @param handler - A function to execute when triggered. * @returns A function that you can export and deploy. */ export declare function onCustomEventPublished(opts: EventarcTriggerOptions, handler: (event: CloudEvent) => any | Promise): CloudFunction>;