- 2.53.0 (latest)
- 2.51.0
- 2.50.0
- 2.49.0
- 2.48.0
- 2.47.0
- 2.46.0
- 2.45.0
- 2.44.0
- 2.43.0
- 2.42.0
- 2.41.0
- 2.39.0
- 2.38.0
- 2.37.0
- 2.36.0
- 2.35.0
- 2.34.0
- 2.33.0
- 2.32.0
- 2.31.0
- 2.30.0
- 2.29.0
- 2.26.0
- 2.25.0
- 2.24.0
- 2.23.0
- 2.22.0
- 2.21.0
- 2.20.0
- 2.19.0
- 2.18.0
- 2.17.0
- 2.16.0
- 2.15.0
- 2.14.0
- 2.13.0
- 2.11.0
- 2.10.0
- 2.9.0
- 2.8.0
- 2.7.0
- 2.6.0
- 2.5.4
- 2.4.3
- 2.3.6
public interface EventTriggerOrBuilder extends MessageOrBuilder
Implements
MessageOrBuilderMethods
getEventType()
public abstract String getEventType()
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:
- namespace: For example,
cloud.storage
andgoogle.firebase.analytics
. - resource type: The type of resource on which event occurs. For
example, the Google Cloud Storage API includes the type
object
. - action: The action that generates the event. For example, action for a Google Cloud Storage Object is 'change'. These parts are lower case.
string event_type = 1;
Returns | |
---|---|
Type | Description |
String |
The eventType. |
getEventTypeBytes()
public abstract ByteString getEventTypeBytes()
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:
- namespace: For example,
cloud.storage
andgoogle.firebase.analytics
. - resource type: The type of resource on which event occurs. For
example, the Google Cloud Storage API includes the type
object
. - action: The action that generates the event. For example, action for a Google Cloud Storage Object is 'change'. These parts are lower case.
string event_type = 1;
Returns | |
---|---|
Type | Description |
ByteString |
The bytes for eventType. |
getFailurePolicy()
public abstract FailurePolicy getFailurePolicy()
Specifies policy for failed executions.
.google.cloud.functions.v1.FailurePolicy failure_policy = 5;
Returns | |
---|---|
Type | Description |
FailurePolicy |
The failurePolicy. |
getFailurePolicyOrBuilder()
public abstract FailurePolicyOrBuilder getFailurePolicyOrBuilder()
Specifies policy for failed executions.
.google.cloud.functions.v1.FailurePolicy failure_policy = 5;
Returns | |
---|---|
Type | Description |
FailurePolicyOrBuilder |
getResource()
public abstract String getResource()
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:
- 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
. The resource type must match the pattern expected for an
event_type
. For example, anEventTrigger
that has anevent_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.
string resource = 2;
Returns | |
---|---|
Type | Description |
String |
The resource. |
getResourceBytes()
public abstract ByteString getResourceBytes()
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:
- 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
. The resource type must match the pattern expected for an
event_type
. For example, anEventTrigger
that has anevent_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.
string resource = 2;
Returns | |
---|---|
Type | Description |
ByteString |
The bytes for resource. |
getService()
public abstract String getService()
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.
string service = 3;
Returns | |
---|---|
Type | Description |
String |
The service. |
getServiceBytes()
public abstract ByteString getServiceBytes()
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.
string service = 3;
Returns | |
---|---|
Type | Description |
ByteString |
The bytes for service. |
hasFailurePolicy()
public abstract boolean hasFailurePolicy()
Specifies policy for failed executions.
.google.cloud.functions.v1.FailurePolicy failure_policy = 5;
Returns | |
---|---|
Type | Description |
boolean |
Whether the failurePolicy field is set. |