View Source GoogleApi.CloudFunctions.V1.Model.EventTrigger (google_api_cloud_functions v0.37.0)
Describes EventTrigger, used to request events be sent from another service.
Attributes
-
eventType
(type:String.t
, default:nil
) - Required. The type of event to observe. For example:providers/cloud.storage/eventTypes/object.change
andproviders/cloud.pubsub/eventTypes/topic.publish
. Event types match patternproviders/*/eventTypes/*.*
. The pattern contains: 1. namespace: For example,cloud.storage
andgoogle.firebase.analytics
. 2. resource type: The type of resource on which event occurs. For example, the Google Cloud Storage API includes the typeobject
. 3. action: The action that generates the event. For example, action for a Google Cloud Storage Object is 'change'. These parts are lower case. -
failurePolicy
(type:GoogleApi.CloudFunctions.V1.Model.FailurePolicy.t
, default:nil
) - Specifies policy for failed executions. -
resource
(type:String.t
, default:nil
) - 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 theCloudFunction
. 2. The resource type must match the pattern expected for anevent_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 anEventTrigger
. These will always be returned in the normalized "long" format. See each service's documentation for supported formats. -
service
(type:String.t
, default:nil
) - 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 thegoogle.storage
namespace.
Summary
Functions
Unwrap a decoded JSON object into its complex fields.
Types
@type t() :: %GoogleApi.CloudFunctions.V1.Model.EventTrigger{ eventType: String.t() | nil, failurePolicy: GoogleApi.CloudFunctions.V1.Model.FailurePolicy.t() | nil, resource: String.t() | nil, service: String.t() | nil }
Functions
Unwrap a decoded JSON object into its complex fields.