Cloud Functions V1 API - Class Google::Cloud::Functions::V1::EventTrigger (v1.2.0)

Reference documentation and code samples for the Cloud Functions V1 API class Google::Cloud::Functions::V1::EventTrigger.

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

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#event_type

def event_type() -> ::String
Returns
  • (::String) —

    Required. The type of event to observe. For example: providers/cloud.storage/eventTypes/object.change and providers/cloud.pubsub/eventTypes/topic.publish.

    Event types match pattern providers/*/eventTypes/*.*. The pattern contains:

    1. namespace: For example, cloud.storage and google.firebase.analytics.
    2. resource type: The type of resource on which event occurs. For example, the Google Cloud Storage API includes the type object.
    3. action: The action that generates the event. For example, action for a Google Cloud Storage Object is 'change'. These parts are lower case.

#event_type=

def event_type=(value) -> ::String
Parameter
  • value (::String) —

    Required. The type of event to observe. For example: providers/cloud.storage/eventTypes/object.change and providers/cloud.pubsub/eventTypes/topic.publish.

    Event types match pattern providers/*/eventTypes/*.*. The pattern contains:

    1. namespace: For example, cloud.storage and google.firebase.analytics.
    2. resource type: The type of resource on which event occurs. For example, the Google Cloud Storage API includes the type object.
    3. action: The action that generates the event. For example, action for a Google Cloud Storage Object is 'change'. These parts are lower case.
Returns
  • (::String) —

    Required. The type of event to observe. For example: providers/cloud.storage/eventTypes/object.change and providers/cloud.pubsub/eventTypes/topic.publish.

    Event types match pattern providers/*/eventTypes/*.*. The pattern contains:

    1. namespace: For example, cloud.storage and google.firebase.analytics.
    2. resource type: The type of resource on which event occurs. For example, the Google Cloud Storage API includes the type object.
    3. action: The action that generates the event. For example, action for a Google Cloud Storage Object is 'change'. These parts are lower case.

#failure_policy

def failure_policy() -> ::Google::Cloud::Functions::V1::FailurePolicy
Returns

#failure_policy=

def failure_policy=(value) -> ::Google::Cloud::Functions::V1::FailurePolicy
Parameter
Returns

#resource

def resource() -> ::String
Returns
  • (::String) — Required. The resource(s) from which to observe events, for example, projects/_/buckets/myBucket.

    Not all syntactically correct values are accepted by all services. For example:

    1. The authorization model must support it. Google Cloud Functions only allows EventTriggers to be deployed that observe resources in the same project as the CloudFunction.
    2. The resource type must match the pattern expected for an event_type. For example, an EventTrigger that has an event_type of "google.pubsub.topic.publish" should have a resource that matches Google Cloud Pub/Sub topics.

    Additionally, some services may support short names when creating an EventTrigger. These will always be returned in the normalized "long" format.

    See each service's documentation for supported formats.

#resource=

def resource=(value) -> ::String
Parameter
  • value (::String) — Required. The resource(s) from which to observe events, for example, projects/_/buckets/myBucket.

    Not all syntactically correct values are accepted by all services. For example:

    1. The authorization model must support it. Google Cloud Functions only allows EventTriggers to be deployed that observe resources in the same project as the CloudFunction.
    2. The resource type must match the pattern expected for an event_type. For example, an EventTrigger that has an event_type of "google.pubsub.topic.publish" should have a resource that matches Google Cloud Pub/Sub topics.

    Additionally, some services may support short names when creating an EventTrigger. These will always be returned in the normalized "long" format.

    See each service's documentation for supported formats.

Returns
  • (::String) — Required. The resource(s) from which to observe events, for example, projects/_/buckets/myBucket.

    Not all syntactically correct values are accepted by all services. For example:

    1. The authorization model must support it. Google Cloud Functions only allows EventTriggers to be deployed that observe resources in the same project as the CloudFunction.
    2. The resource type must match the pattern expected for an event_type. For example, an EventTrigger that has an event_type of "google.pubsub.topic.publish" should have a resource that matches Google Cloud Pub/Sub topics.

    Additionally, some services may support short names when creating an EventTrigger. These will always be returned in the normalized "long" format.

    See each service's documentation for supported formats.

#service

def service() -> ::String
Returns
  • (::String) — The hostname of the service that 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.

#service=

def service=(value) -> ::String
Parameter
  • value (::String) — The hostname of the service that 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.

Returns
  • (::String) — The hostname of the service that 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.