# Cloud Functions V2 API - Class Google::Cloud::Functions::V2::EventTrigger (v1.5.1)

1.5.1 (latest) 1.5.0 1.4.0 1.3.1 1.2.0 1.1.0 1.0.2 0.10.0 0.9.0 0.8.1 0.7.0 0.6.2 0.5.0 0.4.1 0.3.0 0.2.0 0.1.0 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

**Returns**

- (::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

**Parameter**

- **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.
**Returns**

- (::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>

**Returns**

- (::Array\<[::Google::Cloud::Functions::V2::EventFilter](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-functions-v2/latest/Google-Cloud-Functions-V2-EventFilter)\>) --- Criteria used to filter events.

### #event_filters=

    def event_filters=(value) -> ::Array<::Google::Cloud::Functions::V2::EventFilter>

**Parameter**

- **value** (::Array\<[::Google::Cloud::Functions::V2::EventFilter](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-functions-v2/latest/Google-Cloud-Functions-V2-EventFilter)\>) --- Criteria used to filter events.
**Returns**

- (::Array\<[::Google::Cloud::Functions::V2::EventFilter](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-functions-v2/latest/Google-Cloud-Functions-V2-EventFilter)\>) --- Criteria used to filter events.

### #event_type

    def event_type() -> ::String

**Returns**

- (::String) --- Required. The type of event to observe. For example: `google.cloud.audit.log.v1.written` or `google.cloud.pubsub.topic.v1.messagePublished`.

### #event_type=

    def event_type=(value) -> ::String

**Parameter**

- **value** (::String) --- Required. The type of event to observe. For example: `google.cloud.audit.log.v1.written` or `google.cloud.pubsub.topic.v1.messagePublished`.
**Returns**

- (::String) --- Required. The type of event to observe. For example: `google.cloud.audit.log.v1.written` or `google.cloud.pubsub.topic.v1.messagePublished`.

### #pubsub_topic

    def pubsub_topic() -> ::String

**Returns**

- (::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

**Parameter**

- **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.
**Returns**

- (::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

**Returns**

- ([::Google::Cloud::Functions::V2::EventTrigger::RetryPolicy](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-functions-v2/latest/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

**Parameter**

- **value** ([::Google::Cloud::Functions::V2::EventTrigger::RetryPolicy](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-functions-v2/latest/Google-Cloud-Functions-V2-EventTrigger-RetryPolicy)) --- Optional. If unset, then defaults to ignoring failures (i.e. not retrying them).
**Returns**

- ([::Google::Cloud::Functions::V2::EventTrigger::RetryPolicy](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-functions-v2/latest/Google-Cloud-Functions-V2-EventTrigger-RetryPolicy)) --- Optional. If unset, then defaults to ignoring failures (i.e. not retrying them).

### #service

    def service() -> ::String

**Returns**

- (::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.

### #service=

    def service=(value) -> ::String

**Parameter**

- **value** (::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.
**Returns**

- (::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.

### #service_account_email

    def service_account_email() -> ::String

**Returns**

- (::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

**Parameter**

- **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`.
**Returns**

- (::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

**Returns**

- (::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

**Returns**

- (::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

**Parameter**

- **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.
**Returns**

- (::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.