Class: Google::Apis::CloudfunctionsV2alpha::EventTrigger
- Inherits:
-
Object
- Object
- Google::Apis::CloudfunctionsV2alpha::EventTrigger
- 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
-
#channel ⇒ String
Optional.
-
#event_filters ⇒ Array<Google::Apis::CloudfunctionsV2alpha::EventFilter>
Criteria used to filter events.
-
#event_type ⇒ String
Required.
-
#pubsub_topic ⇒ String
Optional.
-
#retry_policy ⇒ String
Optional.
-
#service_account_email ⇒ String
Optional.
-
#trigger ⇒ String
Output only.
-
#trigger_region ⇒ String
The region that the trigger will be in.
Instance Method Summary collapse
-
#initialize(**args) ⇒ EventTrigger
constructor
A new instance of EventTrigger.
-
#update!(**args) ⇒ Object
Update properties of this object.
Constructor Details
#initialize(**args) ⇒ EventTrigger
Returns a new instance of EventTrigger.
361 362 363 |
# File 'lib/google/apis/cloudfunctions_v2alpha/classes.rb', line 361 def initialize(**args) update!(**args) end |
Instance Attribute Details
#channel ⇒ String
Optional. The name of the channel associated with the trigger in projects/
project/locations/
location/channels/
channel`format. You must provide a
channel to receive events from Eventarc SaaS partners.
Corresponds to the JSON property
channel`
311 312 313 |
# File 'lib/google/apis/cloudfunctions_v2alpha/classes.rb', line 311 def channel @channel end |
#event_filters ⇒ Array<Google::Apis::CloudfunctionsV2alpha::EventFilter>
Criteria used to filter events.
Corresponds to the JSON property eventFilters
316 317 318 |
# File 'lib/google/apis/cloudfunctions_v2alpha/classes.rb', line 316 def event_filters @event_filters end |
#event_type ⇒ String
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
322 323 324 |
# File 'lib/google/apis/cloudfunctions_v2alpha/classes.rb', line 322 def event_type @event_type end |
#pubsub_topic ⇒ String
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 type
google.cloud.pubsub.topic.v1.
messagePublished. The topic provided here will not be deleted at function
deletion.
Corresponds to the JSON property
pubsubTopic`
331 332 333 |
# File 'lib/google/apis/cloudfunctions_v2alpha/classes.rb', line 331 def pubsub_topic @pubsub_topic end |
#retry_policy ⇒ String
Optional. If unset, then defaults to ignoring failures (i.e. not retrying them)
.
Corresponds to the JSON property retryPolicy
337 338 339 |
# File 'lib/google/apis/cloudfunctions_v2alpha/classes.rb', line 337 def retry_policy @retry_policy end |
#service_account_email ⇒ String
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 property
serviceAccountEmail`
345 346 347 |
# File 'lib/google/apis/cloudfunctions_v2alpha/classes.rb', line 345 def service_account_email @service_account_email end |
#trigger ⇒ String
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 property
trigger`
351 352 353 |
# File 'lib/google/apis/cloudfunctions_v2alpha/classes.rb', line 351 def trigger @trigger end |
#trigger_region ⇒ String
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
359 360 361 |
# File 'lib/google/apis/cloudfunctions_v2alpha/classes.rb', line 359 def trigger_region @trigger_region end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
366 367 368 369 370 371 372 373 374 375 |
# File 'lib/google/apis/cloudfunctions_v2alpha/classes.rb', line 366 def update!(**args) @channel = args[:channel] if args.key?(:channel) @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 |