EventTrigger

google.cloud.functions.v2. EventTrigger

Represents an EventTrigger.

Constructor

new EventTrigger(propertiesopt)

Constructs a new EventTrigger.

Parameters:
Name Type Attributes Description
properties google.cloud.functions.v2.IEventTrigger <optional>

Properties to set

Implements:
  • IEventTrigger

Members

channel

EventTrigger channel.

eventFilters

EventTrigger eventFilters.

eventType

EventTrigger eventType.

pubsubTopic

EventTrigger pubsubTopic.

retryPolicy

EventTrigger retryPolicy.

service

EventTrigger service.

serviceAccountEmail

EventTrigger serviceAccountEmail.

trigger

EventTrigger trigger.

triggerRegion

EventTrigger triggerRegion.

RetryPolicy

RetryPolicy enum.

Properties:
Name Type Description
RETRY_POLICY_UNSPECIFIED number

RETRY_POLICY_UNSPECIFIED value

RETRY_POLICY_DO_NOT_RETRY number

RETRY_POLICY_DO_NOT_RETRY value

RETRY_POLICY_RETRY number

RETRY_POLICY_RETRY value

Methods

toJSON() → {Object.<string, *>}

Converts this EventTrigger to JSON.

Returns:
Type Description
Object.<string, *>

JSON object

(static) create(propertiesopt) → {google.cloud.functions.v2.EventTrigger}

Creates a new EventTrigger instance using the specified properties.

Parameters:
Name Type Attributes Description
properties google.cloud.functions.v2.IEventTrigger <optional>

Properties to set

Returns:
Type Description
google.cloud.functions.v2.EventTrigger

EventTrigger instance

(static) decode(reader, lengthopt) → {google.cloud.functions.v2.EventTrigger}

Decodes an EventTrigger message from the specified reader or buffer.

Parameters:
Name Type Attributes Description
reader $protobuf.Reader | Uint8Array

Reader or buffer to decode from

length number <optional>

Message length if known beforehand

Returns:
Type Description
google.cloud.functions.v2.EventTrigger

EventTrigger

Throws:
  • If the payload is not a reader or valid buffer

    Type
    Error
  • If required fields are missing

    Type
    $protobuf.util.ProtocolError

(static) decodeDelimited(reader) → {google.cloud.functions.v2.EventTrigger}

Decodes an EventTrigger message from the specified reader or buffer, length delimited.

Parameters:
Name Type Description
reader $protobuf.Reader | Uint8Array

Reader or buffer to decode from

Returns:
Type Description
google.cloud.functions.v2.EventTrigger

EventTrigger

Throws:
  • If the payload is not a reader or valid buffer

    Type
    Error
  • If required fields are missing

    Type
    $protobuf.util.ProtocolError

(static) encode(message, writeropt) → {$protobuf.Writer}

Encodes the specified EventTrigger message. Does not implicitly verify messages.

Parameters:
Name Type Attributes Description
message google.cloud.functions.v2.IEventTrigger

EventTrigger message or plain object to encode

writer $protobuf.Writer <optional>

Writer to encode to

Returns:
Type Description
$protobuf.Writer

Writer

(static) encodeDelimited(message, writeropt) → {$protobuf.Writer}

Encodes the specified EventTrigger message, length delimited. Does not implicitly verify messages.

Parameters:
Name Type Attributes Description
message google.cloud.functions.v2.IEventTrigger

EventTrigger message or plain object to encode

writer $protobuf.Writer <optional>

Writer to encode to

Returns:
Type Description
$protobuf.Writer

Writer

(static) fromObject(object) → {google.cloud.functions.v2.EventTrigger}

Creates an EventTrigger message from a plain object. Also converts values to their respective internal types.

Parameters:
Name Type Description
object Object.<string, *>

Plain object

Returns:
Type Description
google.cloud.functions.v2.EventTrigger

EventTrigger

(static) getTypeUrl(typeUrlPrefixopt) → {string}

Gets the default type url for EventTrigger

Parameters:
Name Type Attributes Description
typeUrlPrefix string <optional>

your custom typeUrlPrefix(default "type.googleapis.com")

Returns:
Type Description
string

The default type url

(static) toObject(message, optionsopt) → {Object.<string, *>}

Creates a plain object from an EventTrigger message. Also converts values to other types if specified.

Parameters:
Name Type Attributes Description
message google.cloud.functions.v2.EventTrigger

EventTrigger

options $protobuf.IConversionOptions <optional>

Conversion options

Returns:
Type Description
Object.<string, *>

Plain object

(static) verify(message) → {string|null}

Verifies an EventTrigger message.

Parameters:
Name Type Description
message Object.<string, *>

Plain object to verify

Returns:
Type Description
string | null

null if valid, otherwise the reason why it is not