Class: Google::Cloud::Functions::V2::EventTrigger

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/functions/v2/functions.rb

Overview

Describes EventTrigger, used to request events to be sent from another service.

Defined Under Namespace

Modules: RetryPolicy

Instance Attribute Summary collapse

Instance Attribute Details

#channel ⇒ ::String

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



666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
 
# File 'proto_docs/google/cloud/functions/v2/functions.rb', line 666

class EventTrigger
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Describes the retry policy in case of function's execution failure.
  # Retried execution is charged as any other execution.
  module RetryPolicy
    # Not specified.
    RETRY_POLICY_UNSPECIFIED = 0

    # Do not retry.
    RETRY_POLICY_DO_NOT_RETRY = 1

    # Retry on any failure, retry up to 7 days with an exponential backoff
    # (capped at 10 seconds).
    RETRY_POLICY_RETRY = 2
  end
end

#event_filters ⇒ ::Array<::Google::Cloud::Functions::V2::EventFilter>

Returns Criteria used to filter events.

Returns:



666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
 
# File 'proto_docs/google/cloud/functions/v2/functions.rb', line 666

class EventTrigger
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Describes the retry policy in case of function's execution failure.
  # Retried execution is charged as any other execution.
  module RetryPolicy
    # Not specified.
    RETRY_POLICY_UNSPECIFIED = 0

    # Do not retry.
    RETRY_POLICY_DO_NOT_RETRY = 1

    # Retry on any failure, retry up to 7 days with an exponential backoff
    # (capped at 10 seconds).
    RETRY_POLICY_RETRY = 2
  end
end

#event_type ⇒ ::String

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



666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
 
# File 'proto_docs/google/cloud/functions/v2/functions.rb', line 666

class EventTrigger
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Describes the retry policy in case of function's execution failure.
  # Retried execution is charged as any other execution.
  module RetryPolicy
    # Not specified.
    RETRY_POLICY_UNSPECIFIED = 0

    # Do not retry.
    RETRY_POLICY_DO_NOT_RETRY = 1

    # Retry on any failure, retry up to 7 days with an exponential backoff
    # (capped at 10 seconds).
    RETRY_POLICY_RETRY = 2
  end
end

#pubsub_topic ⇒ ::String

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



666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
 
# File 'proto_docs/google/cloud/functions/v2/functions.rb', line 666

class EventTrigger
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Describes the retry policy in case of function's execution failure.
  # Retried execution is charged as any other execution.
  module RetryPolicy
    # Not specified.
    RETRY_POLICY_UNSPECIFIED = 0

    # Do not retry.
    RETRY_POLICY_DO_NOT_RETRY = 1

    # Retry on any failure, retry up to 7 days with an exponential backoff
    # (capped at 10 seconds).
    RETRY_POLICY_RETRY = 2
  end
end

#retry_policy ⇒ ::Google::Cloud::Functions::V2::EventTrigger::RetryPolicy

Returns Optional. If unset, then defaults to ignoring failures (i.e. not retrying them).

Returns:



666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
 
# File 'proto_docs/google/cloud/functions/v2/functions.rb', line 666

class EventTrigger
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Describes the retry policy in case of function's execution failure.
  # Retried execution is charged as any other execution.
  module RetryPolicy
    # Not specified.
    RETRY_POLICY_UNSPECIFIED = 0

    # Do not retry.
    RETRY_POLICY_DO_NOT_RETRY = 1

    # Retry on any failure, retry up to 7 days with an exponential backoff
    # (capped at 10 seconds).
    RETRY_POLICY_RETRY = 2
  end
end

#service ⇒ ::String

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



666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
 
# File 'proto_docs/google/cloud/functions/v2/functions.rb', line 666

class EventTrigger
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Describes the retry policy in case of function's execution failure.
  # Retried execution is charged as any other execution.
  module RetryPolicy
    # Not specified.
    RETRY_POLICY_UNSPECIFIED = 0

    # Do not retry.
    RETRY_POLICY_DO_NOT_RETRY = 1

    # Retry on any failure, retry up to 7 days with an exponential backoff
    # (capped at 10 seconds).
    RETRY_POLICY_RETRY = 2
  end
end

#service_account_email ⇒ ::String

Returns 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}[email protected].

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}[email protected].



666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
 
# File 'proto_docs/google/cloud/functions/v2/functions.rb', line 666

class EventTrigger
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Describes the retry policy in case of function's execution failure.
  # Retried execution is charged as any other execution.
  module RetryPolicy
    # Not specified.
    RETRY_POLICY_UNSPECIFIED = 0

    # Do not retry.
    RETRY_POLICY_DO_NOT_RETRY = 1

    # Retry on any failure, retry up to 7 days with an exponential backoff
    # (capped at 10 seconds).
    RETRY_POLICY_RETRY = 2
  end
end

#trigger ⇒ ::String (readonly)

Returns Output only. The resource name of the Eventarc trigger. The format of this field is projects/{project}/locations/{region}/triggers/{trigger}.

Returns:

  • (::String) —

    Output only. The resource name of the Eventarc trigger. The format of this field is projects/{project}/locations/{region}/triggers/{trigger}.



666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
 
# File 'proto_docs/google/cloud/functions/v2/functions.rb', line 666

class EventTrigger
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Describes the retry policy in case of function's execution failure.
  # Retried execution is charged as any other execution.
  module RetryPolicy
    # Not specified.
    RETRY_POLICY_UNSPECIFIED = 0

    # Do not retry.
    RETRY_POLICY_DO_NOT_RETRY = 1

    # Retry on any failure, retry up to 7 days with an exponential backoff
    # (capped at 10 seconds).
    RETRY_POLICY_RETRY = 2
  end
end

#trigger_region ⇒ ::String

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



666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
 
# File 'proto_docs/google/cloud/functions/v2/functions.rb', line 666

class EventTrigger
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Describes the retry policy in case of function's execution failure.
  # Retried execution is charged as any other execution.
  module RetryPolicy
    # Not specified.
    RETRY_POLICY_UNSPECIFIED = 0

    # Do not retry.
    RETRY_POLICY_DO_NOT_RETRY = 1

    # Retry on any failure, retry up to 7 days with an exponential backoff
    # (capped at 10 seconds).
    RETRY_POLICY_RETRY = 2
  end
end