Class EventTrigger (2.21.0)

publicfinalclass EventTriggerextendsGeneratedMessageV3implementsEventTriggerOrBuilder

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

Protobuf type google.cloud.functions.v1.EventTrigger

Inherited Members

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)

Static Fields

EVENT_TYPE_FIELD_NUMBER

publicstaticfinalintEVENT_TYPE_FIELD_NUMBER
Field Value
Type Description
int

FAILURE_POLICY_FIELD_NUMBER

publicstaticfinalintFAILURE_POLICY_FIELD_NUMBER
Field Value
Type Description
int

RESOURCE_FIELD_NUMBER

publicstaticfinalintRESOURCE_FIELD_NUMBER
Field Value
Type Description
int

SERVICE_FIELD_NUMBER

publicstaticfinalintSERVICE_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

publicstaticEventTriggergetDefaultInstance()
Returns
Type Description
EventTrigger

getDescriptor()

publicstaticfinalDescriptors.DescriptorgetDescriptor()
Returns
Type Description
Descriptor

newBuilder()

publicstaticEventTrigger.BuildernewBuilder()
Returns
Type Description
EventTrigger.Builder

newBuilder(EventTrigger prototype)

publicstaticEventTrigger.BuildernewBuilder(EventTriggerprototype)
Parameter
Name Description
prototype EventTrigger
Returns
Type Description
EventTrigger.Builder

parseDelimitedFrom(InputStream input)

publicstaticEventTriggerparseDelimitedFrom(InputStreaminput)
Parameter
Name Description
input InputStream
Returns
Type Description
EventTrigger
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

publicstaticEventTriggerparseDelimitedFrom(InputStreaminput,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
EventTrigger
Exceptions
Type Description
IOException

parseFrom(byte[] data)

publicstaticEventTriggerparseFrom(byte[]data)
Parameter
Name Description
data byte[]
Returns
Type Description
EventTrigger
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

publicstaticEventTriggerparseFrom(byte[]data,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
EventTrigger
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

publicstaticEventTriggerparseFrom(ByteStringdata)
Parameter
Name Description
data ByteString
Returns
Type Description
EventTrigger
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

publicstaticEventTriggerparseFrom(ByteStringdata,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
EventTrigger
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

publicstaticEventTriggerparseFrom(CodedInputStreaminput)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
EventTrigger
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

publicstaticEventTriggerparseFrom(CodedInputStreaminput,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
EventTrigger
Exceptions
Type Description
IOException

parseFrom(InputStream input)

publicstaticEventTriggerparseFrom(InputStreaminput)
Parameter
Name Description
input InputStream
Returns
Type Description
EventTrigger
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

publicstaticEventTriggerparseFrom(InputStreaminput,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
EventTrigger
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

publicstaticEventTriggerparseFrom(ByteBufferdata)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
EventTrigger
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

publicstaticEventTriggerparseFrom(ByteBufferdata,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
EventTrigger
Exceptions
Type Description
InvalidProtocolBufferException

parser()

publicstaticParser<EventTrigger>parser()
Returns
Type Description
Parser<EventTrigger>

Methods

equals(Object obj)

publicbooleanequals(Objectobj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

publicEventTriggergetDefaultInstanceForType()
Returns
Type Description
EventTrigger

getEventType()

publicStringgetEventType()

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:

  1. namespace: For example, cloud.storage and google.firebase.analytics.
  2. resource type: The type of resource on which event occurs. For example, the Google Cloud Storage API includes the type object.
  3. action: The action that generates the event. For example, action for a Google Cloud Storage Object is 'change'. These parts are lowercase.

string event_type = 1;

Returns
Type Description
String

The eventType.

getEventTypeBytes()

publicByteStringgetEventTypeBytes()

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:

  1. namespace: For example, cloud.storage and google.firebase.analytics.
  2. resource type: The type of resource on which event occurs. For example, the Google Cloud Storage API includes the type object.
  3. action: The action that generates the event. For example, action for a Google Cloud Storage Object is 'change'. These parts are lowercase.

string event_type = 1;

Returns
Type Description
ByteString

The bytes for eventType.

getFailurePolicy()

publicFailurePolicygetFailurePolicy()

Specifies policy for failed executions.

.google.cloud.functions.v1.FailurePolicy failure_policy = 5;

Returns
Type Description
FailurePolicy

The failurePolicy.

getFailurePolicyOrBuilder()

publicFailurePolicyOrBuildergetFailurePolicyOrBuilder()

Specifies policy for failed executions.

.google.cloud.functions.v1.FailurePolicy failure_policy = 5;

Returns
Type Description
FailurePolicyOrBuilder

getParserForType()

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

getResource()

publicStringgetResource()

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:

  1. 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.
  2. The resource type must match the pattern expected for an event_type. For example, an EventTrigger that has an event_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 are always returned in the normalized "long" format.

    See each service's documentation for supported formats.

string resource = 2;

Returns
Type Description
String

The resource.

getResourceBytes()

publicByteStringgetResourceBytes()

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:

  1. 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.
  2. The resource type must match the pattern expected for an event_type. For example, an EventTrigger that has an event_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 are always 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.

getSerializedSize()

publicintgetSerializedSize()
Returns
Type Description
int
Overrides

getService()

publicStringgetService()

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()

publicByteStringgetServiceBytes()

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()

publicbooleanhasFailurePolicy()

Specifies policy for failed executions.

.google.cloud.functions.v1.FailurePolicy failure_policy = 5;

Returns
Type Description
boolean

Whether the failurePolicy field is set.

hashCode()

publicinthashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protectedGeneratedMessageV3.FieldAccessorTableinternalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

publicfinalbooleanisInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

publicEventTrigger.BuildernewBuilderForType()
Returns
Type Description
EventTrigger.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protectedEventTrigger.BuildernewBuilderForType(GeneratedMessageV3.BuilderParentparent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
EventTrigger.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protectedObjectnewInstance(GeneratedMessageV3.UnusedPrivateParameterunused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

publicEventTrigger.BuildertoBuilder()
Returns
Type Description
EventTrigger.Builder

writeTo(CodedOutputStream output)

publicvoidwriteTo(CodedOutputStreamoutput)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException

Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025年10月30日 UTC.