public sealed class EventTrigger : IMessage<EventTrigger>, IEquatable<EventTrigger>, IDeepCloneable<EventTrigger>, IBufferMessage, IMessageReference documentation and code samples for the Cloud Functions v2 API class EventTrigger.
Describes EventTrigger, used to request events to be sent from another service.
Implements
IMessageEventTrigger, IEquatableEventTrigger, IDeepCloneableEventTrigger, IBufferMessage, IMessageNamespace
Google.Cloud.Functions.V2Assembly
Google.Cloud.Functions.V2.dll
Constructors
EventTrigger()
public EventTrigger()EventTrigger(EventTrigger)
public EventTrigger(EventTrigger other)| Parameter | |
|---|---|
| Name | Description |
other |
EventTrigger |
Properties
Channel
public string Channel { get; set; }Optional. The name of the channel associated with the trigger in
projects/{project}/locations/{location}/channels/{channel} format.
You must provide a channel to receive events from Eventarc SaaS partners.
| Property Value | |
|---|---|
| Type | Description |
string |
|
ChannelAsChannelName
public ChannelName ChannelAsChannelName { get; set; }ChannelName-typed view over the Channel resource name property.
| Property Value | |
|---|---|
| Type | Description |
ChannelName |
|
EventFilters
public RepeatedField<EventFilter> EventFilters { get; }Criteria used to filter events.
| Property Value | |
|---|---|
| Type | Description |
RepeatedFieldEventFilter |
|
EventType
public string EventType { get; set; }Required. The type of event to observe. For example:
google.cloud.audit.log.v1.written or
google.cloud.pubsub.topic.v1.messagePublished.
| Property Value | |
|---|---|
| Type | Description |
string |
|
PubsubTopic
public string PubsubTopic { get; set; }Optional. The name of a Pub/Sub topic in the same project that will be used
as the transport topic for the event delivery. Format:
projects/{project}/topics/{topic}.
This is only valid for events of type
google.cloud.pubsub.topic.v1.messagePublished. The topic provided here
will not be deleted at function deletion.
| Property Value | |
|---|---|
| Type | Description |
string |
|
PubsubTopicAsTopicName
public TopicName PubsubTopicAsTopicName { get; set; }TopicName-typed view over the PubsubTopic resource name property.
| Property Value | |
|---|---|
| Type | Description |
TopicName |
|
RetryPolicy
public EventTrigger.Types.RetryPolicy RetryPolicy { get; set; }Optional. If unset, then defaults to ignoring failures (i.e. not retrying them).
| Property Value | |
|---|---|
| Type | Description |
EventTriggerTypesRetryPolicy |
|
Service
public string Service { get; set; }Optional. The hostname of the service that 1st Gen function should be observed.
If no string is provided, the default service implementing the API will
be used. For example, storage.googleapis.com is the default for all
event types in the google.storage namespace.
The field is only applicable to 1st Gen functions.
| Property Value | |
|---|---|
| Type | Description |
string |
|
ServiceAccountEmail
public string ServiceAccountEmail { get; set; }Optional. The email of the trigger's service account. The service account
must have permission to invoke Cloud Run services, the permission is
run.routes.invoke.
If empty, defaults to the Compute Engine default service account:
{project_number}-compute@developer.gserviceaccount.com.
| Property Value | |
|---|---|
| Type | Description |
string |
|
Trigger
public string Trigger { get; set; }Output only. The resource name of the Eventarc trigger. The format of this
field is projects/{project}/locations/{region}/triggers/{trigger}.
| Property Value | |
|---|---|
| Type | Description |
string |
|
TriggerAsTriggerName
public TriggerName TriggerAsTriggerName { get; set; }TriggerName-typed view over the Trigger resource name property.
| Property Value | |
|---|---|
| Type | Description |
TriggerName |
|
TriggerRegion
public string TriggerRegion { get; set; }The region that the trigger will be in. The trigger will only receive events originating in this region. It can be the same region as the function, a different region or multi-region, or the global region. If not provided, defaults to the same region as the function.
| Property Value | |
|---|---|
| Type | Description |
string |
|