Class EventTrigger (2.62.0)

publicfinalclassEventTriggerextendsGeneratedMessageV3implementsEventTriggerOrBuilder

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

Protobuf type google.cloud.functions.v2.EventTrigger

Static Fields

CHANNEL_FIELD_NUMBER

publicstaticfinalintCHANNEL_FIELD_NUMBER
Field Value
TypeDescription
int

EVENT_FILTERS_FIELD_NUMBER

publicstaticfinalintEVENT_FILTERS_FIELD_NUMBER
Field Value
TypeDescription
int

EVENT_TYPE_FIELD_NUMBER

publicstaticfinalintEVENT_TYPE_FIELD_NUMBER
Field Value
TypeDescription
int

PUBSUB_TOPIC_FIELD_NUMBER

publicstaticfinalintPUBSUB_TOPIC_FIELD_NUMBER
Field Value
TypeDescription
int

RETRY_POLICY_FIELD_NUMBER

publicstaticfinalintRETRY_POLICY_FIELD_NUMBER
Field Value
TypeDescription
int

SERVICE_ACCOUNT_EMAIL_FIELD_NUMBER

publicstaticfinalintSERVICE_ACCOUNT_EMAIL_FIELD_NUMBER
Field Value
TypeDescription
int

SERVICE_FIELD_NUMBER

publicstaticfinalintSERVICE_FIELD_NUMBER
Field Value
TypeDescription
int

TRIGGER_FIELD_NUMBER

publicstaticfinalintTRIGGER_FIELD_NUMBER
Field Value
TypeDescription
int

TRIGGER_REGION_FIELD_NUMBER

publicstaticfinalintTRIGGER_REGION_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

publicstaticEventTriggergetDefaultInstance()
Returns
TypeDescription
EventTrigger

getDescriptor()

publicstaticfinalDescriptors.DescriptorgetDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

publicstaticEventTrigger.BuildernewBuilder()
Returns
TypeDescription
EventTrigger.Builder

newBuilder(EventTrigger prototype)

publicstaticEventTrigger.BuildernewBuilder(EventTriggerprototype)
Parameter
NameDescription
prototypeEventTrigger
Returns
TypeDescription
EventTrigger.Builder

parseDelimitedFrom(InputStream input)

publicstaticEventTriggerparseDelimitedFrom(InputStreaminput)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
EventTrigger
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

publicstaticEventTriggerparseDelimitedFrom(InputStreaminput,ExtensionRegistryLiteextensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
EventTrigger
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

publicstaticEventTriggerparseFrom(byte[]data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
EventTrigger
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

publicstaticEventTriggerparseFrom(byte[]data,ExtensionRegistryLiteextensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
EventTrigger
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

publicstaticEventTriggerparseFrom(ByteStringdata)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
EventTrigger
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

publicstaticEventTriggerparseFrom(ByteStringdata,ExtensionRegistryLiteextensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
EventTrigger
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

publicstaticEventTriggerparseFrom(CodedInputStreaminput)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
EventTrigger
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

publicstaticEventTriggerparseFrom(CodedInputStreaminput,ExtensionRegistryLiteextensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
EventTrigger
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

publicstaticEventTriggerparseFrom(InputStreaminput)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
EventTrigger
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

publicstaticEventTriggerparseFrom(InputStreaminput,ExtensionRegistryLiteextensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
EventTrigger
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

publicstaticEventTriggerparseFrom(ByteBufferdata)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
EventTrigger
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

publicstaticEventTriggerparseFrom(ByteBufferdata,ExtensionRegistryLiteextensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
EventTrigger
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

publicstaticParser<EventTrigger>parser()
Returns
TypeDescription
Parser<EventTrigger>

Methods

equals(Object obj)

publicbooleanequals(Objectobj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getChannel()

publicStringgetChannel()

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
TypeDescription
String

The channel.

getChannelBytes()

publicByteStringgetChannelBytes()

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
TypeDescription
ByteString

The bytes for channel.

getDefaultInstanceForType()

publicEventTriggergetDefaultInstanceForType()
Returns
TypeDescription
EventTrigger

getEventFilters(int index)

publicEventFiltergetEventFilters(intindex)

Criteria used to filter events.

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

Parameter
NameDescription
indexint
Returns
TypeDescription
EventFilter

getEventFiltersCount()

publicintgetEventFiltersCount()

Criteria used to filter events.

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

Returns
TypeDescription
int

getEventFiltersList()

publicList<EventFilter>getEventFiltersList()

Criteria used to filter events.

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

Returns
TypeDescription
List<EventFilter>

getEventFiltersOrBuilder(int index)

publicEventFilterOrBuildergetEventFiltersOrBuilder(intindex)

Criteria used to filter events.

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

Parameter
NameDescription
indexint
Returns
TypeDescription
EventFilterOrBuilder

getEventFiltersOrBuilderList()

publicList<?extendsEventFilterOrBuilder>getEventFiltersOrBuilderList()

Criteria used to filter events.

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

Returns
TypeDescription
List<? extends com.google.cloud.functions.v2.EventFilterOrBuilder>

getEventType()

publicStringgetEventType()

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
TypeDescription
String

The eventType.

getEventTypeBytes()

publicByteStringgetEventTypeBytes()

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
TypeDescription
ByteString

The bytes for eventType.

getParserForType()

publicParser<EventTrigger>getParserForType()
Returns
TypeDescription
Parser<EventTrigger>
Overrides

getPubsubTopic()

publicStringgetPubsubTopic()

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
TypeDescription
String

The pubsubTopic.

getPubsubTopicBytes()

publicByteStringgetPubsubTopicBytes()

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
TypeDescription
ByteString

The bytes for pubsubTopic.

getRetryPolicy()

publicEventTrigger.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
TypeDescription
EventTrigger.RetryPolicy

The retryPolicy.

getRetryPolicyValue()

publicintgetRetryPolicyValue()

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
TypeDescription
int

The enum numeric value on the wire for retryPolicy.

getSerializedSize()

publicintgetSerializedSize()
Returns
TypeDescription
int
Overrides

getService()

publicStringgetService()

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
TypeDescription
String

The service.

getServiceAccountEmail()

publicStringgetServiceAccountEmail()

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
TypeDescription
String

The serviceAccountEmail.

getServiceAccountEmailBytes()

publicByteStringgetServiceAccountEmailBytes()

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
TypeDescription
ByteString

The bytes for serviceAccountEmail.

getServiceBytes()

publicByteStringgetServiceBytes()

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
TypeDescription
ByteString

The bytes for service.

getTrigger()

publicStringgetTrigger()

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
TypeDescription
String

The trigger.

getTriggerBytes()

publicByteStringgetTriggerBytes()

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
TypeDescription
ByteString

The bytes for trigger.

getTriggerRegion()

publicStringgetTriggerRegion()

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
TypeDescription
String

The triggerRegion.

getTriggerRegionBytes()

publicByteStringgetTriggerRegionBytes()

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
TypeDescription
ByteString

The bytes for triggerRegion.

hashCode()

publicinthashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protectedGeneratedMessageV3.FieldAccessorTableinternalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

publicfinalbooleanisInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

publicEventTrigger.BuildernewBuilderForType()
Returns
TypeDescription
EventTrigger.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protectedEventTrigger.BuildernewBuilderForType(GeneratedMessageV3.BuilderParentparent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
EventTrigger.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protectedObjectnewInstance(GeneratedMessageV3.UnusedPrivateParameterunused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

publicEventTrigger.BuildertoBuilder()
Returns
TypeDescription
EventTrigger.Builder

writeTo(CodedOutputStream output)

publicvoidwriteTo(CodedOutputStreamoutput)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException