com.google.cloud.functions.v1

Interface EventTriggerOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

EventTrigger, EventTrigger.Builder

public interface EventTriggerOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
String	getEventType() Required.
com.google.protobuf.ByteString	getEventTypeBytes() Required.
FailurePolicy	getFailurePolicy() Specifies policy for failed executions.
FailurePolicyOrBuilder	getFailurePolicyOrBuilder() Specifies policy for failed executions.
String	getResource() Required.
com.google.protobuf.ByteString	getResourceBytes() Required.
String	getService() The hostname of the service that should be observed.
com.google.protobuf.ByteString	getServiceBytes() The hostname of the service that should be observed.
boolean	hasFailurePolicy() Specifies policy for failed executions.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getEventType

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 lower case.
 

string event_type = 1;

Returns:

The eventType.

getEventTypeBytes

com.google.protobuf.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 lower case.
 

string event_type = 1;

Returns:

The bytes for eventType.

getResource

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 will always be returned in the normalized "long"
 format.
 See each *service's* documentation for supported formats.
 

string resource = 2;

Returns:

The resource.

getResourceBytes

com.google.protobuf.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 will always be returned in the normalized "long"
 format.
 See each *service's* documentation for supported formats.
 

string resource = 2;

Returns:

The bytes for resource.

getService

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:

The service.

getServiceBytes

com.google.protobuf.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:

The bytes for service.

hasFailurePolicy

boolean hasFailurePolicy()

 Specifies policy for failed executions.
 

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

Returns:

Whether the failurePolicy field is set.

getFailurePolicy

FailurePolicy getFailurePolicy()

 Specifies policy for failed executions.
 

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

Returns:

The failurePolicy.

getFailurePolicyOrBuilder

FailurePolicyOrBuilder getFailurePolicyOrBuilder()

 Specifies policy for failed executions.
 

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