|
| 1 | +/** |
| 2 | + * Translate Text in Firestore SDK for [email protected] |
| 3 | + * |
| 4 | + * When filing bugs or feature requests please specify: |
| 5 | + * "Extensions SDK v1.0.0 for [email protected]" |
| 6 | + * https://github.com/firebase/firebase-tools/issues/new/choose |
| 7 | + * |
| 8 | + * GENERATED FILE. DO NOT EDIT. |
| 9 | + */ |
| 10 | +import { CloudEvent } from "../../../../v2"; |
| 11 | +import { EventarcTriggerOptions } from "../../../../v2/eventarc"; |
| 12 | +export type EventCallback<T> = (event: CloudEvent<T>) => unknown | Promise<unknown>; |
| 13 | +export type SimpleEventarcTriggerOptions = Omit< |
| 14 | + EventarcTriggerOptions, |
| 15 | + "eventType" | "channel" | "region" |
| 16 | +>; |
| 17 | +export type EventArcRegionType = "us-central1" | "us-west1" | "europe-west4" | "asia-northeast1"; |
| 18 | +export type SystemFunctionVpcConnectorEgressSettingsParam = |
| 19 | + | "VPC_CONNECTOR_EGRESS_SETTINGS_UNSPECIFIED" |
| 20 | + | "PRIVATE_RANGES_ONLY" |
| 21 | + | "ALL_TRAFFIC"; |
| 22 | +export type SystemFunctionIngressSettingsParam = |
| 23 | + | "ALLOW_ALL" |
| 24 | + | "ALLOW_INTERNAL_ONLY" |
| 25 | + | "ALLOW_INTERNAL_AND_GCLB"; |
| 26 | +export type SystemFunctionLocationParam = |
| 27 | + | "us-central1" |
| 28 | + | "us-east1" |
| 29 | + | "us-east4" |
| 30 | + | "us-west1" |
| 31 | + | "us-west2" |
| 32 | + | "us-west3" |
| 33 | + | "us-west4" |
| 34 | + | "europe-central2" |
| 35 | + | "europe-west1" |
| 36 | + | "europe-west2" |
| 37 | + | "europe-west3" |
| 38 | + | "europe-west6" |
| 39 | + | "asia-east1" |
| 40 | + | "asia-east2" |
| 41 | + | "asia-northeast1" |
| 42 | + | "asia-northeast2" |
| 43 | + | "asia-northeast3" |
| 44 | + | "asia-south1" |
| 45 | + | "asia-southeast1" |
| 46 | + | "asia-southeast2" |
| 47 | + | "northamerica-northeast1" |
| 48 | + | "southamerica-east1" |
| 49 | + | "australia-southeast1"; |
| 50 | +export type SystemFunctionMemoryParam = "128" | "256" | "512" | "1024" | "2048" | "4096" | "8192"; |
| 51 | +/** |
| 52 | + * Parameters for [email protected] extension |
| 53 | + */ |
| 54 | +export interface FirestoreTranslateTextParams { |
| 55 | + /** |
| 56 | + * Target languages for translations, as a comma-separated list |
| 57 | + */ |
| 58 | + LANGUAGES: string; |
| 59 | + /** |
| 60 | + * Collection path |
| 61 | + */ |
| 62 | + COLLECTION_PATH: string; |
| 63 | + /** |
| 64 | + * Input field name |
| 65 | + */ |
| 66 | + INPUT_FIELD_NAME: string; |
| 67 | + /** |
| 68 | + * Translations output field name |
| 69 | + */ |
| 70 | + OUTPUT_FIELD_NAME: string; |
| 71 | + /** |
| 72 | + * Languages field name |
| 73 | + */ |
| 74 | + LANGUAGES_FIELD_NAME?: string; |
| 75 | + /** |
| 76 | + * Event Arc Region |
| 77 | + */ |
| 78 | + _EVENT_ARC_REGION?: EventArcRegionType; |
| 79 | + /** |
| 80 | + * Function timeout seconds |
| 81 | + */ |
| 82 | + _FUNCTION_TIMEOUT_SECONDS?: string; |
| 83 | + /** |
| 84 | + * VPC Connector |
| 85 | + */ |
| 86 | + _FUNCTION_VPC_CONNECTOR?: string; |
| 87 | + /** |
| 88 | + * VPC Connector Egress settings |
| 89 | + */ |
| 90 | + _FUNCTION_VPC_CONNECTOR_EGRESS_SETTINGS?: SystemFunctionVpcConnectorEgressSettingsParam; |
| 91 | + /** |
| 92 | + * Minimum function instances |
| 93 | + */ |
| 94 | + _FUNCTION_MIN_INSTANCES?: string; |
| 95 | + /** |
| 96 | + * Maximum function instances |
| 97 | + */ |
| 98 | + _FUNCTION_MAX_INSTANCES?: string; |
| 99 | + /** |
| 100 | + * Function ingress settings |
| 101 | + */ |
| 102 | + _FUNCTION_INGRESS_SETTINGS?: SystemFunctionIngressSettingsParam; |
| 103 | + /** |
| 104 | + * Function labels |
| 105 | + */ |
| 106 | + _FUNCTION_LABELS?: string; |
| 107 | + /** |
| 108 | + * KMS key name |
| 109 | + */ |
| 110 | + _FUNCTION_KMS_KEY_NAME?: string; |
| 111 | + /** |
| 112 | + * Docker repository |
| 113 | + */ |
| 114 | + _FUNCTION_DOCKER_REPOSITORY?: string; |
| 115 | + /** |
| 116 | + * Cloud Functions location |
| 117 | + */ |
| 118 | + _FUNCTION_LOCATION: SystemFunctionLocationParam; |
| 119 | + /** |
| 120 | + * Function memory |
| 121 | + */ |
| 122 | + _FUNCTION_MEMORY?: SystemFunctionMemoryParam; |
| 123 | +} |
| 124 | +export declare function firestoreTranslateText( |
| 125 | + instanceId: string, |
| 126 | + params: FirestoreTranslateTextParams |
| 127 | +): FirestoreTranslateText; |
| 128 | +/** |
| 129 | + * Translate Text in Firestore |
| 130 | + * Translates strings written to a Cloud Firestore collection into multiple languages (uses Cloud Translation API). |
| 131 | + */ |
| 132 | +export declare class FirestoreTranslateText { |
| 133 | + private instanceId; |
| 134 | + private params; |
| 135 | + events: string[]; |
| 136 | + readonly FIREBASE_EXTENSION_REFERENCE = "firebase/[email protected]"; |
| 137 | + readonly EXTENSION_VERSION = "0.1.18"; |
| 138 | + constructor(instanceId: string, params: FirestoreTranslateTextParams); |
| 139 | + getInstanceId(): string; |
| 140 | + getParams(): FirestoreTranslateTextParams; |
| 141 | + /** |
| 142 | + * Occurs when a trigger has been called within the Extension, and will include data such as the context of the trigger request. |
| 143 | + */ |
| 144 | + onStart<T = unknown>( |
| 145 | + callback: EventCallback<T>, |
| 146 | + options?: SimpleEventarcTriggerOptions |
| 147 | + ): import("firebase-functions/v2").CloudFunction<CloudEvent<T>>; |
| 148 | + /** |
| 149 | + * Occurs when image resizing completes successfully. The event will contain further details about specific formats and sizes. |
| 150 | + */ |
| 151 | + onSuccess<T = unknown>( |
| 152 | + callback: EventCallback<T>, |
| 153 | + options?: SimpleEventarcTriggerOptions |
| 154 | + ): import("firebase-functions/v2").CloudFunction<CloudEvent<T>>; |
| 155 | + /** |
| 156 | + * Occurs when an issue has been experienced in the Extension. This will include any error data that has been included within the Error Exception. |
| 157 | + */ |
| 158 | + onError<T = unknown>( |
| 159 | + callback: EventCallback<T>, |
| 160 | + options?: SimpleEventarcTriggerOptions |
| 161 | + ): import("firebase-functions/v2").CloudFunction<CloudEvent<T>>; |
| 162 | + /** |
| 163 | + * Occurs when the function is settled. Provides no customized data other than the context. |
| 164 | + */ |
| 165 | + onCompletion<T = unknown>( |
| 166 | + callback: EventCallback<T>, |
| 167 | + options?: SimpleEventarcTriggerOptions |
| 168 | + ): import("firebase-functions/v2").CloudFunction<CloudEvent<T>>; |
| 169 | +} |
0 commit comments