Class: Google::Apis::CloudfunctionsV2alpha::EventTrigger

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

Overview

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ EventTrigger

Returns a new instance of EventTrigger.



338
339
340
# File 'lib/google/apis/cloudfunctions_v2alpha/classes.rb', line 338

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

Instance Attribute Details

#event_filtersArray<Google::Apis::CloudfunctionsV2alpha::EventFilter>

Criteria used to filter events. Corresponds to the JSON property eventFilters



293
294
295
# File 'lib/google/apis/cloudfunctions_v2alpha/classes.rb', line 293

def event_filters
  @event_filters
end

#event_typeString

Required. The type of event to observe. For example: google.cloud.audit.log. v1.written or google.cloud.pubsub.topic.v1.messagePublished. Corresponds to the JSON property eventType

Returns:

  • (String)


299
300
301
# File 'lib/google/apis/cloudfunctions_v2alpha/classes.rb', line 299

def event_type
  @event_type
end

#pubsub_topicString

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 typegoogle.cloud.pubsub.topic.v1. messagePublished. The topic provided here will not be deleted at function deletion. Corresponds to the JSON propertypubsubTopic`

Returns:

  • (String)


308
309
310
# File 'lib/google/apis/cloudfunctions_v2alpha/classes.rb', line 308

def pubsub_topic
  @pubsub_topic
end

#retry_policyString

Optional. If unset, then defaults to ignoring failures (i.e. not retrying them) . Corresponds to the JSON property retryPolicy

Returns:

  • (String)


314
315
316
# File 'lib/google/apis/cloudfunctions_v2alpha/classes.rb', line 314

def retry_policy
  @retry_policy
end

#service_account_emailString

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. Corresponds to the JSON propertyserviceAccountEmail`

Returns:

  • (String)


322
323
324
# File 'lib/google/apis/cloudfunctions_v2alpha/classes.rb', line 322

def 
  @service_account_email
end

#triggerString

Output only. The resource name of the Eventarc trigger. The format of this field is projects/project/locations/region/triggers/trigger`. Corresponds to the JSON propertytrigger`

Returns:

  • (String)


328
329
330
# File 'lib/google/apis/cloudfunctions_v2alpha/classes.rb', line 328

def trigger
  @trigger
end

#trigger_regionString

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

Returns:

  • (String)


336
337
338
# File 'lib/google/apis/cloudfunctions_v2alpha/classes.rb', line 336

def trigger_region
  @trigger_region
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



343
344
345
346
347
348
349
350
351
# File 'lib/google/apis/cloudfunctions_v2alpha/classes.rb', line 343

def update!(**args)
  @event_filters = args[:event_filters] if args.key?(:event_filters)
  @event_type = args[:event_type] if args.key?(:event_type)
  @pubsub_topic = args[:pubsub_topic] if args.key?(:pubsub_topic)
  @retry_policy = args[:retry_policy] if args.key?(:retry_policy)
  @service_account_email = args[:service_account_email] if args.key?(:service_account_email)
  @trigger = args[:trigger] if args.key?(:trigger)
  @trigger_region = args[:trigger_region] if args.key?(:trigger_region)
end