Package com.google.cloud.functions.v1

Class EventTrigger

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.functions.v1.EventTrigger
All Implemented Interfaces:
EventTriggerOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class EventTrigger extends com.google.protobuf.GeneratedMessage implements EventTriggerOrBuilder
 Describes EventTrigger, used to request events be sent from another
 service.
Protobuf type google.cloud.functions.v1.EventTrigger
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    EventTrigger.Builder
    Describes EventTrigger, used to request events be sent from another service.

    Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage

    com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message,T extends Object>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage

    com.google.protobuf.AbstractMessage.BuilderParent

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

    com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    EVENT_TYPE_FIELD_NUMBER
     
    static final int
    FAILURE_POLICY_FIELD_NUMBER
     
    static final int
    RESOURCE_FIELD_NUMBER
     
    static final int
    SERVICE_FIELD_NUMBER
     

    Fields inherited from class com.google.protobuf.GeneratedMessage

    alwaysUseFieldBuilders, loggedPre22TypeNames, unknownFields

    Fields inherited from class com.google.protobuf.AbstractMessage

    memoizedSize

    Fields inherited from class com.google.protobuf.AbstractMessageLite

    memoizedHashCode

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object obj)
     
    static EventTrigger
    getDefaultInstance()
     
    EventTrigger
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    String
    getEventType()
    Required.
    com.google.protobuf.ByteString
    getEventTypeBytes()
    Required.
    FailurePolicy
    getFailurePolicy()
    Specifies policy for failed executions.
    FailurePolicyOrBuilder
    getFailurePolicyOrBuilder()
    Specifies policy for failed executions.
    com.google.protobuf.Parser<EventTrigger>
    getParserForType()
     
    String
    getResource()
    Required.
    com.google.protobuf.ByteString
    getResourceBytes()
    Required.
    int
    getSerializedSize()
     
    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.
    int
    hashCode()
     
    protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static EventTrigger.Builder
    newBuilder()
     
    static EventTrigger.Builder
    newBuilder(EventTrigger prototype)
     
    EventTrigger.Builder
    newBuilderForType()
     
    protected EventTrigger.Builder
    newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
     
    static EventTrigger
    parseDelimitedFrom(InputStream input)
     
    static EventTrigger
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static EventTrigger
    parseFrom(byte[] data)
     
    static EventTrigger
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static EventTrigger
    parseFrom(com.google.protobuf.ByteString data)
     
    static EventTrigger
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static EventTrigger
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static EventTrigger
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static EventTrigger
    parseFrom(InputStream input)
     
    static EventTrigger
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static EventTrigger
    parseFrom(ByteBuffer data)
     
    static EventTrigger
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<EventTrigger>
    parser()
     
    EventTrigger.Builder
    toBuilder()
     
    void
    writeTo(com.google.protobuf.CodedOutputStream output)
     

    Methods inherited from class com.google.protobuf.GeneratedMessage

    canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

    Methods inherited from class com.google.protobuf.AbstractMessage

    findInitializationErrors, getInitializationErrorString, hashFields, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite

    addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.google.protobuf.MessageLite

    toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

  • Field Details

    • EVENT_TYPE_FIELD_NUMBER

      public static final int EVENT_TYPE_FIELD_NUMBER
      See Also:

    • RESOURCE_FIELD_NUMBER

      public static final int RESOURCE_FIELD_NUMBER
      See Also:

    • SERVICE_FIELD_NUMBER

      public static final int SERVICE_FIELD_NUMBER
      See Also:

    • FAILURE_POLICY_FIELD_NUMBER

      public static final int FAILURE_POLICY_FIELD_NUMBER
      See Also:

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

    • 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;
      Specified by:
      getEventType in interface EventTriggerOrBuilder
      Returns:
      The eventType.

    • getEventTypeBytes

      public 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;
      Specified by:
      getEventTypeBytes in interface EventTriggerOrBuilder
      Returns:
      The bytes for eventType.

    • 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;
      Specified by:
      getResource in interface EventTriggerOrBuilder
      Returns:
      The resource.

    • getResourceBytes

      public 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;
      Specified by:
      getResourceBytes in interface EventTriggerOrBuilder
      Returns:
      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;
      Specified by:
      getService in interface EventTriggerOrBuilder
      Returns:
      The service.

    • getServiceBytes

      public 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;
      Specified by:
      getServiceBytes in interface EventTriggerOrBuilder
      Returns:
      The bytes for service.

    • hasFailurePolicy

      public boolean hasFailurePolicy()
       Specifies policy for failed executions.
      .google.cloud.functions.v1.FailurePolicy failure_policy = 5;
      Specified by:
      hasFailurePolicy in interface EventTriggerOrBuilder
      Returns:
      Whether the failurePolicy field is set.

    • getFailurePolicy

      public FailurePolicy getFailurePolicy()
       Specifies policy for failed executions.
      .google.cloud.functions.v1.FailurePolicy failure_policy = 5;
      Specified by:
      getFailurePolicy in interface EventTriggerOrBuilder
      Returns:
      The failurePolicy.

    • getFailurePolicyOrBuilder

      public FailurePolicyOrBuilder getFailurePolicyOrBuilder()
       Specifies policy for failed executions.
      .google.cloud.functions.v1.FailurePolicy failure_policy = 5;
      Specified by:
      getFailurePolicyOrBuilder in interface EventTriggerOrBuilder

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static EventTrigger parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static EventTrigger parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static EventTrigger parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static EventTrigger parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static EventTrigger parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static EventTrigger parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static EventTrigger parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static EventTrigger parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static EventTrigger parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static EventTrigger parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static EventTrigger parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static EventTrigger parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public EventTrigger.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static EventTrigger.Builder newBuilder()

    • newBuilder

      public static EventTrigger.Builder newBuilder(EventTrigger prototype)

    • toBuilder

      public EventTrigger.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected EventTrigger.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static EventTrigger getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<EventTrigger> parser()

    • getParserForType

      public com.google.protobuf.Parser<EventTrigger> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessage

    • getDefaultInstanceForType

      public EventTrigger getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder