Reference documentation and code samples for the Cloud Functions V2 API class Google::Cloud::Functions::V2::EventTrigger.
Describes EventTrigger, used to request events to be sent from another service.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#channel
def channel() -> ::String
-
(::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.
#channel=
def channel=(value) -> ::String
-
value (::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.
-
(::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.
#event_filters
def event_filters() -> ::Array<::Google::Cloud::Functions::V2::EventFilter>
- (::Array<::Google::Cloud::Functions::V2::EventFilter>) — Criteria used to filter events.
#event_filters=
def event_filters=(value) -> ::Array<::Google::Cloud::Functions::V2::EventFilter>
- value (::Array<::Google::Cloud::Functions::V2::EventFilter>) — Criteria used to filter events.
- (::Array<::Google::Cloud::Functions::V2::EventFilter>) — Criteria used to filter events.
#event_type
def event_type() -> ::String
-
(::String) — Required. The type of event to observe. For example:
google.cloud.audit.log.v1.written
orgoogle.cloud.pubsub.topic.v1.messagePublished
.
#event_type=
def event_type=(value) -> ::String
-
value (::String) — Required. The type of event to observe. For example:
google.cloud.audit.log.v1.written
orgoogle.cloud.pubsub.topic.v1.messagePublished
.
-
(::String) — Required. The type of event to observe. For example:
google.cloud.audit.log.v1.written
orgoogle.cloud.pubsub.topic.v1.messagePublished
.
#pubsub_topic
def pubsub_topic() -> ::String
-
(::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.
#pubsub_topic=
def pubsub_topic=(value) -> ::String
-
value (::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.
-
(::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.
#retry_policy
def retry_policy() -> ::Google::Cloud::Functions::V2::EventTrigger::RetryPolicy
- (::Google::Cloud::Functions::V2::EventTrigger::RetryPolicy) — Optional. If unset, then defaults to ignoring failures (i.e. not retrying them).
#retry_policy=
def retry_policy=(value) -> ::Google::Cloud::Functions::V2::EventTrigger::RetryPolicy
- value (::Google::Cloud::Functions::V2::EventTrigger::RetryPolicy) — Optional. If unset, then defaults to ignoring failures (i.e. not retrying them).
- (::Google::Cloud::Functions::V2::EventTrigger::RetryPolicy) — Optional. If unset, then defaults to ignoring failures (i.e. not retrying them).
#service_account_email
def service_account_email() -> ::String
-
(::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
.
#service_account_email=
def service_account_email=(value) -> ::String
-
value (::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
.
-
(::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
.
#trigger
def trigger() -> ::String
-
(::String) — Output only. The resource name of the Eventarc trigger. The format of this field is
projects/{project}/locations/{region}/triggers/{trigger}
.
#trigger_region
def trigger_region() -> ::String
- (::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.
#trigger_region=
def trigger_region=(value) -> ::String
- value (::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.
- (::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.