public final class EventTrigger extends GeneratedMessageV3 implements EventTriggerOrBuilder
Describes EventTrigger, used to request events be sent from another
service.
Protobuf type google.cloud.functions.v1.EventTrigger
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
EVENT_TYPE_FIELD_NUMBER
public static final int EVENT_TYPE_FIELD_NUMBER
Field Value |
Type |
Description |
int |
|
FAILURE_POLICY_FIELD_NUMBER
public static final int FAILURE_POLICY_FIELD_NUMBER
Field Value |
Type |
Description |
int |
|
RESOURCE_FIELD_NUMBER
public static final int RESOURCE_FIELD_NUMBER
Field Value |
Type |
Description |
int |
|
SERVICE_FIELD_NUMBER
public static final int SERVICE_FIELD_NUMBER
Field Value |
Type |
Description |
int |
|
Static Methods
getDefaultInstance()
public static EventTrigger getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static EventTrigger.Builder newBuilder()
newBuilder(EventTrigger prototype)
public static EventTrigger.Builder newBuilder(EventTrigger prototype)
public static EventTrigger parseDelimitedFrom(InputStream input)
public static EventTrigger parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static EventTrigger parseFrom(byte[] data)
Parameter |
Name |
Description |
data |
byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static EventTrigger parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static EventTrigger parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static EventTrigger parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static EventTrigger parseFrom(CodedInputStream input)
public static EventTrigger parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static EventTrigger parseFrom(InputStream input)
public static EventTrigger parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static EventTrigger parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static EventTrigger parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<EventTrigger> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter |
Name |
Description |
obj |
Object
|
Overrides
getDefaultInstanceForType()
public EventTrigger getDefaultInstanceForType()
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:
- namespace: For example,
cloud.storage
and
google.firebase.analytics
.
- resource type: The type of resource on which event occurs. For
example, the Google Cloud Storage API includes the type
object
.
- action: The action that generates the event. For example, action for
a Google Cloud Storage Object is 'change'.
These parts are lower case.
string event_type = 1;
Returns |
Type |
Description |
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:
- namespace: For example,
cloud.storage
and
google.firebase.analytics
.
- resource type: The type of resource on which event occurs. For
example, the Google Cloud Storage API includes the type
object
.
- action: The action that generates the event. For example, action for
a Google Cloud Storage Object is 'change'.
These parts are lower case.
string event_type = 1;
Returns |
Type |
Description |
ByteString |
The bytes for eventType.
|
getFailurePolicy()
public FailurePolicy getFailurePolicy()
Specifies policy for failed executions.
.google.cloud.functions.v1.FailurePolicy failure_policy = 5;
getFailurePolicyOrBuilder()
public FailurePolicyOrBuilder getFailurePolicyOrBuilder()
Specifies policy for failed executions.
.google.cloud.functions.v1.FailurePolicy failure_policy = 5;
getParserForType()
public Parser<EventTrigger> getParserForType()
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:
- 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
.
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 will always be returned in the normalized "long"
format.
See each service's documentation for supported formats.
string resource = 2;
Returns |
Type |
Description |
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:
- 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
.
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 will always be 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()
public int getSerializedSize()
Returns |
Type |
Description |
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 |
Type |
Description |
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 |
Type |
Description |
ByteString |
The bytes for service.
|
hasFailurePolicy()
public boolean hasFailurePolicy()
Specifies policy for failed executions.
.google.cloud.functions.v1.FailurePolicy failure_policy = 5;
Returns |
Type |
Description |
boolean |
Whether the failurePolicy field is set.
|
hashCode()
Returns |
Type |
Description |
int |
|
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public EventTrigger.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected EventTrigger.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Returns |
Type |
Description |
Object |
|
Overrides
toBuilder()
public EventTrigger.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides