Cloud Functions Triggers Service, REST: Trigger methods

ID of the trigger. Generated at creation time.

Required. ID of the folder that the trigger belongs to.

The maximum string length in characters is 50.

Creation timestamp for the trigger.

String in RFC3339 text format. The range of possible values is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

To work with values in this field, use the APIs described in the Protocol Buffers reference. In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).

Name of the trigger.

The string length in characters must be 3-63.

Description of the trigger.

The string length in characters must be 0-256.

Trigger labels as key:value pairs.

Required. Rule for trigger activation (always consistent with the trigger type).

Description of a rule for trigger activation.

Rule for activating a timed trigger.

Required. Description of a schedule as a cron expression.

The maximum string length in characters is 100.

A single function invocation.

Required. ID of the function to invoke.

The maximum string length in characters is 50.

Version tag of the function to execute.

ID of the service account that should be used to invoke the function.

A function invocation with retries.

Required. ID of the function to invoke.

The maximum string length in characters is 50.

Version tag of the function to execute.

ID of the service account which has permission to invoke the function.

Retry policy. If the field is not specified, or the value is empty, no retries will be attempted.

Settings for retrying to invoke a function.

Maximum number of retries (extra invokes) before the action is considered failed.

Acceptable values are 1 to 5, inclusive.

Required. Time in seconds to wait between individual retries.

DLQ policy (no value means discarding a message).

ID of the queue.

Required. Service account which has write permission on the queue.

The maximum string length in characters is 50.

A container invocation with retries.

Required. ID of the container to invoke.

The maximum string length in characters is 50.

Endpoint HTTP path to invoke.

ID of the service account which has permission to invoke the container.

Retry policy. If the field is not specified, or the value is empty, no retries will be attempted.

Settings for retrying to invoke a function.

Maximum number of retries (extra invokes) before the action is considered failed.

Acceptable values are 1 to 5, inclusive.

Required. Time in seconds to wait between individual retries.

DLQ policy (no value means discarding a message).

ID of the queue.

Required. Service account which has write permission on the queue.

The maximum string length in characters is 50.

Rule for activating a message queue trigger.

Required. ID of the message queue in Message Queue.

Required. ID of the service account which has read access to the message queue.

The maximum string length in characters is 50.

Settings for batch processing of messages in a queue.

Batch size. Trigger will send the batch of messages to the function when the number of messages in the queue reaches size, or the cutoff time has passed.

Acceptable values are 0 to 10, inclusive.

Required. Maximum wait time. Trigger will send the batch of messages to the function when the number of messages in the queue reaches size, or the cutoff time has passed.

Queue visibility timeout override.

The maximum value is 43200 seconds.

Required. ID of the function to invoke.

The maximum string length in characters is 50.

Version tag of the function to execute.

ID of the service account that should be used to invoke the function.

A single container invocation.

Required. ID of the container to invoke.

The maximum string length in characters is 50.

Endpoint HTTP path to invoke.

ID of the service account which has permission to invoke the container.

Rule for activating a IoT Core trigger.

Required. ID of the IoT Core registry.

ID of the IoT Core device in the registry.

MQTT topic whose messages activate the trigger.

Required. ID of the function to invoke.

The maximum string length in characters is 50.

Version tag of the function to execute.

ID of the service account which has permission to invoke the function.

Retry policy. If the field is not specified, or the value is empty, no retries will be attempted.

Settings for retrying to invoke a function.

Maximum number of retries (extra invokes) before the action is considered failed.

Acceptable values are 1 to 5, inclusive.

Required. Time in seconds to wait between individual retries.

DLQ policy (no value means discarding a message).

ID of the queue.

Required. Service account which has write permission on the queue.

The maximum string length in characters is 50.

Required. ID of the container to invoke.

The maximum string length in characters is 50.

Endpoint HTTP path to invoke.

ID of the service account which has permission to invoke the container.

Retry policy. If the field is not specified, or the value is empty, no retries will be attempted.

Settings for retrying to invoke a function.

Maximum number of retries (extra invokes) before the action is considered failed.

Acceptable values are 1 to 5, inclusive.

Required. Time in seconds to wait between individual retries.

DLQ policy (no value means discarding a message).

ID of the queue.

Required. Service account which has write permission on the queue.

The maximum string length in characters is 50.

Rule for activating a IoT Core Broker trigger.

Required. ID of the IoT Core broker.

MQTT topic whose messages activate the trigger.

Required. ID of the function to invoke.

The maximum string length in characters is 50.

Version tag of the function to execute.

ID of the service account which has permission to invoke the function.

Retry policy. If the field is not specified, or the value is empty, no retries will be attempted.

Settings for retrying to invoke a function.

Maximum number of retries (extra invokes) before the action is considered failed.

Acceptable values are 1 to 5, inclusive.

Required. Time in seconds to wait between individual retries.

DLQ policy (no value means discarding a message).

ID of the queue.

Required. Service account which has write permission on the queue.

The maximum string length in characters is 50.

Required. ID of the container to invoke.

The maximum string length in characters is 50.

Endpoint HTTP path to invoke.

ID of the service account which has permission to invoke the container.

Retry policy. If the field is not specified, or the value is empty, no retries will be attempted.

Settings for retrying to invoke a function.

Maximum number of retries (extra invokes) before the action is considered failed.

Acceptable values are 1 to 5, inclusive.

Required. Time in seconds to wait between individual retries.

DLQ policy (no value means discarding a message).

ID of the queue.

Required. Service account which has write permission on the queue.

The maximum string length in characters is 50.

Required. Type (name) of events, at least one value is required.

Must contain at least one element.

ID of the bucket.

Prefix of the object key. Filter, optional.

Suffix of the object key. Filter, optional.

Required. ID of the function to invoke.

The maximum string length in characters is 50.

Version tag of the function to execute.

ID of the service account which has permission to invoke the function.

Retry policy. If the field is not specified, or the value is empty, no retries will be attempted.

Settings for retrying to invoke a function.

Maximum number of retries (extra invokes) before the action is considered failed.

Acceptable values are 1 to 5, inclusive.

Required. Time in seconds to wait between individual retries.

DLQ policy (no value means discarding a message).

ID of the queue.

Required. Service account which has write permission on the queue.

The maximum string length in characters is 50.

Required. ID of the container to invoke.

The maximum string length in characters is 50.

Endpoint HTTP path to invoke.

ID of the service account which has permission to invoke the container.

Retry policy. If the field is not specified, or the value is empty, no retries will be attempted.

Settings for retrying to invoke a function.

Maximum number of retries (extra invokes) before the action is considered failed.

Acceptable values are 1 to 5, inclusive.

Required. Time in seconds to wait between individual retries.

DLQ policy (no value means discarding a message).

ID of the queue.

Required. Service account which has write permission on the queue.

The maximum string length in characters is 50.

Required. Type (name) of events, at least one value is required.

Must contain at least one element.

ID of the registry.

Docker-image name. Filter, optional.

Docker-image tag. Filter, optional.

Required. ID of the function to invoke.

The maximum string length in characters is 50.

Version tag of the function to execute.

ID of the service account which has permission to invoke the function.

Retry policy. If the field is not specified, or the value is empty, no retries will be attempted.

Settings for retrying to invoke a function.

Maximum number of retries (extra invokes) before the action is considered failed.

Acceptable values are 1 to 5, inclusive.

Required. Time in seconds to wait between individual retries.

DLQ policy (no value means discarding a message).

ID of the queue.

Required. Service account which has write permission on the queue.

The maximum string length in characters is 50.

Required. ID of the container to invoke.

The maximum string length in characters is 50.

Endpoint HTTP path to invoke.

ID of the service account which has permission to invoke the container.

Retry policy. If the field is not specified, or the value is empty, no retries will be attempted.

Settings for retrying to invoke a function.

Maximum number of retries (extra invokes) before the action is considered failed.

Acceptable values are 1 to 5, inclusive.

Required. Time in seconds to wait between individual retries.

DLQ policy (no value means discarding a message).

ID of the queue.

Required. Service account which has write permission on the queue.

The maximum string length in characters is 50.

Log group identifiers, at least one value is required.

Batch size. Trigger will send the batch of messages to the function when the number of messages in the log group reaches size, or the cutoff time has passed.

Acceptable values are 0 to 100, inclusive.

Maximum wait time. Trigger will send the batch of messages to the function when the number of messages in the log group reaches size, or the cutoff time has passed.

Acceptable values are 1 seconds to 60 seconds, inclusive.

Required. ID of the function to invoke.

The maximum string length in characters is 50.

Version tag of the function to execute.

ID of the service account which has permission to invoke the function.

Retry policy. If the field is not specified, or the value is empty, no retries will be attempted.

Settings for retrying to invoke a function.

Maximum number of retries (extra invokes) before the action is considered failed.

Acceptable values are 1 to 5, inclusive.

Required. Time in seconds to wait between individual retries.

DLQ policy (no value means discarding a message).

ID of the queue.

Required. Service account which has write permission on the queue.

The maximum string length in characters is 50.

Required. ID of the container to invoke.

The maximum string length in characters is 50.

Endpoint HTTP path to invoke.

ID of the service account which has permission to invoke the container.

Retry policy. If the field is not specified, or the value is empty, no retries will be attempted.

Settings for retrying to invoke a function.

Maximum number of retries (extra invokes) before the action is considered failed.

Acceptable values are 1 to 5, inclusive.

Required. Time in seconds to wait between individual retries.

DLQ policy (no value means discarding a message).

ID of the queue.

Required. Service account which has write permission on the queue.

The maximum string length in characters is 50.

Log events filter settings.

The maximum string length in characters is 50.

The maximum number of elements is 100. Each value must match the regular expression [a-zA-Z][-a-zA-Z0-9_.]{1,62}.

The maximum number of elements is 100. Each value must match the regular expression [a-zA-Z][-a-zA-Z0-9_.]{1,62}.

The maximum number of elements is 10.

• TRACE: Trace log level.

  Possible use case: verbose logging of some business logic.

• DEBUG: Debug log level.

  Possible use case: debugging special cases in application logic.

• INFO: Info log level.

  Mostly used for information messages.

• WARN: Warn log level.

  May be used to alert about significant events.

• ERROR: Error log level.

  May be used to alert about errors in infrastructure, logic, etc.

• FATAL: Fatal log level.

  May be used to alert about unrecoverable failures and events.

Batch size. Trigger will send the batch of messages to the associated function when the number of log events reaches this value, or the cutoff time has passed.

Acceptable values are 1 to 100, inclusive.

Maximum wait time. Trigger will send the batch of messages the time since the last batch exceeds the cutoff value, regardless of the amount of log events.

Acceptable values are 1 seconds to 60 seconds, inclusive.

Required. ID of the function to invoke.

The maximum string length in characters is 50.

Version tag of the function to execute.

ID of the service account which has permission to invoke the function.

Retry policy. If the field is not specified, or the value is empty, no retries will be attempted.

Settings for retrying to invoke a function.

Maximum number of retries (extra invokes) before the action is considered failed.

Acceptable values are 1 to 5, inclusive.

Required. Time in seconds to wait between individual retries.

DLQ policy (no value means discarding a message).

ID of the queue.

Required. Service account which has write permission on the queue.

The maximum string length in characters is 50.

Required. ID of the container to invoke.

The maximum string length in characters is 50.

Endpoint HTTP path to invoke.

ID of the service account which has permission to invoke the container.

Retry policy. If the field is not specified, or the value is empty, no retries will be attempted.

Settings for retrying to invoke a function.

Maximum number of retries (extra invokes) before the action is considered failed.

Acceptable values are 1 to 5, inclusive.

Required. Time in seconds to wait between individual retries.

DLQ policy (no value means discarding a message).

ID of the queue.

Required. Service account which has write permission on the queue.

The maximum string length in characters is 50.

Required. The maximum string length in characters is 50.

The maximum string length in characters is 50.

Required. ID of the function to invoke.

The maximum string length in characters is 50.

Version tag of the function to execute.

ID of the service account which has permission to invoke the function.

Retry policy. If the field is not specified, or the value is empty, no retries will be attempted.

Settings for retrying to invoke a function.

Maximum number of retries (extra invokes) before the action is considered failed.

Acceptable values are 1 to 5, inclusive.

Required. Time in seconds to wait between individual retries.

DLQ policy (no value means discarding a message).

ID of the queue.

Required. Service account which has write permission on the queue.

The maximum string length in characters is 50.

Required. ID of the container to invoke.

The maximum string length in characters is 50.

Endpoint HTTP path to invoke.

ID of the service account which has permission to invoke the container.

Retry policy. If the field is not specified, or the value is empty, no retries will be attempted.

Settings for retrying to invoke a function.

Maximum number of retries (extra invokes) before the action is considered failed.

Acceptable values are 1 to 5, inclusive.

Required. Time in seconds to wait between individual retries.

DLQ policy (no value means discarding a message).

ID of the queue.

Required. Service account which has write permission on the queue.

The maximum string length in characters is 50.

Data stream endpoint.

Data stream database.

Stream name.

ID of the service account which has permission to read data stream.

Batch size in bytes. Trigger will send the batch of messages to the associated function when size of log events reaches this value, or the cutoff time has passed.

Acceptable values are 1 to 65536, inclusive.

Maximum wait time. Trigger will send the batch of messages the time since the last batch exceeds the cutoff value, regardless of the amount of log events.

Acceptable values are 1 seconds to 60 seconds, inclusive.

Required. ID of the function to invoke.

The maximum string length in characters is 50.

Version tag of the function to execute.

ID of the service account which has permission to invoke the function.

Retry policy. If the field is not specified, or the value is empty, no retries will be attempted.

Settings for retrying to invoke a function.

Maximum number of retries (extra invokes) before the action is considered failed.

Acceptable values are 1 to 5, inclusive.

Required. Time in seconds to wait between individual retries.

DLQ policy (no value means discarding a message).

ID of the queue.

Required. Service account which has write permission on the queue.

The maximum string length in characters is 50.

Required. ID of the container to invoke.

The maximum string length in characters is 50.

Endpoint HTTP path to invoke.

ID of the service account which has permission to invoke the container.

Retry policy. If the field is not specified, or the value is empty, no retries will be attempted.

Settings for retrying to invoke a function.

Maximum number of retries (extra invokes) before the action is considered failed.

Acceptable values are 1 to 5, inclusive.

Required. Time in seconds to wait between individual retries.

DLQ policy (no value means discarding a message).

ID of the queue.

Required. Service account which has write permission on the queue.

The maximum string length in characters is 50.

Address to receive emails for trigger activation. Field is ignored for write requests and populated on trigger creation.

Required. ID of the function to invoke.

The maximum string length in characters is 50.

Version tag of the function to execute.

ID of the service account which has permission to invoke the function.

Retry policy. If the field is not specified, or the value is empty, no retries will be attempted.

Settings for retrying to invoke a function.

Maximum number of retries (extra invokes) before the action is considered failed.

Acceptable values are 1 to 5, inclusive.

Required. Time in seconds to wait between individual retries.

DLQ policy (no value means discarding a message).

ID of the queue.

Required. Service account which has write permission on the queue.

The maximum string length in characters is 50.

Required. ID of the container to invoke.

The maximum string length in characters is 50.

Endpoint HTTP path to invoke.

ID of the service account which has permission to invoke the container.

Retry policy. If the field is not specified, or the value is empty, no retries will be attempted.

Settings for retrying to invoke a function.

Maximum number of retries (extra invokes) before the action is considered failed.

Acceptable values are 1 to 5, inclusive.

Required. Time in seconds to wait between individual retries.

DLQ policy (no value means discarding a message).

ID of the queue.

Required. Service account which has write permission on the queue.

The maximum string length in characters is 50.

Trigger status.