Class EventTrigger.Builder (2.62.0)

publicstaticfinalclassEventTrigger.BuilderextendsGeneratedMessageV3.Builder<EventTrigger.Builder>implementsEventTriggerOrBuilder

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

Protobuf type google.cloud.functions.v1.EventTrigger

Static Methods

getDescriptor()

publicstaticfinalDescriptors.DescriptorgetDescriptor()
Returns
TypeDescription
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

publicEventTrigger.BuilderaddRepeatedField(Descriptors.FieldDescriptorfield,Objectvalue)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
EventTrigger.Builder
Overrides

build()

publicEventTriggerbuild()
Returns
TypeDescription
EventTrigger

buildPartial()

publicEventTriggerbuildPartial()
Returns
TypeDescription
EventTrigger

clear()

publicEventTrigger.Builderclear()
Returns
TypeDescription
EventTrigger.Builder
Overrides

clearEventType()

publicEventTrigger.BuilderclearEventType()

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

This builder for chaining.

clearFailurePolicy()

publicEventTrigger.BuilderclearFailurePolicy()

Specifies policy for failed executions.

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

Returns
TypeDescription
EventTrigger.Builder

clearField(Descriptors.FieldDescriptor field)

publicEventTrigger.BuilderclearField(Descriptors.FieldDescriptorfield)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
EventTrigger.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

publicEventTrigger.BuilderclearOneof(Descriptors.OneofDescriptoroneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
EventTrigger.Builder
Overrides

clearResource()

publicEventTrigger.BuilderclearResource()

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

This builder for chaining.

clearService()

publicEventTrigger.BuilderclearService()

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

This builder for chaining.

clone()

publicEventTrigger.Builderclone()
Returns
TypeDescription
EventTrigger.Builder
Overrides

getDefaultInstanceForType()

publicEventTriggergetDefaultInstanceForType()
Returns
TypeDescription
EventTrigger

getDescriptorForType()

publicDescriptors.DescriptorgetDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

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

string event_type = 1;

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

string event_type = 1;

Returns
TypeDescription
ByteString

The bytes for eventType.

getFailurePolicy()

publicFailurePolicygetFailurePolicy()

Specifies policy for failed executions.

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

Returns
TypeDescription
FailurePolicy

The failurePolicy.

getFailurePolicyBuilder()

publicFailurePolicy.BuildergetFailurePolicyBuilder()

Specifies policy for failed executions.

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

Returns
TypeDescription
FailurePolicy.Builder

getFailurePolicyOrBuilder()

publicFailurePolicyOrBuildergetFailurePolicyOrBuilder()

Specifies policy for failed executions.

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

Returns
TypeDescription
FailurePolicyOrBuilder

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 will always be returned in the normalized "long" format.

    See each service's documentation for supported formats.

string resource = 2;

Returns
TypeDescription
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 will always be returned in the normalized "long" format.

    See each service's documentation for supported formats.

string resource = 2;

Returns
TypeDescription
ByteString

The bytes for resource.

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

The bytes for service.

hasFailurePolicy()

publicbooleanhasFailurePolicy()

Specifies policy for failed executions.

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

Returns
TypeDescription
boolean

Whether the failurePolicy field is set.

internalGetFieldAccessorTable()

protectedGeneratedMessageV3.FieldAccessorTableinternalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

publicfinalbooleanisInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFailurePolicy(FailurePolicy value)

publicEventTrigger.BuildermergeFailurePolicy(FailurePolicyvalue)

Specifies policy for failed executions.

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

Parameter
NameDescription
valueFailurePolicy
Returns
TypeDescription
EventTrigger.Builder

mergeFrom(EventTrigger other)

publicEventTrigger.BuildermergeFrom(EventTriggerother)
Parameter
NameDescription
otherEventTrigger
Returns
TypeDescription
EventTrigger.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

publicEventTrigger.BuildermergeFrom(CodedInputStreaminput,ExtensionRegistryLiteextensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
EventTrigger.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

publicEventTrigger.BuildermergeFrom(Messageother)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
EventTrigger.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

publicfinalEventTrigger.BuildermergeUnknownFields(UnknownFieldSetunknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
EventTrigger.Builder
Overrides

setEventType(String value)

publicEventTrigger.BuildersetEventType(Stringvalue)

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
NameDescription
valueString

The eventType to set.

Returns
TypeDescription
EventTrigger.Builder

This builder for chaining.

setEventTypeBytes(ByteString value)

publicEventTrigger.BuildersetEventTypeBytes(ByteStringvalue)

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
NameDescription
valueByteString

The bytes for eventType to set.

Returns
TypeDescription
EventTrigger.Builder

This builder for chaining.

setFailurePolicy(FailurePolicy value)

publicEventTrigger.BuildersetFailurePolicy(FailurePolicyvalue)

Specifies policy for failed executions.

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

Parameter
NameDescription
valueFailurePolicy
Returns
TypeDescription
EventTrigger.Builder

setFailurePolicy(FailurePolicy.Builder builderForValue)

publicEventTrigger.BuildersetFailurePolicy(FailurePolicy.BuilderbuilderForValue)

Specifies policy for failed executions.

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

Parameter
NameDescription
builderForValueFailurePolicy.Builder
Returns
TypeDescription
EventTrigger.Builder

setField(Descriptors.FieldDescriptor field, Object value)

publicEventTrigger.BuildersetField(Descriptors.FieldDescriptorfield,Objectvalue)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
EventTrigger.Builder
Overrides

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

publicEventTrigger.BuildersetRepeatedField(Descriptors.FieldDescriptorfield,intindex,Objectvalue)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
EventTrigger.Builder
Overrides

setResource(String value)

publicEventTrigger.BuildersetResource(Stringvalue)

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
NameDescription
valueString

The resource to set.

Returns
TypeDescription
EventTrigger.Builder

This builder for chaining.

setResourceBytes(ByteString value)

publicEventTrigger.BuildersetResourceBytes(ByteStringvalue)

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
NameDescription
valueByteString

The bytes for resource to set.

Returns
TypeDescription
EventTrigger.Builder

This builder for chaining.

setService(String value)

publicEventTrigger.BuildersetService(Stringvalue)

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
NameDescription
valueString

The service to set.

Returns
TypeDescription
EventTrigger.Builder

This builder for chaining.

setServiceBytes(ByteString value)

publicEventTrigger.BuildersetServiceBytes(ByteStringvalue)

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
NameDescription
valueByteString

The bytes for service to set.

Returns
TypeDescription
EventTrigger.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

publicfinalEventTrigger.BuildersetUnknownFields(UnknownFieldSetunknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
EventTrigger.Builder
Overrides