Eventarc V1 API - Class Google::Cloud::Eventarc::V1::Trigger (v1.0.0)

Reference documentation and code samples for the Eventarc V1 API class Google::Cloud::Eventarc::V1::Trigger.

A representation of the trigger resource.

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.

#conditions

def conditions() -> ::Google::Protobuf::Map{::String => ::Google::Cloud::Eventarc::V1::StateCondition}

Returns

(::Google::Protobuf::Map{::String => ::Google::Cloud::Eventarc::V1::StateCondition}) — Output only. The reason(s) why a trigger is in FAILED state.

#create_time

def create_time() -> ::Google::Protobuf::Timestamp

Returns

(::Google::Protobuf::Timestamp) — Output only. The creation time.

#destination

def destination() -> ::Google::Cloud::Eventarc::V1::Destination

Returns

(::Google::Cloud::Eventarc::V1::Destination) — Required. Destination specifies where the events should be sent to.

#destination=

def destination=(value) -> ::Google::Cloud::Eventarc::V1::Destination

Parameter

value (::Google::Cloud::Eventarc::V1::Destination) — Required. Destination specifies where the events should be sent to.

Returns

(::Google::Cloud::Eventarc::V1::Destination) — Required. Destination specifies where the events should be sent to.

#etag

def etag() -> ::String

Returns

(::String) — Output only. This checksum is computed by the server based on the value of other fields, and might be sent only on create requests to ensure that the client has an up-to-date value before proceeding.

#event_filters

def event_filters() -> ::Array<::Google::Cloud::Eventarc::V1::EventFilter>

Returns

(::Array<::Google::Cloud::Eventarc::V1::EventFilter>) — Required. Unordered list. The list of filters that applies to event attributes. Only events that match all the provided filters are sent to the destination.

#event_filters=

def event_filters=(value) -> ::Array<::Google::Cloud::Eventarc::V1::EventFilter>

Parameter

value (::Array<::Google::Cloud::Eventarc::V1::EventFilter>) — Required. Unordered list. The list of filters that applies to event attributes. Only events that match all the provided filters are sent to the destination.

Returns

(::Array<::Google::Cloud::Eventarc::V1::EventFilter>) — Required. Unordered list. The list of filters that applies to event attributes. Only events that match all the provided filters are sent to the destination.

#labels

def labels() -> ::Google::Protobuf::Map{::String => ::String}

Returns

(::Google::Protobuf::Map{::String => ::String}) — Optional. User labels attached to the triggers that can be used to group resources.

#labels=

def labels=(value) -> ::Google::Protobuf::Map{::String => ::String}

Parameter

value (::Google::Protobuf::Map{::String => ::String}) — Optional. User labels attached to the triggers that can be used to group resources.

Returns

(::Google::Protobuf::Map{::String => ::String}) — Optional. User labels attached to the triggers that can be used to group resources.

#name

def name() -> ::String

Returns

(::String) — Required. The resource name of the trigger. Must be unique within the location of the project and must be in projects/{project}/locations/{location}/triggers/{trigger} format.

#name=

def name=(value) -> ::String

Parameter

value (::String) — Required. The resource name of the trigger. Must be unique within the location of the project and must be in projects/{project}/locations/{location}/triggers/{trigger} format.

Returns

(::String) — Required. The resource name of the trigger. Must be unique within the location of the project and must be in projects/{project}/locations/{location}/triggers/{trigger} format.

#service_account

def service_account() -> ::String

Returns

(::String) — Optional. The IAM service account email associated with the trigger. The service account represents the identity of the trigger.

The principal who calls this API must have the iam.serviceAccounts.actAs permission in the service account. See https://cloud.google.com/iam/docs/understanding-service-accounts?hl=en#sa_common for more information.

For Cloud Run destinations, this service account is used to generate identity tokens when invoking the service. See https://cloud.google.com/run/docs/triggering/pubsub-push#create-service-account for information on how to invoke authenticated Cloud Run services. To create Audit Log triggers, the service account should also have the roles/eventarc.eventReceiver IAM role.

#service_account=

def service_account=(value) -> ::String

Parameter

value (::String) — Optional. The IAM service account email associated with the trigger. The service account represents the identity of the trigger.

The principal who calls this API must have the iam.serviceAccounts.actAs permission in the service account. See https://cloud.google.com/iam/docs/understanding-service-accounts?hl=en#sa_common for more information.

For Cloud Run destinations, this service account is used to generate identity tokens when invoking the service. See https://cloud.google.com/run/docs/triggering/pubsub-push#create-service-account for information on how to invoke authenticated Cloud Run services. To create Audit Log triggers, the service account should also have the roles/eventarc.eventReceiver IAM role.

Returns

(::String) — Optional. The IAM service account email associated with the trigger. The service account represents the identity of the trigger.

The principal who calls this API must have the iam.serviceAccounts.actAs permission in the service account. See https://cloud.google.com/iam/docs/understanding-service-accounts?hl=en#sa_common for more information.

For Cloud Run destinations, this service account is used to generate identity tokens when invoking the service. See https://cloud.google.com/run/docs/triggering/pubsub-push#create-service-account for information on how to invoke authenticated Cloud Run services. To create Audit Log triggers, the service account should also have the roles/eventarc.eventReceiver IAM role.

#transport

def transport() -> ::Google::Cloud::Eventarc::V1::Transport

Returns

(::Google::Cloud::Eventarc::V1::Transport) — Optional. To deliver messages, Eventarc might use other GCP products as a transport intermediary. This field contains a reference to that transport intermediary. This information can be used for debugging purposes.

#transport=

def transport=(value) -> ::Google::Cloud::Eventarc::V1::Transport

Parameter

value (::Google::Cloud::Eventarc::V1::Transport) — Optional. To deliver messages, Eventarc might use other GCP products as a transport intermediary. This field contains a reference to that transport intermediary. This information can be used for debugging purposes.

Returns

(::Google::Cloud::Eventarc::V1::Transport) — Optional. To deliver messages, Eventarc might use other GCP products as a transport intermediary. This field contains a reference to that transport intermediary. This information can be used for debugging purposes.

#uid

def uid() -> ::String

Returns

(::String) — Output only. Server-assigned unique identifier for the trigger. The value is a UUID4 string and guaranteed to remain unchanged until the resource is deleted.

#update_time

def update_time() -> ::Google::Protobuf::Timestamp

Returns

(::Google::Protobuf::Timestamp) — Output only. The last-modified time.