Class EventTrigger (2.34.0)

public final class EventTrigger extends GeneratedMessageV3 implements EventTriggerOrBuilder

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

Protobuf type google.cloud.functions.v1.EventTrigger

Static Fields

EVENT_TYPE_FIELD_NUMBER

public static final int EVENT_TYPE_FIELD_NUMBER
Field Value
TypeDescription
int

FAILURE_POLICY_FIELD_NUMBER

public static final int FAILURE_POLICY_FIELD_NUMBER
Field Value
TypeDescription
int

RESOURCE_FIELD_NUMBER

public static final int RESOURCE_FIELD_NUMBER
Field Value
TypeDescription
int

SERVICE_FIELD_NUMBER

public static final int SERVICE_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static EventTrigger getDefaultInstance()
Returns
TypeDescription
EventTrigger

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static EventTrigger.Builder newBuilder()
Returns
TypeDescription
EventTrigger.Builder

newBuilder(EventTrigger prototype)

public static EventTrigger.Builder newBuilder(EventTrigger prototype)
Parameter
NameDescription
prototypeEventTrigger
Returns
TypeDescription
EventTrigger.Builder

parseDelimitedFrom(InputStream input)

public static EventTrigger parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
EventTrigger
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static EventTrigger parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
EventTrigger
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static EventTrigger parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
EventTrigger
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static EventTrigger parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
EventTrigger
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static EventTrigger parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
EventTrigger
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static EventTrigger parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
EventTrigger
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static EventTrigger parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
EventTrigger
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static EventTrigger parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
EventTrigger
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static EventTrigger parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
EventTrigger
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static EventTrigger parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
EventTrigger
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static EventTrigger parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
EventTrigger
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static EventTrigger parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
EventTrigger
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<EventTrigger> parser()
Returns
TypeDescription
Parser<EventTrigger>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstanceForType()

public EventTrigger getDefaultInstanceForType()
Returns
TypeDescription
EventTrigger

getEventType()

public String getEventType()

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

The eventType.

getEventTypeBytes()

public ByteString getEventTypeBytes()

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

The bytes for eventType.

getFailurePolicy()

public FailurePolicy getFailurePolicy()

Specifies policy for failed executions.

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

Returns
TypeDescription
FailurePolicy

The failurePolicy.

getFailurePolicyOrBuilder()

public FailurePolicyOrBuilder getFailurePolicyOrBuilder()

Specifies policy for failed executions.

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

Returns
TypeDescription
FailurePolicyOrBuilder

getParserForType()

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

getResource()

public String getResource()

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

The resource.

getResourceBytes()

public ByteString getResourceBytes()

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

The bytes for resource.

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getService()

public String getService()

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

The service.

getServiceBytes()

public ByteString getServiceBytes()

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

The bytes for service.

hasFailurePolicy()

public boolean hasFailurePolicy()

Specifies policy for failed executions.

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

Returns
TypeDescription
boolean

Whether the failurePolicy field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public EventTrigger.Builder newBuilderForType()
Returns
TypeDescription
EventTrigger.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected EventTrigger.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
EventTrigger.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public EventTrigger.Builder toBuilder()
Returns
TypeDescription
EventTrigger.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException