Additional fields that can be set on any event-handling function.
Signature:
export interface EventHandlerOptions extends Omit<GlobalOptions, "enforceAppCheck">
Extends: Omit<GlobalOptions, "enforceAppCheck">
Properties
| Property | Type | Description |
|---|---|---|
| channel | string | The name of the channel where the function receives events. |
| eventFilterPathPatterns | Record<string, string | Expression<string>> | TODO |
| eventFilters | Record<string, string | Expression<string>> | TODO |
| eventType | string | Type of the event. Valid values are TODO |
| region | string | Expression<string> | ResetValue | Region of the EventArc trigger. |
| retry | boolean | Expression<boolean> | ResetValue | Whether failed executions should be delivered again. |
| serviceAccount | string | Expression<string> | ResetValue | The service account that EventArc should use to invoke this function. Requires the P4SA to have ActAs permission on this service account. |
EventHandlerOptions.channel
The name of the channel where the function receives events.
Signature:
channel?: string;
EventHandlerOptions.eventFilterPathPatterns
TODO
Signature:
eventFilterPathPatterns?: Record<string, string | Expression<string>>;
EventHandlerOptions.eventFilters
TODO
Signature:
eventFilters?: Record<string, string | Expression<string>>;
EventHandlerOptions.eventType
Type of the event. Valid values are TODO
Signature:
eventType?: string;
EventHandlerOptions.region
Region of the EventArc trigger.
Signature:
region?: string | Expression<string> | ResetValue;
EventHandlerOptions.retry
Whether failed executions should be delivered again.
Signature:
retry?: boolean | Expression<boolean> | ResetValue;
EventHandlerOptions.serviceAccount
The service account that EventArc should use to invoke this function. Requires the P4SA to have ActAs permission on this service account.
Signature:
serviceAccount?: string | Expression<string> | ResetValue;