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