public sealed class EventTrigger : IMessage<EventTrigger>, IEquatable<EventTrigger>, IDeepCloneable<EventTrigger>, IBufferMessage, IMessage
Reference documentation and code samples for the Cloud Functions v1 API class EventTrigger.
Describes EventTrigger, used to request that events be sent from another service.
Implements
IMessageEventTrigger, IEquatableEventTrigger, IDeepCloneableEventTrigger, IBufferMessage, IMessageNamespace
Google.Cloud.Functions.V1Assembly
Google.Cloud.Functions.V1.dll
Constructors
EventTrigger()
public EventTrigger()
EventTrigger(EventTrigger)
public EventTrigger(EventTrigger other)
Parameter | |
---|---|
Name | Description |
other | EventTrigger |
Properties
EventType
public string EventType { get; set; }
Required. The type of event to observe. For example:
providers/cloud.storage/eventTypes/object.change
and
providers/cloud.pubsub/eventTypes/topic.publish
.
Event types match pattern providers/*/eventTypes/*.*
.
The pattern contains:
- namespace: For example,
cloud.storage
andgoogle.firebase.analytics
. - resource type: The type of resource on which event occurs. For
example, the Google Cloud Storage API includes the type
object
. - action: The action that generates the event. For example, action for a Google Cloud Storage Object is 'change'. These parts are lowercase.
Property Value | |
---|---|
Type | Description |
string |
FailurePolicy
public FailurePolicy FailurePolicy { get; set; }
Specifies policy for failed executions.
Property Value | |
---|---|
Type | Description |
FailurePolicy |
Resource
public string Resource { get; set; }
Required. The resource(s) from which to observe events, for example,
projects/_/buckets/myBucket
.
Not all syntactically correct values are accepted by all services. For example:
- The authorization model must support it. Google Cloud Functions
only allows EventTriggers to be deployed that observe resources in the
same project as the
CloudFunction
. - The resource type must match the pattern expected for an
event_type
. For example, anEventTrigger
that has anevent_type
of "google.pubsub.topic.publish" should have a resource that matches Google Cloud Pub/Sub topics.
Additionally, some services may support short names when creating an
EventTrigger
. These are always returned in the normalized "long"
format.
See each service's documentation for supported formats.
Property Value | |
---|---|
Type | Description |
string |
Service
public string Service { get; set; }
The hostname of the service that 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.
Property Value | |
---|---|
Type | Description |
string |