Class: Google::Apis::CloudfunctionsV1::EventTrigger
- Inherits:
-
Object
- Object
- Google::Apis::CloudfunctionsV1::EventTrigger
- 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
-
#event_type ⇒ String
Required.
-
#failure_policy ⇒ Google::Apis::CloudfunctionsV1::FailurePolicy
Describes the policy in case of function's execution failure.
-
#resource ⇒ String
Required.
-
#service ⇒ String
The hostname of the service that should be observed.
Instance Method Summary collapse
-
#initialize(**args) ⇒ EventTrigger
constructor
A new instance of EventTrigger.
-
#update!(**args) ⇒ Object
Update properties of this object.
Methods included from Google::Apis::Core::JsonObjectSupport
Methods included from Google::Apis::Core::Hashable
Constructor Details
#initialize(**args) ⇒ EventTrigger
Returns a new instance of EventTrigger
468 469 470 |
# File 'generated/google/apis/cloudfunctions_v1/classes.rb', line 468 def initialize(**args) update!(**args) end |
Instance Attribute Details
#event_type ⇒ String
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:
- namespace: For example,
cloud.storage
andgoogle.firebase.analytics
. - resource type: The type of resource on which event occurs. For
example, the Google Cloud Storage API includes the type
object
. - action: The action that generates the event. For example, action for
a Google Cloud Storage Object is 'change'.
These parts are lower case.
Corresponds to the JSON property
eventType
433 434 435 |
# File 'generated/google/apis/cloudfunctions_v1/classes.rb', line 433 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
439 440 441 |
# File 'generated/google/apis/cloudfunctions_v1/classes.rb', line 439 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:
- 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
. - The resource type must match the pattern expected for an
event_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. Corresponds to the JSON propertyresource
458 459 460 |
# File 'generated/google/apis/cloudfunctions_v1/classes.rb', line 458 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
466 467 468 |
# File 'generated/google/apis/cloudfunctions_v1/classes.rb', line 466 def service @service end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
473 474 475 476 477 478 |
# File 'generated/google/apis/cloudfunctions_v1/classes.rb', line 473 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 |