Cloud Functions Triggers Service, REST: Trigger.Update

Field

Description

triggerId

string

Required field. ID of the trigger to update.

To get a trigger ID make a TriggerService.List request.

Field

Description

updateMask

string (field-mask)

A comma-separated names off ALL fields to be updated.
Only the specified fields will be changed. The others will be left untouched.
If the field is specified in updateMask and no value for that field was sent in the request,
the field's value will be reset to the default. The default value for most fields is null or 0.

If updateMask is not sent in the request, all fields' values will be updated.
Fields specified in the request will be updated to provided values.
The rest of the fields will be reset to the default.

name

string

New name for the trigger.
The name must be unique within the folder.

Value must match the regular expression \|[a-z][-a-z0-9]{1,61}[a-z0-9].

description

string

New description of the trigger.

The maximum string length in characters is 256.

labels

object (map<string, string>)

Trigger labels as key:value pairs.

Existing set of labels is completely replaced by the provided set, so if you just want
to add or remove a label, request the current set of labels with a TriggerService.Get request.

No more than 64 per resource. The maximum string length in characters for each value is 63. Each value must match the regular expression [-_./\@0-9a-z]*. The string length in characters for each key must be 1-63. Each key must match the regular expression [a-z][-_./\@0-9a-z]*.

rule

Rule

New parameters for trigger.

Field

Description

timer

Timer

Rule for a timed trigger.

Includes only one of the fields timer, messageQueue, iotMessage, iotBrokerMessage, objectStorage, containerRegistry, cloudLogs, logging, billingBudget, dataStream, mail.

messageQueue

MessageQueue

Rule for a message queue trigger.

Includes only one of the fields timer, messageQueue, iotMessage, iotBrokerMessage, objectStorage, containerRegistry, cloudLogs, logging, billingBudget, dataStream, mail.

iotMessage

IoTMessage

Rule for a IoT Core trigger.

Includes only one of the fields timer, messageQueue, iotMessage, iotBrokerMessage, objectStorage, containerRegistry, cloudLogs, logging, billingBudget, dataStream, mail.

iotBrokerMessage

IoTBrokerMessage

Includes only one of the fields timer, messageQueue, iotMessage, iotBrokerMessage, objectStorage, containerRegistry, cloudLogs, logging, billingBudget, dataStream, mail.

objectStorage

ObjectStorage

Includes only one of the fields timer, messageQueue, iotMessage, iotBrokerMessage, objectStorage, containerRegistry, cloudLogs, logging, billingBudget, dataStream, mail.

containerRegistry

ContainerRegistry

Includes only one of the fields timer, messageQueue, iotMessage, iotBrokerMessage, objectStorage, containerRegistry, cloudLogs, logging, billingBudget, dataStream, mail.

cloudLogs

CloudLogs

Includes only one of the fields timer, messageQueue, iotMessage, iotBrokerMessage, objectStorage, containerRegistry, cloudLogs, logging, billingBudget, dataStream, mail.

logging

Logging

Includes only one of the fields timer, messageQueue, iotMessage, iotBrokerMessage, objectStorage, containerRegistry, cloudLogs, logging, billingBudget, dataStream, mail.

billingBudget

BillingBudget

Includes only one of the fields timer, messageQueue, iotMessage, iotBrokerMessage, objectStorage, containerRegistry, cloudLogs, logging, billingBudget, dataStream, mail.

dataStream

DataStream

Includes only one of the fields timer, messageQueue, iotMessage, iotBrokerMessage, objectStorage, containerRegistry, cloudLogs, logging, billingBudget, dataStream, mail.

mail

Mail

Includes only one of the fields timer, messageQueue, iotMessage, iotBrokerMessage, objectStorage, containerRegistry, cloudLogs, logging, billingBudget, dataStream, mail.

Field

Description

cronExpression

string

Required field. Description of a schedule as a cron expression.

The maximum string length in characters is 100.

payload

string

Payload to be passed to function.

The maximum string length in characters is 4096.

invokeFunction

InvokeFunctionOnce

Instructions for invoking a function once.

Includes only one of the fields invokeFunction, invokeFunctionWithRetry, invokeContainerWithRetry, gatewayWebsocketBroadcast.

Action to be executed when the current time matches the cronExpression.

invokeFunctionWithRetry

InvokeFunctionWithRetry

Instructions for invoking a function with retry.

Includes only one of the fields invokeFunction, invokeFunctionWithRetry, invokeContainerWithRetry, gatewayWebsocketBroadcast.

Action to be executed when the current time matches the cronExpression.

invokeContainerWithRetry

InvokeContainerWithRetry

Instructions for invoking a container with retry.

Includes only one of the fields invokeFunction, invokeFunctionWithRetry, invokeContainerWithRetry, gatewayWebsocketBroadcast.

Action to be executed when the current time matches the cronExpression.

gatewayWebsocketBroadcast

GatewayWebsocketBroadcast

Instructions for broadcasting to API gateway websocket once.

Includes only one of the fields invokeFunction, invokeFunctionWithRetry, invokeContainerWithRetry, gatewayWebsocketBroadcast.

Action to be executed when the current time matches the cronExpression.

Field

Description

functionId

string

Required field. ID of the function to invoke.

The maximum string length in characters is 50.

functionTag

string

Version tag of the function to execute.

serviceAccountId

string

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

Field

Description

functionId

string

Required field. ID of the function to invoke.

The maximum string length in characters is 50.

functionTag

string

Version tag of the function to execute.

serviceAccountId

string

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

retrySettings

RetrySettings

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

deadLetterQueue

PutQueueMessage

DLQ policy (no value means discarding a message).

Field

Description

retryAttempts

string (int64)

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

Acceptable values are 1 to 5, inclusive.

interval

string (duration)

Required field. Time in seconds to wait between individual retries.

Field

Description

queueId

string

ID of the queue.

serviceAccountId

string

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

The maximum string length in characters is 50.

Field

Description

containerId

string

Required field. ID of the container to invoke.

The maximum string length in characters is 50.

path

string

Endpoint HTTP path to invoke.

serviceAccountId

string

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

retrySettings

RetrySettings

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

deadLetterQueue

PutQueueMessage

DLQ policy (no value means discarding a message).

Field

Description

gatewayId

string

Required field.

The maximum string length in characters is 50.

path

string

Required field.

serviceAccountId

string

Required field. sa which has permission for writing to websockets

The maximum string length in characters is 50.

Field

Description

queueId

string

Required field. ID of the message queue in Message Queue.

serviceAccountId

string

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

The maximum string length in characters is 50.

batchSettings

BatchSettings

Required field. Batch settings for processing messages in the queue.

visibilityTimeout

string (duration)

Queue visibility timeout override.

invokeFunction

InvokeFunctionOnce

Instructions for invoking a function once.

Includes only one of the fields invokeFunction, invokeContainer, gatewayWebsocketBroadcast.

Action to be executed when the there's a new message in the queue.

invokeContainer

InvokeContainerOnce

Instructions for invoking a container once.

Includes only one of the fields invokeFunction, invokeContainer, gatewayWebsocketBroadcast.

Action to be executed when the there's a new message in the queue.

gatewayWebsocketBroadcast

GatewayWebsocketBroadcast

Instructions for broadcasting to API gateway websocket once.

Includes only one of the fields invokeFunction, invokeContainer, gatewayWebsocketBroadcast.

Action to be executed when the there's a new message in the queue.

Field

Description

size

string (int64)

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 1000, inclusive.

cutoff

string (duration)

Required field. 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.

Field

Description

containerId

string

Required field. ID of the container to invoke.

The maximum string length in characters is 50.

path

string

Endpoint HTTP path to invoke.

serviceAccountId

string

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

Field

Description

registryId

string

Required field. ID of the IoT Core registry.

deviceId

string

ID of the IoT Core device in the registry.

mqttTopic

string

MQTT topic whose messages activate the trigger.

batchSettings

BatchSettings

Batch settings for processing events.

invokeFunction

InvokeFunctionWithRetry

Instructions for invoking a function with retries as needed.

Includes only one of the fields invokeFunction, invokeContainer, gatewayWebsocketBroadcast.

Action to be executed when the there's a new message in the MQTT topic.

invokeContainer

InvokeContainerWithRetry

Instructions for invoking a container with retries as needed.

Includes only one of the fields invokeFunction, invokeContainer, gatewayWebsocketBroadcast.

Action to be executed when the there's a new message in the MQTT topic.

gatewayWebsocketBroadcast

GatewayWebsocketBroadcast

Instructions for broadcasting to API gateway websocket once.

Includes only one of the fields invokeFunction, invokeContainer, gatewayWebsocketBroadcast.

Action to be executed when the there's a new message in the MQTT topic.

Field

Description

brokerId

string

Required field. ID of the IoT Core broker.

mqttTopic

string

MQTT topic whose messages activate the trigger.

batchSettings

BatchSettings

Batch settings for processing events.

invokeFunction

InvokeFunctionWithRetry

Instructions for invoking a function with retries as needed.

Includes only one of the fields invokeFunction, invokeContainer, gatewayWebsocketBroadcast.

Action to be executed when the there's a new message in the MQTT topic.

invokeContainer

InvokeContainerWithRetry

Instructions for invoking a container with retries as needed.

Includes only one of the fields invokeFunction, invokeContainer, gatewayWebsocketBroadcast.

Action to be executed when the there's a new message in the MQTT topic.

gatewayWebsocketBroadcast

GatewayWebsocketBroadcast

Instructions for broadcasting to API gateway websocket once.

Includes only one of the fields invokeFunction, invokeContainer, gatewayWebsocketBroadcast.

Action to be executed when the there's a new message in the MQTT topic.

Field

Description

eventType[]

enum (ObjectStorageEventType)

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

The number of elements must be greater than 0.

• OBJECT_STORAGE_EVENT_TYPE_CREATE_OBJECT
• OBJECT_STORAGE_EVENT_TYPE_UPDATE_OBJECT
• OBJECT_STORAGE_EVENT_TYPE_DELETE_OBJECT

bucketId

string

ID of the bucket.

prefix

string

Prefix of the object key. Filter, optional.

suffix

string

Suffix of the object key. Filter, optional.

batchSettings

BatchSettings

Batch settings for processing events.

invokeFunction

InvokeFunctionWithRetry

Instructions for invoking a function with retries as needed.

Includes only one of the fields invokeFunction, invokeContainer, gatewayWebsocketBroadcast.

invokeContainer

InvokeContainerWithRetry

Instructions for invoking a container with retries as needed.

Includes only one of the fields invokeFunction, invokeContainer, gatewayWebsocketBroadcast.

gatewayWebsocketBroadcast

GatewayWebsocketBroadcast

Instructions for broadcasting to API gateway websocket once.

Includes only one of the fields invokeFunction, invokeContainer, gatewayWebsocketBroadcast.

Field

Description

eventType[]

enum (ContainerRegistryEventType)

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

The number of elements must be greater than 0.

• CONTAINER_REGISTRY_EVENT_TYPE_CREATE_IMAGE
• CONTAINER_REGISTRY_EVENT_TYPE_DELETE_IMAGE
• CONTAINER_REGISTRY_EVENT_TYPE_CREATE_IMAGE_TAG
• CONTAINER_REGISTRY_EVENT_TYPE_DELETE_IMAGE_TAG

registryId

string

ID of the registry.

imageName

string

Docker-image name. Filter, optional.

tag

string

Docker-image tag. Filter, optional.

batchSettings

BatchSettings

Batch settings for processing events.

invokeFunction

InvokeFunctionWithRetry

Instructions for invoking a function with retries as needed.

Includes only one of the fields invokeFunction, invokeContainer, gatewayWebsocketBroadcast.

invokeContainer

InvokeContainerWithRetry

Instructions for invoking a container with retries as needed.

Includes only one of the fields invokeFunction, invokeContainer, gatewayWebsocketBroadcast.

gatewayWebsocketBroadcast

GatewayWebsocketBroadcast

Instructions for broadcasting to API gateway websocket once.

Includes only one of the fields invokeFunction, invokeContainer, gatewayWebsocketBroadcast.

Field

Description

logGroupId[]

string

Log group identifiers, at least one value is required.

batchSettings

CloudLogsBatchSettings

Required field. Batch settings for processing log events.

invokeFunction

InvokeFunctionWithRetry

Instructions for invoking a function with retries as needed.

Includes only one of the fields invokeFunction, invokeContainer.

invokeContainer

InvokeContainerWithRetry

Instructions for invoking a container with retries as needed.

Includes only one of the fields invokeFunction, invokeContainer.

Field

Description

size

string (int64)

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.

cutoff

string (duration)

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.

Field

Description

logGroupId

string

Log events filter settings.

The maximum string length in characters is 50.

resourceType[]

string

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

resourceId[]

string

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

streamName[]

string

Each value must match the regular expression \|[a-z][-a-z0-9]{1,61}[a-z0-9]. The maximum number of elements is 100.

levels[]

enum (Level)

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.

batchSettings

LoggingBatchSettings

Required field. Batch settings for processing log events.

invokeFunction

InvokeFunctionWithRetry

Instructions for invoking a function with retries as needed.

Includes only one of the fields invokeFunction, invokeContainer, gatewayWebsocketBroadcast.

invokeContainer

InvokeContainerWithRetry

Instructions for invoking a container with retries as needed.

Includes only one of the fields invokeFunction, invokeContainer, gatewayWebsocketBroadcast.

gatewayWebsocketBroadcast

GatewayWebsocketBroadcast

Instructions for broadcasting to API gateway websocket once.

Includes only one of the fields invokeFunction, invokeContainer, gatewayWebsocketBroadcast.

Field

Description

size

string (int64)

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 1000, inclusive.

cutoff

string (duration)

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.

Field

Description

billingAccountId

string

Required field.

The maximum string length in characters is 50.

budgetId

string

The maximum string length in characters is 50.

invokeFunction

InvokeFunctionWithRetry

Includes only one of the fields invokeFunction, invokeContainer, gatewayWebsocketBroadcast.

invokeContainer

InvokeContainerWithRetry

Includes only one of the fields invokeFunction, invokeContainer, gatewayWebsocketBroadcast.

gatewayWebsocketBroadcast

GatewayWebsocketBroadcast

Includes only one of the fields invokeFunction, invokeContainer, gatewayWebsocketBroadcast.

Field

Description

endpoint

string

Data stream endpoint.

database

string

Data stream database.

stream

string

Stream name.

serviceAccountId

string

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

batchSettings

DataStreamBatchSettings

Batch settings for processing events.

invokeFunction

InvokeFunctionWithRetry

Includes only one of the fields invokeFunction, invokeContainer, gatewayWebsocketBroadcast.

invokeContainer

InvokeContainerWithRetry

Includes only one of the fields invokeFunction, invokeContainer, gatewayWebsocketBroadcast.

gatewayWebsocketBroadcast

GatewayWebsocketBroadcast

Includes only one of the fields invokeFunction, invokeContainer, gatewayWebsocketBroadcast.

Field

Description

size

string (int64)

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.

cutoff

string (duration)

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.

Field

Description

email

string

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

batchSettings

BatchSettings

Batch settings for processing events.

attachmentsBucket

ObjectStorageBucketSettings

Bucket settings for saving attachments.

invokeFunction

InvokeFunctionWithRetry

Includes only one of the fields invokeFunction, invokeContainer, gatewayWebsocketBroadcast.

invokeContainer

InvokeContainerWithRetry

Includes only one of the fields invokeFunction, invokeContainer, gatewayWebsocketBroadcast.

gatewayWebsocketBroadcast

GatewayWebsocketBroadcast

Includes only one of the fields invokeFunction, invokeContainer, gatewayWebsocketBroadcast.

Field

Description

bucketId

string

Bucket for saving.

The string length in characters must be 3-63. Value must match the regular expression [-.0-9a-zA-Z]*.

serviceAccountId

string

Required field. SA which has write permission on storage.

The maximum string length in characters is 50.

Field

Description

id

string

ID of the operation.

description

string

Description of the operation. 0-256 characters long.

createdAt

string (date-time)

Creation timestamp.

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).

createdBy

string

ID of the user or service account who initiated the operation.

modifiedAt

string (date-time)

The time when the Operation resource was last modified.

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).

done

boolean

If the value is false, it means the operation is still in progress.
If true, the operation is completed, and either error or response is available.

metadata

UpdateTriggerMetadata

Service-specific metadata associated with the operation.
It typically contains the ID of the target resource that the operation is performed on.
Any method that returns a long-running operation should document the metadata type, if any.

error

Status

The error result of the operation in case of failure or cancellation.

Includes only one of the fields error, response.

The operation result.
If done == false and there was no failure detected, neither error nor response is set.
If done == false and there was a failure detected, error is set.
If done == true, exactly one of error or response is set.

response

Trigger

The normal response of the operation in case of success.
If the original method returns no data on success, such as Delete,
the response is google.protobuf.Empty.
If the original method is the standard Create/Update,
the response should be the target resource of the operation.
Any method that returns a long-running operation should document the response type, if any.

Includes only one of the fields error, response.

The operation result.
If done == false and there was no failure detected, neither error nor response is set.
If done == false and there was a failure detected, error is set.
If done == true, exactly one of error or response is set.

Field

Description

triggerId

string

Required field. ID of the trigger that is being updated.

Field

Description

code

integer (int32)

Error code. An enum value of google.rpc.Code.

message

string

An error message.

details[]

object

A list of messages that carry the error details.

Field

Description

id

string

ID of the trigger. Generated at creation time.

folderId

string

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

The maximum string length in characters is 50.

createdAt

string (date-time)

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

string

Name of the trigger.

The string length in characters must be 3-63.

description

string

Description of the trigger.

The string length in characters must be 0-256.

labels

object (map<string, string>)

Trigger labels as key:value pairs.

rule

Rule

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

status

enum (Status)

Trigger status.

• ACTIVE
• PAUSED

Field

Description

timer

Timer

Rule for a timed trigger.

Includes only one of the fields timer, messageQueue, iotMessage, iotBrokerMessage, objectStorage, containerRegistry, cloudLogs, logging, billingBudget, dataStream, mail.

messageQueue

MessageQueue

Rule for a message queue trigger.

Includes only one of the fields timer, messageQueue, iotMessage, iotBrokerMessage, objectStorage, containerRegistry, cloudLogs, logging, billingBudget, dataStream, mail.

iotMessage

IoTMessage

Rule for a IoT Core trigger.

Includes only one of the fields timer, messageQueue, iotMessage, iotBrokerMessage, objectStorage, containerRegistry, cloudLogs, logging, billingBudget, dataStream, mail.

iotBrokerMessage

IoTBrokerMessage

Includes only one of the fields timer, messageQueue, iotMessage, iotBrokerMessage, objectStorage, containerRegistry, cloudLogs, logging, billingBudget, dataStream, mail.

objectStorage

ObjectStorage

Includes only one of the fields timer, messageQueue, iotMessage, iotBrokerMessage, objectStorage, containerRegistry, cloudLogs, logging, billingBudget, dataStream, mail.

containerRegistry

ContainerRegistry

Includes only one of the fields timer, messageQueue, iotMessage, iotBrokerMessage, objectStorage, containerRegistry, cloudLogs, logging, billingBudget, dataStream, mail.

cloudLogs

CloudLogs

Includes only one of the fields timer, messageQueue, iotMessage, iotBrokerMessage, objectStorage, containerRegistry, cloudLogs, logging, billingBudget, dataStream, mail.

logging

Logging

Includes only one of the fields timer, messageQueue, iotMessage, iotBrokerMessage, objectStorage, containerRegistry, cloudLogs, logging, billingBudget, dataStream, mail.

billingBudget

BillingBudget

Includes only one of the fields timer, messageQueue, iotMessage, iotBrokerMessage, objectStorage, containerRegistry, cloudLogs, logging, billingBudget, dataStream, mail.

dataStream

DataStream

Includes only one of the fields timer, messageQueue, iotMessage, iotBrokerMessage, objectStorage, containerRegistry, cloudLogs, logging, billingBudget, dataStream, mail.

mail

Mail

Includes only one of the fields timer, messageQueue, iotMessage, iotBrokerMessage, objectStorage, containerRegistry, cloudLogs, logging, billingBudget, dataStream, mail.

Field

Description

cronExpression

string

Required field. Description of a schedule as a cron expression.

The maximum string length in characters is 100.

payload

string

Payload to be passed to function.

The maximum string length in characters is 4096.

invokeFunction

InvokeFunctionOnce

Instructions for invoking a function once.

Includes only one of the fields invokeFunction, invokeFunctionWithRetry, invokeContainerWithRetry, gatewayWebsocketBroadcast.

Action to be executed when the current time matches the cronExpression.

invokeFunctionWithRetry

InvokeFunctionWithRetry

Instructions for invoking a function with retry.

Includes only one of the fields invokeFunction, invokeFunctionWithRetry, invokeContainerWithRetry, gatewayWebsocketBroadcast.

Action to be executed when the current time matches the cronExpression.

invokeContainerWithRetry

InvokeContainerWithRetry

Instructions for invoking a container with retry.

Includes only one of the fields invokeFunction, invokeFunctionWithRetry, invokeContainerWithRetry, gatewayWebsocketBroadcast.

Action to be executed when the current time matches the cronExpression.

gatewayWebsocketBroadcast

GatewayWebsocketBroadcast

Instructions for broadcasting to API gateway websocket once.

Includes only one of the fields invokeFunction, invokeFunctionWithRetry, invokeContainerWithRetry, gatewayWebsocketBroadcast.

Action to be executed when the current time matches the cronExpression.

Field

Description

functionId

string

Required field. ID of the function to invoke.

The maximum string length in characters is 50.

functionTag

string

Version tag of the function to execute.

serviceAccountId

string

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

Field

Description

functionId

string

Required field. ID of the function to invoke.

The maximum string length in characters is 50.

functionTag

string

Version tag of the function to execute.

serviceAccountId

string

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

retrySettings

RetrySettings

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

deadLetterQueue

PutQueueMessage

DLQ policy (no value means discarding a message).

Field

Description

retryAttempts

string (int64)

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

Acceptable values are 1 to 5, inclusive.

interval

string (duration)

Required field. Time in seconds to wait between individual retries.

Field

Description

queueId

string

ID of the queue.

serviceAccountId

string

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

The maximum string length in characters is 50.

Field

Description

containerId

string

Required field. ID of the container to invoke.

The maximum string length in characters is 50.

path

string

Endpoint HTTP path to invoke.

serviceAccountId

string

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

retrySettings

RetrySettings

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

deadLetterQueue

PutQueueMessage

DLQ policy (no value means discarding a message).

Field

Description

gatewayId

string

Required field.

The maximum string length in characters is 50.

path

string

Required field.

serviceAccountId

string

Required field. sa which has permission for writing to websockets

The maximum string length in characters is 50.

Field

Description

queueId

string

Required field. ID of the message queue in Message Queue.

serviceAccountId

string

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

The maximum string length in characters is 50.

batchSettings

BatchSettings

Required field. Batch settings for processing messages in the queue.

visibilityTimeout

string (duration)

Queue visibility timeout override.

invokeFunction

InvokeFunctionOnce

Instructions for invoking a function once.

Includes only one of the fields invokeFunction, invokeContainer, gatewayWebsocketBroadcast.

Action to be executed when the there's a new message in the queue.

invokeContainer

InvokeContainerOnce

Instructions for invoking a container once.

Includes only one of the fields invokeFunction, invokeContainer, gatewayWebsocketBroadcast.

Action to be executed when the there's a new message in the queue.

gatewayWebsocketBroadcast

GatewayWebsocketBroadcast

Instructions for broadcasting to API gateway websocket once.

Includes only one of the fields invokeFunction, invokeContainer, gatewayWebsocketBroadcast.

Action to be executed when the there's a new message in the queue.

Field

Description

size

string (int64)

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 1000, inclusive.

cutoff

string (duration)

Required field. 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.

Field

Description

containerId

string

Required field. ID of the container to invoke.

The maximum string length in characters is 50.

path

string

Endpoint HTTP path to invoke.

serviceAccountId

string

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

Field

Description

registryId

string

Required field. ID of the IoT Core registry.

deviceId

string

ID of the IoT Core device in the registry.

mqttTopic

string

MQTT topic whose messages activate the trigger.

batchSettings

BatchSettings

Batch settings for processing events.

invokeFunction

InvokeFunctionWithRetry

Instructions for invoking a function with retries as needed.

Includes only one of the fields invokeFunction, invokeContainer, gatewayWebsocketBroadcast.

Action to be executed when the there's a new message in the MQTT topic.

invokeContainer

InvokeContainerWithRetry

Instructions for invoking a container with retries as needed.

Includes only one of the fields invokeFunction, invokeContainer, gatewayWebsocketBroadcast.

Action to be executed when the there's a new message in the MQTT topic.

gatewayWebsocketBroadcast

GatewayWebsocketBroadcast

Instructions for broadcasting to API gateway websocket once.

Includes only one of the fields invokeFunction, invokeContainer, gatewayWebsocketBroadcast.

Action to be executed when the there's a new message in the MQTT topic.

Field

Description

brokerId

string

Required field. ID of the IoT Core broker.

mqttTopic

string

MQTT topic whose messages activate the trigger.

batchSettings

BatchSettings

Batch settings for processing events.

invokeFunction

InvokeFunctionWithRetry

Instructions for invoking a function with retries as needed.

Includes only one of the fields invokeFunction, invokeContainer, gatewayWebsocketBroadcast.

Action to be executed when the there's a new message in the MQTT topic.

invokeContainer

InvokeContainerWithRetry

Instructions for invoking a container with retries as needed.

Includes only one of the fields invokeFunction, invokeContainer, gatewayWebsocketBroadcast.

Action to be executed when the there's a new message in the MQTT topic.

gatewayWebsocketBroadcast

GatewayWebsocketBroadcast

Instructions for broadcasting to API gateway websocket once.

Includes only one of the fields invokeFunction, invokeContainer, gatewayWebsocketBroadcast.

Action to be executed when the there's a new message in the MQTT topic.

Field

Description

eventType[]

enum (ObjectStorageEventType)

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

The number of elements must be greater than 0.

• OBJECT_STORAGE_EVENT_TYPE_CREATE_OBJECT
• OBJECT_STORAGE_EVENT_TYPE_UPDATE_OBJECT
• OBJECT_STORAGE_EVENT_TYPE_DELETE_OBJECT

bucketId

string

ID of the bucket.

prefix

string

Prefix of the object key. Filter, optional.

suffix

string

Suffix of the object key. Filter, optional.

batchSettings

BatchSettings

Batch settings for processing events.

invokeFunction

InvokeFunctionWithRetry

Instructions for invoking a function with retries as needed.

Includes only one of the fields invokeFunction, invokeContainer, gatewayWebsocketBroadcast.

invokeContainer

InvokeContainerWithRetry

Instructions for invoking a container with retries as needed.

Includes only one of the fields invokeFunction, invokeContainer, gatewayWebsocketBroadcast.

gatewayWebsocketBroadcast

GatewayWebsocketBroadcast

Instructions for broadcasting to API gateway websocket once.

Includes only one of the fields invokeFunction, invokeContainer, gatewayWebsocketBroadcast.

Field

Description

eventType[]

enum (ContainerRegistryEventType)

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

The number of elements must be greater than 0.

• CONTAINER_REGISTRY_EVENT_TYPE_CREATE_IMAGE
• CONTAINER_REGISTRY_EVENT_TYPE_DELETE_IMAGE
• CONTAINER_REGISTRY_EVENT_TYPE_CREATE_IMAGE_TAG
• CONTAINER_REGISTRY_EVENT_TYPE_DELETE_IMAGE_TAG

registryId

string

ID of the registry.

imageName

string

Docker-image name. Filter, optional.

tag

string

Docker-image tag. Filter, optional.

batchSettings

BatchSettings

Batch settings for processing events.

invokeFunction

InvokeFunctionWithRetry

Instructions for invoking a function with retries as needed.

Includes only one of the fields invokeFunction, invokeContainer, gatewayWebsocketBroadcast.

invokeContainer

InvokeContainerWithRetry

Instructions for invoking a container with retries as needed.

Includes only one of the fields invokeFunction, invokeContainer, gatewayWebsocketBroadcast.

gatewayWebsocketBroadcast

GatewayWebsocketBroadcast

Instructions for broadcasting to API gateway websocket once.

Includes only one of the fields invokeFunction, invokeContainer, gatewayWebsocketBroadcast.

Field

Description

logGroupId[]

string

Log group identifiers, at least one value is required.

batchSettings

CloudLogsBatchSettings

Required field. Batch settings for processing log events.

invokeFunction

InvokeFunctionWithRetry

Instructions for invoking a function with retries as needed.

Includes only one of the fields invokeFunction, invokeContainer.

invokeContainer

InvokeContainerWithRetry

Instructions for invoking a container with retries as needed.

Includes only one of the fields invokeFunction, invokeContainer.

Field

Description

size

string (int64)

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.

cutoff

string (duration)

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.

Field

Description

logGroupId

string

Log events filter settings.

The maximum string length in characters is 50.

resourceType[]

string

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

resourceId[]

string

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

streamName[]

string

Each value must match the regular expression \|[a-z][-a-z0-9]{1,61}[a-z0-9]. The maximum number of elements is 100.

levels[]

enum (Level)

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.

batchSettings

LoggingBatchSettings

Required field. Batch settings for processing log events.

invokeFunction

InvokeFunctionWithRetry

Instructions for invoking a function with retries as needed.

Includes only one of the fields invokeFunction, invokeContainer, gatewayWebsocketBroadcast.

invokeContainer

InvokeContainerWithRetry

Instructions for invoking a container with retries as needed.

Includes only one of the fields invokeFunction, invokeContainer, gatewayWebsocketBroadcast.

gatewayWebsocketBroadcast

GatewayWebsocketBroadcast

Instructions for broadcasting to API gateway websocket once.

Includes only one of the fields invokeFunction, invokeContainer, gatewayWebsocketBroadcast.

Field

Description

size

string (int64)

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 1000, inclusive.

cutoff

string (duration)

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.

Field

Description

billingAccountId

string

Required field.

The maximum string length in characters is 50.

budgetId

string

The maximum string length in characters is 50.

invokeFunction

InvokeFunctionWithRetry

Includes only one of the fields invokeFunction, invokeContainer, gatewayWebsocketBroadcast.

invokeContainer

InvokeContainerWithRetry

Includes only one of the fields invokeFunction, invokeContainer, gatewayWebsocketBroadcast.

gatewayWebsocketBroadcast

GatewayWebsocketBroadcast

Includes only one of the fields invokeFunction, invokeContainer, gatewayWebsocketBroadcast.

Field

Description

endpoint

string

Data stream endpoint.

database

string

Data stream database.

stream

string

Stream name.

serviceAccountId

string

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

batchSettings

DataStreamBatchSettings

Batch settings for processing events.

invokeFunction

InvokeFunctionWithRetry

Includes only one of the fields invokeFunction, invokeContainer, gatewayWebsocketBroadcast.

invokeContainer

InvokeContainerWithRetry

Includes only one of the fields invokeFunction, invokeContainer, gatewayWebsocketBroadcast.

gatewayWebsocketBroadcast

GatewayWebsocketBroadcast

Includes only one of the fields invokeFunction, invokeContainer, gatewayWebsocketBroadcast.

Field

Description

size

string (int64)

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.

cutoff

string (duration)

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.

Field

Description

email

string

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

batchSettings

BatchSettings

Batch settings for processing events.

attachmentsBucket

ObjectStorageBucketSettings

Bucket settings for saving attachments.

invokeFunction

InvokeFunctionWithRetry

Includes only one of the fields invokeFunction, invokeContainer, gatewayWebsocketBroadcast.

invokeContainer

InvokeContainerWithRetry

Includes only one of the fields invokeFunction, invokeContainer, gatewayWebsocketBroadcast.

gatewayWebsocketBroadcast

GatewayWebsocketBroadcast

Includes only one of the fields invokeFunction, invokeContainer, gatewayWebsocketBroadcast.

Field

Description

bucketId

string

Bucket for saving.

The string length in characters must be 3-63. Value must match the regular expression [-.0-9a-zA-Z]*.

serviceAccountId

string

Required field. SA which has write permission on storage.

The maximum string length in characters is 50.