Class: Google::Apis::CloudfunctionsV1::EventTrigger

Inherits:
Object
  • Object
show all
Includes:
Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
Defined in:
generated/google/apis/cloudfunctions_v1/classes.rb,
generated/google/apis/cloudfunctions_v1/representations.rb,
generated/google/apis/cloudfunctions_v1/representations.rb

Overview

Describes EventTrigger, used to request events be sent from another service.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Google::Apis::Core::JsonObjectSupport

#to_json

Methods included from Google::Apis::Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ EventTrigger

Returns a new instance of EventTrigger



253
254
255
 
# File 'generated/google/apis/cloudfunctions_v1/classes.rb', line 253

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#event_type ⇒ String

Required. The type of event to observe. For example: google.storage.object.finalized and google.firebase.analytics.event.log. Event type consists of three parts:

  1. namespace: The domain name of the organization in reverse-domain notation (e.g. acme.net appears as net.acme) and any orginization specific subdivisions. If the organization's top-level domain is com, the top-level domain is ommited (e.g. google.com appears as google). For example, google.storage and google.firebase.analytics.
  2. resource type: The type of resource on which event ocurs. For example, the Google Cloud Storage API includes the type object.
  3. action: The action that generates the event. For example, actions for a Google Cloud Storage Object include 'finalize' and 'delete'. These parts are lower case and joined by '.'. Corresponds to the JSON property eventType

Returns:

  • (String) 


218
219
220
 
# File 'generated/google/apis/cloudfunctions_v1/classes.rb', line 218

def event_type
  @event_type
end

#failure_policy ⇒ Google::Apis::CloudfunctionsV1::FailurePolicy

Describes the policy in case of function's execution failure. If empty, then defaults to ignoring failures (i.e. not retrying them). Corresponds to the JSON property failurePolicy

Returns:



224
225
226
 
# File 'generated/google/apis/cloudfunctions_v1/classes.rb', line 224

def failure_policy
  @failure_policy
end

#resource ⇒ String

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. Corresponds to the JSON property resource

Returns:

  • (String) 


243
244
245
 
# File 'generated/google/apis/cloudfunctions_v1/classes.rb', line 243

def resource
  @resource
end

#service ⇒ String

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. Corresponds to the JSON property service

Returns:

  • (String) 


251
252
253
 
# File 'generated/google/apis/cloudfunctions_v1/classes.rb', line 251

def service
  @service
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



258
259
260
261
262
263
 
# File 'generated/google/apis/cloudfunctions_v1/classes.rb', line 258

def update!(**args)
  @event_type = args[:event_type] if args.key?(:event_type)
  @failure_policy = args[:failure_policy] if args.key?(:failure_policy)
  @resource = args[:resource] if args.key?(:resource)
  @service = args[:service] if args.key?(:service)
end