Interface EventTriggerOrBuilder (2.21.0)
Stay organized with collections
Save and categorize content based on your preferences.
- 2.80.0 (latest)
- 2.78.0
- 2.77.0
- 2.76.0
- 2.75.0
- 2.74.0
- 2.72.0
- 2.70.0
- 2.69.0
- 2.66.0
- 2.65.0
- 2.64.0
- 2.62.0
- 2.61.0
- 2.60.0
- 2.59.0
- 2.58.0
- 2.57.0
- 2.56.0
- 2.55.0
- 2.54.0
- 2.53.0
- 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
publicinterface EventTriggerOrBuilderextendsMessageOrBuilderImplements
MessageOrBuilderMethods
getChannel()
publicabstractStringgetChannel() 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.
string channel = 8 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
String |
The channel. |
getChannelBytes()
publicabstractByteStringgetChannelBytes() 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.
string channel = 8 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for channel. |
getEventFilters(int index)
publicabstractEventFiltergetEventFilters(intindex)Criteria used to filter events.
repeated .google.cloud.functions.v2.EventFilter event_filters = 4;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
EventFilter |
|
getEventFiltersCount()
publicabstractintgetEventFiltersCount()Criteria used to filter events.
repeated .google.cloud.functions.v2.EventFilter event_filters = 4;
| Returns | |
|---|---|
| Type | Description |
int |
|
getEventFiltersList()
publicabstractList<EventFilter>getEventFiltersList()Criteria used to filter events.
repeated .google.cloud.functions.v2.EventFilter event_filters = 4;
| Returns | |
|---|---|
| Type | Description |
List<EventFilter> |
|
getEventFiltersOrBuilder(int index)
publicabstractEventFilterOrBuildergetEventFiltersOrBuilder(intindex)Criteria used to filter events.
repeated .google.cloud.functions.v2.EventFilter event_filters = 4;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
EventFilterOrBuilder |
|
getEventFiltersOrBuilderList()
publicabstractList<?extendsEventFilterOrBuilder>getEventFiltersOrBuilderList()Criteria used to filter events.
repeated .google.cloud.functions.v2.EventFilter event_filters = 4;
| Returns | |
|---|---|
| Type | Description |
List<? extends com.google.cloud.functions.v2.EventFilterOrBuilder> |
|
getEventType()
publicabstractStringgetEventType() Required. The type of event to observe. For example:
google.cloud.audit.log.v1.written or
google.cloud.pubsub.topic.v1.messagePublished.
string event_type = 3 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
String |
The eventType. |
getEventTypeBytes()
publicabstractByteStringgetEventTypeBytes() Required. The type of event to observe. For example:
google.cloud.audit.log.v1.written or
google.cloud.pubsub.topic.v1.messagePublished.
string event_type = 3 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for eventType. |
getPubsubTopic()
publicabstractStringgetPubsubTopic() 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.
string pubsub_topic = 5 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
String |
The pubsubTopic. |
getPubsubTopicBytes()
publicabstractByteStringgetPubsubTopicBytes() 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.
string pubsub_topic = 5 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for pubsubTopic. |
getRetryPolicy()
publicabstractEventTrigger.RetryPolicygetRetryPolicy()Optional. If unset, then defaults to ignoring failures (i.e. not retrying them).
.google.cloud.functions.v2.EventTrigger.RetryPolicy retry_policy = 7 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
EventTrigger.RetryPolicy |
The retryPolicy. |
getRetryPolicyValue()
publicabstractintgetRetryPolicyValue()Optional. If unset, then defaults to ignoring failures (i.e. not retrying them).
.google.cloud.functions.v2.EventTrigger.RetryPolicy retry_policy = 7 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
int |
The enum numeric value on the wire for retryPolicy. |
getServiceAccountEmail()
publicabstractStringgetServiceAccountEmail() 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}-compute@developer.gserviceaccount.com.
string service_account_email = 6 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
String |
The serviceAccountEmail. |
getServiceAccountEmailBytes()
publicabstractByteStringgetServiceAccountEmailBytes() 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}-compute@developer.gserviceaccount.com.
string service_account_email = 6 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for serviceAccountEmail. |
getTrigger()
publicabstractStringgetTrigger() Output only. The resource name of the Eventarc trigger. The format of this
field is projects/{project}/locations/{region}/triggers/{trigger}.
string trigger = 1 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
String |
The trigger. |
getTriggerBytes()
publicabstractByteStringgetTriggerBytes() Output only. The resource name of the Eventarc trigger. The format of this
field is projects/{project}/locations/{region}/triggers/{trigger}.
string trigger = 1 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for trigger. |
getTriggerRegion()
publicabstractStringgetTriggerRegion()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.
string trigger_region = 2;
| Returns | |
|---|---|
| Type | Description |
String |
The triggerRegion. |
getTriggerRegionBytes()
publicabstractByteStringgetTriggerRegionBytes()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.
string trigger_region = 2;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for triggerRegion. |