com.google.cloud.functions.v2beta

Interface EventTriggerOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

EventTrigger, EventTrigger.Builder

public interface EventTriggerOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
String	getChannel() Optional.
com.google.protobuf.ByteString	getChannelBytes() Optional.
EventFilter	getEventFilters(int index) Criteria used to filter events.
int	getEventFiltersCount() Criteria used to filter events.
List<EventFilter>	getEventFiltersList() Criteria used to filter events.
EventFilterOrBuilder	getEventFiltersOrBuilder(int index) Criteria used to filter events.
List<? extends EventFilterOrBuilder>	getEventFiltersOrBuilderList() Criteria used to filter events.
String	getEventType() Required.
com.google.protobuf.ByteString	getEventTypeBytes() Required.
String	getPubsubTopic() Optional.
com.google.protobuf.ByteString	getPubsubTopicBytes() Optional.
EventTrigger.RetryPolicy	getRetryPolicy() Optional.
int	getRetryPolicyValue() Optional.
String	getService() Optional.
String	getServiceAccountEmail() Optional.
com.google.protobuf.ByteString	getServiceAccountEmailBytes() Optional.
com.google.protobuf.ByteString	getServiceBytes() Optional.
String	getTrigger() Output only.
com.google.protobuf.ByteString	getTriggerBytes() Output only.
String	getTriggerRegion() The region that the trigger will be in.
com.google.protobuf.ByteString	getTriggerRegionBytes() The region that the trigger will be in.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getTrigger

String getTrigger()

 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:

The trigger.

getTriggerBytes

com.google.protobuf.ByteString getTriggerBytes()

 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:

The bytes for trigger.

getTriggerRegion

String getTriggerRegion()

 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:

The triggerRegion.

getTriggerRegionBytes

com.google.protobuf.ByteString getTriggerRegionBytes()

 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:

The bytes for triggerRegion.

getEventType

String getEventType()

 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:

The eventType.

getEventTypeBytes

com.google.protobuf.ByteString getEventTypeBytes()

 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:

The bytes for eventType.

getEventFiltersList

List<EventFilter> getEventFiltersList()

 Criteria used to filter events.
 

repeated .google.cloud.functions.v2beta.EventFilter event_filters = 4;

getEventFilters

EventFilter getEventFilters(int index)

 Criteria used to filter events.
 

repeated .google.cloud.functions.v2beta.EventFilter event_filters = 4;

getEventFiltersCount

int getEventFiltersCount()

 Criteria used to filter events.
 

repeated .google.cloud.functions.v2beta.EventFilter event_filters = 4;

getEventFiltersOrBuilderList

List<? extends EventFilterOrBuilder> getEventFiltersOrBuilderList()

 Criteria used to filter events.
 

repeated .google.cloud.functions.v2beta.EventFilter event_filters = 4;

getEventFiltersOrBuilder

EventFilterOrBuilder getEventFiltersOrBuilder(int index)

 Criteria used to filter events.
 

repeated .google.cloud.functions.v2beta.EventFilter event_filters = 4;

getPubsubTopic

String getPubsubTopic()

 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:

The pubsubTopic.

getPubsubTopicBytes

com.google.protobuf.ByteString getPubsubTopicBytes()

 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:

The bytes for pubsubTopic.

getServiceAccountEmail

String getServiceAccountEmail()

 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:

The serviceAccountEmail.

getServiceAccountEmailBytes

com.google.protobuf.ByteString getServiceAccountEmailBytes()

 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:

The bytes for serviceAccountEmail.

getRetryPolicyValue

int getRetryPolicyValue()

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

.google.cloud.functions.v2beta.EventTrigger.RetryPolicy retry_policy = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns:

The enum numeric value on the wire for retryPolicy.

getRetryPolicy

EventTrigger.RetryPolicy getRetryPolicy()

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

.google.cloud.functions.v2beta.EventTrigger.RetryPolicy retry_policy = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns:

The retryPolicy.

getChannel

String getChannel()

 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:

The channel.

getChannelBytes

com.google.protobuf.ByteString getChannelBytes()

 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:

The bytes for channel.

getService

String getService()

 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.
 

string service = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns:

The service.

getServiceBytes

com.google.protobuf.ByteString getServiceBytes()

 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.
 

string service = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns:

The bytes for service.