Cloud Functions v1 API - Class EventTrigger (2.5.0)

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 events be sent from another service.

Inheritance

object > EventTrigger

Namespace

Google.Cloud.Functions.V1

Assembly

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:

  1. namespace: For example, cloud.storage and google.firebase.analytics.
  2. resource type: The type of resource on which event occurs. For example, the Google Cloud Storage API includes the type object.
  3. action: The action that generates the event. For example, action for a Google Cloud Storage Object is 'change'. These parts are lower case.
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:

  1. 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.
  2. The resource type must match the pattern expected for an event_type. For example, an EventTrigger that has an event_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 will always be 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