Reference documentation and code samples for the Google Cloud Functions V2 Client class EventTrigger.
Describes EventTrigger, used to request events to be sent from another service.
Generated from protobuf message google.cloud.functions.v2.EventTrigger
Namespace
Google \ Cloud \ Functions \ V2Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ trigger
string
Output only. The resource name of the Eventarc trigger. The format of this field is projects/{project}/locations/{region}/triggers/{trigger}
.
↳ 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.
↳ 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
.
↳ event_filters
↳ 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.
↳ 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
.
↳ retry_policy
int
Optional. If unset, then defaults to ignoring failures (i.e. not retrying them).
↳ 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.
↳ service
string
Optional. The hostname of the service that 1st Gen function 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. The field is only applicable to 1st Gen functions.
getTrigger
Output only. The resource name of the Eventarc trigger. The format of this
field is projects/{project}/locations/{region}/triggers/{trigger}
.
string
setTrigger
Output only. The resource name of the Eventarc trigger. The format of this
field is projects/{project}/locations/{region}/triggers/{trigger}
.
var
string
$this
getTriggerRegion
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
setTriggerRegion
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.
var
string
$this
getEventType
Required. The type of event to observe. For example: google.cloud.audit.log.v1.written
or google.cloud.pubsub.topic.v1.messagePublished
.
string
setEventType
Required. The type of event to observe. For example: google.cloud.audit.log.v1.written
or google.cloud.pubsub.topic.v1.messagePublished
.
var
string
$this
getEventFilters
Criteria used to filter events.
setEventFilters
Criteria used to filter events.
$this
getPubsubTopic
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
setPubsubTopic
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.
var
string
$this
getServiceAccountEmail
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
setServiceAccountEmail
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
.
var
string
$this
getRetryPolicy
Optional. If unset, then defaults to ignoring failures (i.e. not retrying them).
int
setRetryPolicy
Optional. If unset, then defaults to ignoring failures (i.e. not retrying them).
var
int
$this
getChannel
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
setChannel
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.
var
string
$this
getService
Optional. The hostname of the service that 1st Gen function 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.
The field is only applicable to 1st Gen functions.
string
setService
Optional. The hostname of the service that 1st Gen function 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.
The field is only applicable to 1st Gen functions.
var
string
$this
