Class EventTrigger (2.51.0)

public final class EventTrigger extends GeneratedMessageV3 implements EventTriggerOrBuilder

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

Protobuf type google.cloud.functions.v2beta.EventTrigger

Static Fields

CHANNEL_FIELD_NUMBER

public static final int CHANNEL_FIELD_NUMBER
Field Value
Type Description
int

EVENT_FILTERS_FIELD_NUMBER

public static final int EVENT_FILTERS_FIELD_NUMBER
Field Value
Type Description
int

EVENT_TYPE_FIELD_NUMBER

public static final int EVENT_TYPE_FIELD_NUMBER
Field Value
Type Description
int

PUBSUB_TOPIC_FIELD_NUMBER

public static final int PUBSUB_TOPIC_FIELD_NUMBER
Field Value
Type Description
int

RETRY_POLICY_FIELD_NUMBER

public static final int RETRY_POLICY_FIELD_NUMBER
Field Value
Type Description
int

SERVICE_ACCOUNT_EMAIL_FIELD_NUMBER

public static final int SERVICE_ACCOUNT_EMAIL_FIELD_NUMBER
Field Value
Type Description
int

SERVICE_FIELD_NUMBER

public static final int SERVICE_FIELD_NUMBER
Field Value
Type Description
int

TRIGGER_FIELD_NUMBER

public static final int TRIGGER_FIELD_NUMBER
Field Value
Type Description
int

TRIGGER_REGION_FIELD_NUMBER

public static final int TRIGGER_REGION_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static EventTrigger getDefaultInstance()
Returns
Type Description
EventTrigger

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static EventTrigger.Builder newBuilder()
Returns
Type Description
EventTrigger.Builder

newBuilder(EventTrigger prototype)

public static EventTrigger.Builder newBuilder(EventTrigger prototype)
Parameter
Name Description
prototype EventTrigger
Returns
Type Description
EventTrigger.Builder

parseDelimitedFrom(InputStream input)

public static EventTrigger parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
EventTrigger
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static EventTrigger parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
EventTrigger
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static EventTrigger parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
EventTrigger
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static EventTrigger parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
EventTrigger
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static EventTrigger parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
EventTrigger
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static EventTrigger parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
EventTrigger
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static EventTrigger parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
EventTrigger
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static EventTrigger parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
EventTrigger
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static EventTrigger parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
EventTrigger
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static EventTrigger parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
EventTrigger
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static EventTrigger parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
EventTrigger
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static EventTrigger parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
EventTrigger
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<EventTrigger> parser()
Returns
Type Description
Parser<EventTrigger>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getChannel()

public 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
Type Description
String

The channel.

getChannelBytes()

public 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
Type Description
ByteString

The bytes for channel.

getDefaultInstanceForType()

public EventTrigger getDefaultInstanceForType()
Returns
Type Description
EventTrigger

getEventFilters(int index)

public EventFilter getEventFilters(int index)

Criteria used to filter events.

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

Parameter
Name Description
index int
Returns
Type Description
EventFilter

getEventFiltersCount()

public int getEventFiltersCount()

Criteria used to filter events.

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

Returns
Type Description
int

getEventFiltersList()

public List<EventFilter> getEventFiltersList()

Criteria used to filter events.

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

Returns
Type Description
List<EventFilter>

getEventFiltersOrBuilder(int index)

public EventFilterOrBuilder getEventFiltersOrBuilder(int index)

Criteria used to filter events.

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

Parameter
Name Description
index int
Returns
Type Description
EventFilterOrBuilder

getEventFiltersOrBuilderList()

public List<? extends EventFilterOrBuilder> getEventFiltersOrBuilderList()

Criteria used to filter events.

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

Returns
Type Description
List<? extends com.google.cloud.functions.v2beta.EventFilterOrBuilder>

getEventType()

public 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
Type Description
String

The eventType.

getEventTypeBytes()

public 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
Type Description
ByteString

The bytes for eventType.

getParserForType()

public Parser<EventTrigger> getParserForType()
Returns
Type Description
Parser<EventTrigger>
Overrides

getPubsubTopic()

public 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
Type Description
String

The pubsubTopic.

getPubsubTopicBytes()

public 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
Type Description
ByteString

The bytes for pubsubTopic.

getRetryPolicy()

public 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
Type Description
EventTrigger.RetryPolicy

The retryPolicy.

getRetryPolicyValue()

public 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
Type Description
int

The enum numeric value on the wire for retryPolicy.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getService()

public 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
Type Description
String

The service.

getServiceAccountEmail()

public 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
Type Description
String

The serviceAccountEmail.

getServiceAccountEmailBytes()

public 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
Type Description
ByteString

The bytes for serviceAccountEmail.

getServiceBytes()

public 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
Type Description
ByteString

The bytes for service.

getTrigger()

public 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
Type Description
String

The trigger.

getTriggerBytes()

public 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
Type Description
ByteString

The bytes for trigger.

getTriggerRegion()

public 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
Type Description
String

The triggerRegion.

getTriggerRegionBytes()

public 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
Type Description
ByteString

The bytes for triggerRegion.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public EventTrigger.Builder newBuilderForType()
Returns
Type Description
EventTrigger.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected EventTrigger.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
EventTrigger.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public EventTrigger.Builder toBuilder()
Returns
Type Description
EventTrigger.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException