Class EventTrigger.Builder (2.51.0) 

public static final class EventTrigger.Builder extends GeneratedMessageV3.Builder<EventTrigger.Builder> implements EventTriggerOrBuilder

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

Protobuf type google.cloud.functions.v1.EventTrigger

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > EventTrigger.Builder

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public EventTrigger.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
EventTrigger.Builder
Overrides

build()

public EventTrigger build()
Returns
Type Description
EventTrigger

buildPartial()

public EventTrigger buildPartial()
Returns
Type Description
EventTrigger

clear()

public EventTrigger.Builder clear()
Returns
Type Description
EventTrigger.Builder
Overrides

clearEventType()

public EventTrigger.Builder clearEventType()

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
Type Description
EventTrigger.Builder

This builder for chaining.

clearFailurePolicy()

public EventTrigger.Builder clearFailurePolicy()

Specifies policy for failed executions.

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

Returns
Type Description
EventTrigger.Builder

clearField(Descriptors.FieldDescriptor field)

public EventTrigger.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
EventTrigger.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public EventTrigger.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
EventTrigger.Builder
Overrides

clearResource()

public EventTrigger.Builder clearResource()

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
Type Description
EventTrigger.Builder

This builder for chaining.

clearService()

public EventTrigger.Builder clearService()

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
EventTrigger.Builder

This builder for chaining.

clone()

public EventTrigger.Builder clone()
Returns
Type Description
EventTrigger.Builder
Overrides

getDefaultInstanceForType()

public EventTrigger getDefaultInstanceForType()
Returns
Type Description
EventTrigger

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

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 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:

  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
Type Description
ByteString

The bytes for eventType.

getFailurePolicy()

public FailurePolicy getFailurePolicy()

Specifies policy for failed executions.

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

Returns
Type Description
FailurePolicy

The failurePolicy.

getFailurePolicyBuilder()

public FailurePolicy.Builder getFailurePolicyBuilder()

Specifies policy for failed executions.

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

Returns
Type Description
FailurePolicy.Builder

getFailurePolicyOrBuilder()

public FailurePolicyOrBuilder getFailurePolicyOrBuilder()

Specifies policy for failed executions.

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

Returns
Type Description
FailurePolicyOrBuilder

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 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:

  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
Type Description
ByteString

The bytes for resource.

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.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFailurePolicy(FailurePolicy value)

public EventTrigger.Builder mergeFailurePolicy(FailurePolicy value)

Specifies policy for failed executions.

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

Parameter
Name Description
value FailurePolicy
Returns
Type Description
EventTrigger.Builder

mergeFrom(EventTrigger other)

public EventTrigger.Builder mergeFrom(EventTrigger other)
Parameter
Name Description
other EventTrigger
Returns
Type Description
EventTrigger.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public EventTrigger.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
EventTrigger.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public EventTrigger.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
EventTrigger.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final EventTrigger.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
EventTrigger.Builder
Overrides

setEventType(String value)

public EventTrigger.Builder setEventType(String value)

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;

Parameter
Name Description
value String

The eventType to set.
Returns
Type Description
EventTrigger.Builder

This builder for chaining.

setEventTypeBytes(ByteString value)

public EventTrigger.Builder setEventTypeBytes(ByteString value)

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;

Parameter
Name Description
value ByteString

The bytes for eventType to set.
Returns
Type Description
EventTrigger.Builder

This builder for chaining.

setFailurePolicy(FailurePolicy value)

public EventTrigger.Builder setFailurePolicy(FailurePolicy value)

Specifies policy for failed executions.

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

Parameter
Name Description
value FailurePolicy
Returns
Type Description
EventTrigger.Builder

setFailurePolicy(FailurePolicy.Builder builderForValue)

public EventTrigger.Builder setFailurePolicy(FailurePolicy.Builder builderForValue)

Specifies policy for failed executions.

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

Parameter
Name Description
builderForValue FailurePolicy.Builder
Returns
Type Description
EventTrigger.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public EventTrigger.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
EventTrigger.Builder
Overrides

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public EventTrigger.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
EventTrigger.Builder
Overrides

setResource(String value)

public EventTrigger.Builder setResource(String value)

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;

Parameter
Name Description
value String

The resource to set.
Returns
Type Description
EventTrigger.Builder

This builder for chaining.

setResourceBytes(ByteString value)

public EventTrigger.Builder setResourceBytes(ByteString value)

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;

Parameter
Name Description
value ByteString

The bytes for resource to set.
Returns
Type Description
EventTrigger.Builder

This builder for chaining.

setService(String value)

public EventTrigger.Builder setService(String value)

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;

Parameter
Name Description
value String

The service to set.
Returns
Type Description
EventTrigger.Builder

This builder for chaining.

setServiceBytes(ByteString value)

public EventTrigger.Builder setServiceBytes(ByteString value)

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;

Parameter
Name Description
value ByteString

The bytes for service to set.
Returns
Type Description
EventTrigger.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final EventTrigger.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
EventTrigger.Builder
Overrides