Eventarc V1 API - Class Google::Cloud::Eventarc::V1::Trigger (v1.2.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

#destination

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

#destination=

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

#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_data_content_type

def event_data_content_type() -> ::String
Returns
  • (::String) — Optional. EventDataContentType specifies the type of payload in MIME format that is expected from the CloudEvent data field. This is set to application/json if the value is not defined.

#event_data_content_type=

def event_data_content_type=(value) -> ::String
Parameter
  • value (::String) — Optional. EventDataContentType specifies the type of payload in MIME format that is expected from the CloudEvent data field. This is set to application/json if the value is not defined.
Returns
  • (::String) — Optional. EventDataContentType specifies the type of payload in MIME format that is expected from the CloudEvent data field. This is set to application/json if the value is not defined.

#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.

#satisfies_pzs

def satisfies_pzs() -> ::Boolean
Returns
  • (::Boolean) — Output only. Whether or not this Trigger satisfies the requirements of physical zone separation

#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 iam.serviceAccounts.actAs permission must be granted on the service account to allow a principal to impersonate the service account. For more information, see the Roles and permissions page specific to the trigger destination.

#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 iam.serviceAccounts.actAs permission must be granted on the service account to allow a principal to impersonate the service account. For more information, see the Roles and permissions page specific to the trigger destination.

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

    The iam.serviceAccounts.actAs permission must be granted on the service account to allow a principal to impersonate the service account. For more information, see the Roles and permissions page specific to the trigger destination.

#transport

def transport() -> ::Google::Cloud::Eventarc::V1::Transport
Returns
  • (::Google::Cloud::Eventarc::V1::Transport) — Optional. To deliver messages, Eventarc might use other Google Cloud 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 Google Cloud 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 Google Cloud 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