Cloud Functions Triggers Service, REST: Trigger.update
Updates the specified trigger.
HTTP request
PATCH https://serverless-triggers.api.cloud.yandex.net/triggers/v1/triggers/{triggerId}
Path parameters
Parameter | Description |
---|---|
triggerId | Required. ID of the trigger to update. To get a trigger ID make a list request. |
Body parameters
{
"updateMask": "string",
"name": "string",
"description": "string",
"labels": "object",
"rule": {
// `rule` includes only one of the fields `timer`, `messageQueue`, `iotMessage`, `iotBrokerMessage`, `objectStorage`, `containerRegistry`, `cloudLogs`, `logging`, `billingBudget`, `dataStream`, `mail`
"timer": {
"cronExpression": "string",
"payload": "string",
// `rule.timer` includes only one of the fields `invokeFunction`, `invokeFunctionWithRetry`, `invokeContainerWithRetry`, `gatewayWebsocketBroadcast`
"invokeFunction": {
"functionId": "string",
"functionTag": "string",
"serviceAccountId": "string"
},
"invokeFunctionWithRetry": {
"functionId": "string",
"functionTag": "string",
"serviceAccountId": "string",
"retrySettings": {
"retryAttempts": "string",
"interval": "string"
},
"deadLetterQueue": {
"queueId": "string",
"serviceAccountId": "string"
}
},
"invokeContainerWithRetry": {
"containerId": "string",
"path": "string",
"serviceAccountId": "string",
"retrySettings": {
"retryAttempts": "string",
"interval": "string"
},
"deadLetterQueue": {
"queueId": "string",
"serviceAccountId": "string"
}
},
"gatewayWebsocketBroadcast": {
"gatewayId": "string",
"path": "string",
"serviceAccountId": "string"
},
// end of the list of possible fields`rule.timer`
},
"messageQueue": {
"queueId": "string",
"serviceAccountId": "string",
"batchSettings": {
"size": "string",
"cutoff": "string"
},
"visibilityTimeout": "string",
// `rule.messageQueue` includes only one of the fields `invokeFunction`, `invokeContainer`, `gatewayWebsocketBroadcast`
"invokeFunction": {
"functionId": "string",
"functionTag": "string",
"serviceAccountId": "string"
},
"invokeContainer": {
"containerId": "string",
"path": "string",
"serviceAccountId": "string"
},
"gatewayWebsocketBroadcast": {
"gatewayId": "string",
"path": "string",
"serviceAccountId": "string"
},
// end of the list of possible fields`rule.messageQueue`
},
"iotMessage": {
"registryId": "string",
"deviceId": "string",
"mqttTopic": "string",
"batchSettings": {
"size": "string",
"cutoff": "string"
},
// `rule.iotMessage` includes only one of the fields `invokeFunction`, `invokeContainer`, `gatewayWebsocketBroadcast`
"invokeFunction": {
"functionId": "string",
"functionTag": "string",
"serviceAccountId": "string",
"retrySettings": {
"retryAttempts": "string",
"interval": "string"
},
"deadLetterQueue": {
"queueId": "string",
"serviceAccountId": "string"
}
},
"invokeContainer": {
"containerId": "string",
"path": "string",
"serviceAccountId": "string",
"retrySettings": {
"retryAttempts": "string",
"interval": "string"
},
"deadLetterQueue": {
"queueId": "string",
"serviceAccountId": "string"
}
},
"gatewayWebsocketBroadcast": {
"gatewayId": "string",
"path": "string",
"serviceAccountId": "string"
},
// end of the list of possible fields`rule.iotMessage`
},
"iotBrokerMessage": {
"brokerId": "string",
"mqttTopic": "string",
"batchSettings": {
"size": "string",
"cutoff": "string"
},
// `rule.iotBrokerMessage` includes only one of the fields `invokeFunction`, `invokeContainer`, `gatewayWebsocketBroadcast`
"invokeFunction": {
"functionId": "string",
"functionTag": "string",
"serviceAccountId": "string",
"retrySettings": {
"retryAttempts": "string",
"interval": "string"
},
"deadLetterQueue": {
"queueId": "string",
"serviceAccountId": "string"
}
},
"invokeContainer": {
"containerId": "string",
"path": "string",
"serviceAccountId": "string",
"retrySettings": {
"retryAttempts": "string",
"interval": "string"
},
"deadLetterQueue": {
"queueId": "string",
"serviceAccountId": "string"
}
},
"gatewayWebsocketBroadcast": {
"gatewayId": "string",
"path": "string",
"serviceAccountId": "string"
},
// end of the list of possible fields`rule.iotBrokerMessage`
},
"objectStorage": {
"eventType": [
"string"
],
"bucketId": "string",
"prefix": "string",
"suffix": "string",
"batchSettings": {
"size": "string",
"cutoff": "string"
},
// `rule.objectStorage` includes only one of the fields `invokeFunction`, `invokeContainer`, `gatewayWebsocketBroadcast`
"invokeFunction": {
"functionId": "string",
"functionTag": "string",
"serviceAccountId": "string",
"retrySettings": {
"retryAttempts": "string",
"interval": "string"
},
"deadLetterQueue": {
"queueId": "string",
"serviceAccountId": "string"
}
},
"invokeContainer": {
"containerId": "string",
"path": "string",
"serviceAccountId": "string",
"retrySettings": {
"retryAttempts": "string",
"interval": "string"
},
"deadLetterQueue": {
"queueId": "string",
"serviceAccountId": "string"
}
},
"gatewayWebsocketBroadcast": {
"gatewayId": "string",
"path": "string",
"serviceAccountId": "string"
},
// end of the list of possible fields`rule.objectStorage`
},
"containerRegistry": {
"eventType": [
"string"
],
"registryId": "string",
"imageName": "string",
"tag": "string",
"batchSettings": {
"size": "string",
"cutoff": "string"
},
// `rule.containerRegistry` includes only one of the fields `invokeFunction`, `invokeContainer`, `gatewayWebsocketBroadcast`
"invokeFunction": {
"functionId": "string",
"functionTag": "string",
"serviceAccountId": "string",
"retrySettings": {
"retryAttempts": "string",
"interval": "string"
},
"deadLetterQueue": {
"queueId": "string",
"serviceAccountId": "string"
}
},
"invokeContainer": {
"containerId": "string",
"path": "string",
"serviceAccountId": "string",
"retrySettings": {
"retryAttempts": "string",
"interval": "string"
},
"deadLetterQueue": {
"queueId": "string",
"serviceAccountId": "string"
}
},
"gatewayWebsocketBroadcast": {
"gatewayId": "string",
"path": "string",
"serviceAccountId": "string"
},
// end of the list of possible fields`rule.containerRegistry`
},
"cloudLogs": {
"logGroupId": [
"string"
],
"batchSettings": {
"size": "string",
"cutoff": "string"
},
// `rule.cloudLogs` includes only one of the fields `invokeFunction`, `invokeContainer`
"invokeFunction": {
"functionId": "string",
"functionTag": "string",
"serviceAccountId": "string",
"retrySettings": {
"retryAttempts": "string",
"interval": "string"
},
"deadLetterQueue": {
"queueId": "string",
"serviceAccountId": "string"
}
},
"invokeContainer": {
"containerId": "string",
"path": "string",
"serviceAccountId": "string",
"retrySettings": {
"retryAttempts": "string",
"interval": "string"
},
"deadLetterQueue": {
"queueId": "string",
"serviceAccountId": "string"
}
},
// end of the list of possible fields`rule.cloudLogs`
},
"logging": {
"logGroupId": "string",
"resourceType": [
"string"
],
"resourceId": [
"string"
],
"streamName": [
"string"
],
"levels": [
"string"
],
"batchSettings": {
"size": "string",
"cutoff": "string"
},
// `rule.logging` includes only one of the fields `invokeFunction`, `invokeContainer`, `gatewayWebsocketBroadcast`
"invokeFunction": {
"functionId": "string",
"functionTag": "string",
"serviceAccountId": "string",
"retrySettings": {
"retryAttempts": "string",
"interval": "string"
},
"deadLetterQueue": {
"queueId": "string",
"serviceAccountId": "string"
}
},
"invokeContainer": {
"containerId": "string",
"path": "string",
"serviceAccountId": "string",
"retrySettings": {
"retryAttempts": "string",
"interval": "string"
},
"deadLetterQueue": {
"queueId": "string",
"serviceAccountId": "string"
}
},
"gatewayWebsocketBroadcast": {
"gatewayId": "string",
"path": "string",
"serviceAccountId": "string"
},
// end of the list of possible fields`rule.logging`
},
"billingBudget": {
"billingAccountId": "string",
"budgetId": "string",
// `rule.billingBudget` includes only one of the fields `invokeFunction`, `invokeContainer`, `gatewayWebsocketBroadcast`
"invokeFunction": {
"functionId": "string",
"functionTag": "string",
"serviceAccountId": "string",
"retrySettings": {
"retryAttempts": "string",
"interval": "string"
},
"deadLetterQueue": {
"queueId": "string",
"serviceAccountId": "string"
}
},
"invokeContainer": {
"containerId": "string",
"path": "string",
"serviceAccountId": "string",
"retrySettings": {
"retryAttempts": "string",
"interval": "string"
},
"deadLetterQueue": {
"queueId": "string",
"serviceAccountId": "string"
}
},
"gatewayWebsocketBroadcast": {
"gatewayId": "string",
"path": "string",
"serviceAccountId": "string"
},
// end of the list of possible fields`rule.billingBudget`
},
"dataStream": {
"endpoint": "string",
"database": "string",
"stream": "string",
"serviceAccountId": "string",
"batchSettings": {
"size": "string",
"cutoff": "string"
},
// `rule.dataStream` includes only one of the fields `invokeFunction`, `invokeContainer`, `gatewayWebsocketBroadcast`
"invokeFunction": {
"functionId": "string",
"functionTag": "string",
"serviceAccountId": "string",
"retrySettings": {
"retryAttempts": "string",
"interval": "string"
},
"deadLetterQueue": {
"queueId": "string",
"serviceAccountId": "string"
}
},
"invokeContainer": {
"containerId": "string",
"path": "string",
"serviceAccountId": "string",
"retrySettings": {
"retryAttempts": "string",
"interval": "string"
},
"deadLetterQueue": {
"queueId": "string",
"serviceAccountId": "string"
}
},
"gatewayWebsocketBroadcast": {
"gatewayId": "string",
"path": "string",
"serviceAccountId": "string"
},
// end of the list of possible fields`rule.dataStream`
},
"mail": {
"email": "string",
"batchSettings": {
"size": "string",
"cutoff": "string"
},
"attachmentsBucket": {
"bucketId": "string",
"serviceAccountId": "string"
},
// `rule.mail` includes only one of the fields `invokeFunction`, `invokeContainer`, `gatewayWebsocketBroadcast`
"invokeFunction": {
"functionId": "string",
"functionTag": "string",
"serviceAccountId": "string",
"retrySettings": {
"retryAttempts": "string",
"interval": "string"
},
"deadLetterQueue": {
"queueId": "string",
"serviceAccountId": "string"
}
},
"invokeContainer": {
"containerId": "string",
"path": "string",
"serviceAccountId": "string",
"retrySettings": {
"retryAttempts": "string",
"interval": "string"
},
"deadLetterQueue": {
"queueId": "string",
"serviceAccountId": "string"
}
},
"gatewayWebsocketBroadcast": {
"gatewayId": "string",
"path": "string",
"serviceAccountId": "string"
},
// end of the list of possible fields`rule.mail`
},
// end of the list of possible fields`rule`
}
}
Field | Description |
---|---|
updateMask | string Field mask that specifies which attributes of the trigger should be updated. 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 If |
name | string New name for the trigger. The name must be unique within the folder. Value must match the regular expression |
description | string New description of the trigger. The maximum string length in characters is 256. |
labels | object Trigger labels as 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 get request. No more than 64 per resource. The string length in characters for each key must be 1-63. Each key must match the regular expression |
rule | object New parameters for trigger. Description of a rule for trigger activation. |
rule. timer |
object Rule for a timed trigger. rule includes only one of the fields timer , messageQueue , iotMessage , iotBrokerMessage , objectStorage , containerRegistry , cloudLogs , logging , billingBudget , dataStream , mail |
rule. timer. cronExpression |
string Required. Description of a schedule as a cron expression. The maximum string length in characters is 100. |
rule. timer. payload |
string Payload to be passed to function. The maximum string length in characters is 4096. |
rule. timer. invokeFunction |
object Instructions for invoking a function once. rule.timer includes only one of the fields invokeFunction , invokeFunctionWithRetry , invokeContainerWithRetry , gatewayWebsocketBroadcast |
rule. timer. invokeFunction. functionId |
string Required. ID of the function to invoke. The maximum string length in characters is 50. |
rule. timer. invokeFunction. functionTag |
string Version tag of the function to execute. |
rule. timer. invokeFunction. serviceAccountId |
string ID of the service account that should be used to invoke the function. |
rule. timer. invokeFunctionWithRetry |
object Instructions for invoking a function with retry. rule.timer includes only one of the fields invokeFunction , invokeFunctionWithRetry , invokeContainerWithRetry , gatewayWebsocketBroadcast |
rule. timer. invokeFunctionWithRetry. functionId |
string Required. ID of the function to invoke. The maximum string length in characters is 50. |
rule. timer. invokeFunctionWithRetry. functionTag |
string Version tag of the function to execute. |
rule. timer. invokeFunctionWithRetry. serviceAccountId |
string ID of the service account which has permission to invoke the function. |
rule. timer. invokeFunctionWithRetry. retrySettings |
object 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. |
rule. timer. invokeFunctionWithRetry. retrySettings. retryAttempts |
string (int64) Maximum number of retries (extra invokes) before the action is considered failed. Acceptable values are 1 to 5, inclusive. |
rule. timer. invokeFunctionWithRetry. retrySettings. interval |
string Required. Time in seconds to wait between individual retries. Acceptable values are 10 seconds to 60 seconds, inclusive. |
rule. timer. invokeFunctionWithRetry. deadLetterQueue |
object DLQ policy (no value means discarding a message). |
rule. timer. invokeFunctionWithRetry. deadLetterQueue. queueId |
string ID of the queue. |
rule. timer. invokeFunctionWithRetry. deadLetterQueue. serviceAccountId |
string Required. Service account which has write permission on the queue. The maximum string length in characters is 50. |
rule. timer. invokeContainerWithRetry |
object Instructions for invoking a container with retry. rule.timer includes only one of the fields invokeFunction , invokeFunctionWithRetry , invokeContainerWithRetry , gatewayWebsocketBroadcast |
rule. timer. invokeContainerWithRetry. containerId |
string Required. ID of the container to invoke. The maximum string length in characters is 50. |
rule. timer. invokeContainerWithRetry. path |
string Endpoint HTTP path to invoke. |
rule. timer. invokeContainerWithRetry. serviceAccountId |
string ID of the service account which has permission to invoke the container. |
rule. timer. invokeContainerWithRetry. retrySettings |
object 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. |
rule. timer. invokeContainerWithRetry. retrySettings. retryAttempts |
string (int64) Maximum number of retries (extra invokes) before the action is considered failed. Acceptable values are 1 to 5, inclusive. |
rule. timer. invokeContainerWithRetry. retrySettings. interval |
string Required. Time in seconds to wait between individual retries. Acceptable values are 10 seconds to 60 seconds, inclusive. |
rule. timer. invokeContainerWithRetry. deadLetterQueue |
object DLQ policy (no value means discarding a message). |
rule. timer. invokeContainerWithRetry. deadLetterQueue. queueId |
string ID of the queue. |
rule. timer. invokeContainerWithRetry. deadLetterQueue. serviceAccountId |
string Required. Service account which has write permission on the queue. The maximum string length in characters is 50. |
rule. timer. gatewayWebsocketBroadcast |
object Instructions for broadcasting to API gateway websocket once. rule.timer includes only one of the fields invokeFunction , invokeFunctionWithRetry , invokeContainerWithRetry , gatewayWebsocketBroadcast |
rule. timer. gatewayWebsocketBroadcast. gatewayId |
string Required. The maximum string length in characters is 50. |
rule. timer. gatewayWebsocketBroadcast. path |
string Required. |
rule. timer. gatewayWebsocketBroadcast. serviceAccountId |
string Required. sa which has permission for writing to websockets The maximum string length in characters is 50. |
rule. messageQueue |
object Rule for a message queue trigger. rule includes only one of the fields timer , messageQueue , iotMessage , iotBrokerMessage , objectStorage , containerRegistry , cloudLogs , logging , billingBudget , dataStream , mail |
rule. messageQueue. queueId |
string Required. ID of the message queue in Message Queue. |
rule. messageQueue. serviceAccountId |
string Required. ID of the service account which has read access to the message queue. The maximum string length in characters is 50. |
rule. messageQueue. batchSettings |
object Required. Batch settings for processing messages in the queue. |
rule. messageQueue. batchSettings. size |
string (int64) Batch size. Trigger will send the batch of messages to the function when the number of messages in the queue reaches Acceptable values are 0 to 1000, inclusive. |
rule. messageQueue. batchSettings. cutoff |
string Required. Maximum wait time. Trigger will send the batch of messages to the function when the number of messages in the queue reaches |
rule. messageQueue. visibilityTimeout |
string Queue visibility timeout override. The maximum value is 43200 seconds. |
rule. messageQueue. invokeFunction |
object Instructions for invoking a function once. rule.messageQueue includes only one of the fields invokeFunction , invokeContainer , gatewayWebsocketBroadcast |
rule. messageQueue. invokeFunction. functionId |
string Required. ID of the function to invoke. The maximum string length in characters is 50. |
rule. messageQueue. invokeFunction. functionTag |
string Version tag of the function to execute. |
rule. messageQueue. invokeFunction. serviceAccountId |
string ID of the service account that should be used to invoke the function. |
rule. messageQueue. invokeContainer |
object Instructions for invoking a container once. rule.messageQueue includes only one of the fields invokeFunction , invokeContainer , gatewayWebsocketBroadcast |
rule. messageQueue. invokeContainer. containerId |
string Required. ID of the container to invoke. The maximum string length in characters is 50. |
rule. messageQueue. invokeContainer. path |
string Endpoint HTTP path to invoke. |
rule. messageQueue. invokeContainer. serviceAccountId |
string ID of the service account which has permission to invoke the container. |
rule. messageQueue. gatewayWebsocketBroadcast |
object Instructions for broadcasting to API gateway websocket once. rule.messageQueue includes only one of the fields invokeFunction , invokeContainer , gatewayWebsocketBroadcast |
rule. messageQueue. gatewayWebsocketBroadcast. gatewayId |
string Required. The maximum string length in characters is 50. |
rule. messageQueue. gatewayWebsocketBroadcast. path |
string Required. |
rule. messageQueue. gatewayWebsocketBroadcast. serviceAccountId |
string Required. sa which has permission for writing to websockets The maximum string length in characters is 50. |
rule. iotMessage |
object Rule for a IoT Core trigger. rule includes only one of the fields timer , messageQueue , iotMessage , iotBrokerMessage , objectStorage , containerRegistry , cloudLogs , logging , billingBudget , dataStream , mail |
rule. iotMessage. registryId |
string Required. ID of the IoT Core registry. |
rule. iotMessage. deviceId |
string ID of the IoT Core device in the registry. |
rule. iotMessage. mqttTopic |
string MQTT topic whose messages activate the trigger. |
rule. iotMessage. batchSettings |
object Batch settings for processing events. |
rule. iotMessage. batchSettings. size |
string (int64) Batch size. Trigger will send the batch of messages to the function when the number of messages in the queue reaches Acceptable values are 0 to 1000, inclusive. |
rule. iotMessage. batchSettings. cutoff |
string Required. Maximum wait time. Trigger will send the batch of messages to the function when the number of messages in the queue reaches |
rule. iotMessage. invokeFunction |
object Instructions for invoking a function with retries as needed. rule.iotMessage includes only one of the fields invokeFunction , invokeContainer , gatewayWebsocketBroadcast |
rule. iotMessage. invokeFunction. functionId |
string Required. ID of the function to invoke. The maximum string length in characters is 50. |
rule. iotMessage. invokeFunction. functionTag |
string Version tag of the function to execute. |
rule. iotMessage. invokeFunction. serviceAccountId |
string ID of the service account which has permission to invoke the function. |
rule. iotMessage. invokeFunction. retrySettings |
object 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. |
rule. iotMessage. invokeFunction. retrySettings. retryAttempts |
string (int64) Maximum number of retries (extra invokes) before the action is considered failed. Acceptable values are 1 to 5, inclusive. |
rule. iotMessage. invokeFunction. retrySettings. interval |
string Required. Time in seconds to wait between individual retries. Acceptable values are 10 seconds to 60 seconds, inclusive. |
rule. iotMessage. invokeFunction. deadLetterQueue |
object DLQ policy (no value means discarding a message). |
rule. iotMessage. invokeFunction. deadLetterQueue. queueId |
string ID of the queue. |
rule. iotMessage. invokeFunction. deadLetterQueue. serviceAccountId |
string Required. Service account which has write permission on the queue. The maximum string length in characters is 50. |
rule. iotMessage. invokeContainer |
object Instructions for invoking a container with retries as needed. rule.iotMessage includes only one of the fields invokeFunction , invokeContainer , gatewayWebsocketBroadcast |
rule. iotMessage. invokeContainer. containerId |
string Required. ID of the container to invoke. The maximum string length in characters is 50. |
rule. iotMessage. invokeContainer. path |
string Endpoint HTTP path to invoke. |
rule. iotMessage. invokeContainer. serviceAccountId |
string ID of the service account which has permission to invoke the container. |
rule. iotMessage. invokeContainer. retrySettings |
object 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. |
rule. iotMessage. invokeContainer. retrySettings. retryAttempts |
string (int64) Maximum number of retries (extra invokes) before the action is considered failed. Acceptable values are 1 to 5, inclusive. |
rule. iotMessage. invokeContainer. retrySettings. interval |
string Required. Time in seconds to wait between individual retries. Acceptable values are 10 seconds to 60 seconds, inclusive. |
rule. iotMessage. invokeContainer. deadLetterQueue |
object DLQ policy (no value means discarding a message). |
rule. iotMessage. invokeContainer. deadLetterQueue. queueId |
string ID of the queue. |
rule. iotMessage. invokeContainer. deadLetterQueue. serviceAccountId |
string Required. Service account which has write permission on the queue. The maximum string length in characters is 50. |
rule. iotMessage. gatewayWebsocketBroadcast |
object Instructions for broadcasting to API gateway websocket once. rule.iotMessage includes only one of the fields invokeFunction , invokeContainer , gatewayWebsocketBroadcast |
rule. iotMessage. gatewayWebsocketBroadcast. gatewayId |
string Required. The maximum string length in characters is 50. |
rule. iotMessage. gatewayWebsocketBroadcast. path |
string Required. |
rule. iotMessage. gatewayWebsocketBroadcast. serviceAccountId |
string Required. sa which has permission for writing to websockets The maximum string length in characters is 50. |
rule. iotBrokerMessage |
object rule includes only one of the fields timer , messageQueue , iotMessage , iotBrokerMessage , objectStorage , containerRegistry , cloudLogs , logging , billingBudget , dataStream , mail Rule for activating a IoT Core Broker trigger. |
rule. iotBrokerMessage. brokerId |
string Required. ID of the IoT Core broker. |
rule. iotBrokerMessage. mqttTopic |
string MQTT topic whose messages activate the trigger. |
rule. iotBrokerMessage. batchSettings |
object Batch settings for processing events. |
rule. iotBrokerMessage. batchSettings. size |
string (int64) Batch size. Trigger will send the batch of messages to the function when the number of messages in the queue reaches Acceptable values are 0 to 1000, inclusive. |
rule. iotBrokerMessage. batchSettings. cutoff |
string Required. Maximum wait time. Trigger will send the batch of messages to the function when the number of messages in the queue reaches |
rule. iotBrokerMessage. invokeFunction |
object Instructions for invoking a function with retries as needed. rule.iotBrokerMessage includes only one of the fields invokeFunction , invokeContainer , gatewayWebsocketBroadcast |
rule. iotBrokerMessage. invokeFunction. functionId |
string Required. ID of the function to invoke. The maximum string length in characters is 50. |
rule. iotBrokerMessage. invokeFunction. functionTag |
string Version tag of the function to execute. |
rule. iotBrokerMessage. invokeFunction. serviceAccountId |
string ID of the service account which has permission to invoke the function. |
rule. iotBrokerMessage. invokeFunction. retrySettings |
object 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. |
rule. iotBrokerMessage. invokeFunction. retrySettings. retryAttempts |
string (int64) Maximum number of retries (extra invokes) before the action is considered failed. Acceptable values are 1 to 5, inclusive. |
rule. iotBrokerMessage. invokeFunction. retrySettings. interval |
string Required. Time in seconds to wait between individual retries. Acceptable values are 10 seconds to 60 seconds, inclusive. |
rule. iotBrokerMessage. invokeFunction. deadLetterQueue |
object DLQ policy (no value means discarding a message). |
rule. iotBrokerMessage. invokeFunction. deadLetterQueue. queueId |
string ID of the queue. |
rule. iotBrokerMessage. invokeFunction. deadLetterQueue. serviceAccountId |
string Required. Service account which has write permission on the queue. The maximum string length in characters is 50. |
rule. iotBrokerMessage. invokeContainer |
object Instructions for invoking a container with retries as needed. rule.iotBrokerMessage includes only one of the fields invokeFunction , invokeContainer , gatewayWebsocketBroadcast |
rule. iotBrokerMessage. invokeContainer. containerId |
string Required. ID of the container to invoke. The maximum string length in characters is 50. |
rule. iotBrokerMessage. invokeContainer. path |
string Endpoint HTTP path to invoke. |
rule. iotBrokerMessage. invokeContainer. serviceAccountId |
string ID of the service account which has permission to invoke the container. |
rule. iotBrokerMessage. invokeContainer. retrySettings |
object 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. |
rule. iotBrokerMessage. invokeContainer. retrySettings. retryAttempts |
string (int64) Maximum number of retries (extra invokes) before the action is considered failed. Acceptable values are 1 to 5, inclusive. |
rule. iotBrokerMessage. invokeContainer. retrySettings. interval |
string Required. Time in seconds to wait between individual retries. Acceptable values are 10 seconds to 60 seconds, inclusive. |
rule. iotBrokerMessage. invokeContainer. deadLetterQueue |
object DLQ policy (no value means discarding a message). |
rule. iotBrokerMessage. invokeContainer. deadLetterQueue. queueId |
string ID of the queue. |
rule. iotBrokerMessage. invokeContainer. deadLetterQueue. serviceAccountId |
string Required. Service account which has write permission on the queue. The maximum string length in characters is 50. |
rule. iotBrokerMessage. gatewayWebsocketBroadcast |
object Instructions for broadcasting to API gateway websocket once. rule.iotBrokerMessage includes only one of the fields invokeFunction , invokeContainer , gatewayWebsocketBroadcast |
rule. iotBrokerMessage. gatewayWebsocketBroadcast. gatewayId |
string Required. The maximum string length in characters is 50. |
rule. iotBrokerMessage. gatewayWebsocketBroadcast. path |
string Required. |
rule. iotBrokerMessage. gatewayWebsocketBroadcast. serviceAccountId |
string Required. sa which has permission for writing to websockets The maximum string length in characters is 50. |
rule. objectStorage |
object rule includes only one of the fields timer , messageQueue , iotMessage , iotBrokerMessage , objectStorage , containerRegistry , cloudLogs , logging , billingBudget , dataStream , mail |
rule. objectStorage. eventType[] |
string Required. Type (name) of events, at least one value is required. Must contain at least one element. |
rule. objectStorage. bucketId |
string ID of the bucket. |
rule. objectStorage. prefix |
string Prefix of the object key. Filter, optional. |
rule. objectStorage. suffix |
string Suffix of the object key. Filter, optional. |
rule. objectStorage. batchSettings |
object Batch settings for processing events. |
rule. objectStorage. batchSettings. size |
string (int64) Batch size. Trigger will send the batch of messages to the function when the number of messages in the queue reaches Acceptable values are 0 to 1000, inclusive. |
rule. objectStorage. batchSettings. cutoff |
string Required. Maximum wait time. Trigger will send the batch of messages to the function when the number of messages in the queue reaches |
rule. objectStorage. invokeFunction |
object Instructions for invoking a function with retries as needed. rule.objectStorage includes only one of the fields invokeFunction , invokeContainer , gatewayWebsocketBroadcast |
rule. objectStorage. invokeFunction. functionId |
string Required. ID of the function to invoke. The maximum string length in characters is 50. |
rule. objectStorage. invokeFunction. functionTag |
string Version tag of the function to execute. |
rule. objectStorage. invokeFunction. serviceAccountId |
string ID of the service account which has permission to invoke the function. |
rule. objectStorage. invokeFunction. retrySettings |
object 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. |
rule. objectStorage. invokeFunction. retrySettings. retryAttempts |
string (int64) Maximum number of retries (extra invokes) before the action is considered failed. Acceptable values are 1 to 5, inclusive. |
rule. objectStorage. invokeFunction. retrySettings. interval |
string Required. Time in seconds to wait between individual retries. Acceptable values are 10 seconds to 60 seconds, inclusive. |
rule. objectStorage. invokeFunction. deadLetterQueue |
object DLQ policy (no value means discarding a message). |
rule. objectStorage. invokeFunction. deadLetterQueue. queueId |
string ID of the queue. |
rule. objectStorage. invokeFunction. deadLetterQueue. serviceAccountId |
string Required. Service account which has write permission on the queue. The maximum string length in characters is 50. |
rule. objectStorage. invokeContainer |
object Instructions for invoking a container with retries as needed. rule.objectStorage includes only one of the fields invokeFunction , invokeContainer , gatewayWebsocketBroadcast |
rule. objectStorage. invokeContainer. containerId |
string Required. ID of the container to invoke. The maximum string length in characters is 50. |
rule. objectStorage. invokeContainer. path |
string Endpoint HTTP path to invoke. |
rule. objectStorage. invokeContainer. serviceAccountId |
string ID of the service account which has permission to invoke the container. |
rule. objectStorage. invokeContainer. retrySettings |
object 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. |
rule. objectStorage. invokeContainer. retrySettings. retryAttempts |
string (int64) Maximum number of retries (extra invokes) before the action is considered failed. Acceptable values are 1 to 5, inclusive. |
rule. objectStorage. invokeContainer. retrySettings. interval |
string Required. Time in seconds to wait between individual retries. Acceptable values are 10 seconds to 60 seconds, inclusive. |
rule. objectStorage. invokeContainer. deadLetterQueue |
object DLQ policy (no value means discarding a message). |
rule. objectStorage. invokeContainer. deadLetterQueue. queueId |
string ID of the queue. |
rule. objectStorage. invokeContainer. deadLetterQueue. serviceAccountId |
string Required. Service account which has write permission on the queue. The maximum string length in characters is 50. |
rule. objectStorage. gatewayWebsocketBroadcast |
object Instructions for broadcasting to API gateway websocket once. rule.objectStorage includes only one of the fields invokeFunction , invokeContainer , gatewayWebsocketBroadcast |
rule. objectStorage. gatewayWebsocketBroadcast. gatewayId |
string Required. The maximum string length in characters is 50. |
rule. objectStorage. gatewayWebsocketBroadcast. path |
string Required. |
rule. objectStorage. gatewayWebsocketBroadcast. serviceAccountId |
string Required. sa which has permission for writing to websockets The maximum string length in characters is 50. |
rule. containerRegistry |
object rule includes only one of the fields timer , messageQueue , iotMessage , iotBrokerMessage , objectStorage , containerRegistry , cloudLogs , logging , billingBudget , dataStream , mail |
rule. containerRegistry. eventType[] |
string Required. Type (name) of events, at least one value is required. Must contain at least one element. |
rule. containerRegistry. registryId |
string ID of the registry. |
rule. containerRegistry. imageName |
string Docker-image name. Filter, optional. |
rule. containerRegistry. tag |
string Docker-image tag. Filter, optional. |
rule. containerRegistry. batchSettings |
object Batch settings for processing events. |
rule. containerRegistry. batchSettings. size |
string (int64) Batch size. Trigger will send the batch of messages to the function when the number of messages in the queue reaches Acceptable values are 0 to 1000, inclusive. |
rule. containerRegistry. batchSettings. cutoff |
string Required. Maximum wait time. Trigger will send the batch of messages to the function when the number of messages in the queue reaches |
rule. containerRegistry. invokeFunction |
object Instructions for invoking a function with retries as needed. rule.containerRegistry includes only one of the fields invokeFunction , invokeContainer , gatewayWebsocketBroadcast |
rule. containerRegistry. invokeFunction. functionId |
string Required. ID of the function to invoke. The maximum string length in characters is 50. |
rule. containerRegistry. invokeFunction. functionTag |
string Version tag of the function to execute. |
rule. containerRegistry. invokeFunction. serviceAccountId |
string ID of the service account which has permission to invoke the function. |
rule. containerRegistry. invokeFunction. retrySettings |
object 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. |
rule. containerRegistry. invokeFunction. retrySettings. retryAttempts |
string (int64) Maximum number of retries (extra invokes) before the action is considered failed. Acceptable values are 1 to 5, inclusive. |
rule. containerRegistry. invokeFunction. retrySettings. interval |
string Required. Time in seconds to wait between individual retries. Acceptable values are 10 seconds to 60 seconds, inclusive. |
rule. containerRegistry. invokeFunction. deadLetterQueue |
object DLQ policy (no value means discarding a message). |
rule. containerRegistry. invokeFunction. deadLetterQueue. queueId |
string ID of the queue. |
rule. containerRegistry. invokeFunction. deadLetterQueue. serviceAccountId |
string Required. Service account which has write permission on the queue. The maximum string length in characters is 50. |
rule. containerRegistry. invokeContainer |
object Instructions for invoking a container with retries as needed. rule.containerRegistry includes only one of the fields invokeFunction , invokeContainer , gatewayWebsocketBroadcast |
rule. containerRegistry. invokeContainer. containerId |
string Required. ID of the container to invoke. The maximum string length in characters is 50. |
rule. containerRegistry. invokeContainer. path |
string Endpoint HTTP path to invoke. |
rule. containerRegistry. invokeContainer. serviceAccountId |
string ID of the service account which has permission to invoke the container. |
rule. containerRegistry. invokeContainer. retrySettings |
object 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. |
rule. containerRegistry. invokeContainer. retrySettings. retryAttempts |
string (int64) Maximum number of retries (extra invokes) before the action is considered failed. Acceptable values are 1 to 5, inclusive. |
rule. containerRegistry. invokeContainer. retrySettings. interval |
string Required. Time in seconds to wait between individual retries. Acceptable values are 10 seconds to 60 seconds, inclusive. |
rule. containerRegistry. invokeContainer. deadLetterQueue |
object DLQ policy (no value means discarding a message). |
rule. containerRegistry. invokeContainer. deadLetterQueue. queueId |
string ID of the queue. |
rule. containerRegistry. invokeContainer. deadLetterQueue. serviceAccountId |
string Required. Service account which has write permission on the queue. The maximum string length in characters is 50. |
rule. containerRegistry. gatewayWebsocketBroadcast |
object Instructions for broadcasting to API gateway websocket once. rule.containerRegistry includes only one of the fields invokeFunction , invokeContainer , gatewayWebsocketBroadcast |
rule. containerRegistry. gatewayWebsocketBroadcast. gatewayId |
string Required. The maximum string length in characters is 50. |
rule. containerRegistry. gatewayWebsocketBroadcast. path |
string Required. |
rule. containerRegistry. gatewayWebsocketBroadcast. serviceAccountId |
string Required. sa which has permission for writing to websockets The maximum string length in characters is 50. |
rule. cloudLogs |
object rule includes only one of the fields timer , messageQueue , iotMessage , iotBrokerMessage , objectStorage , containerRegistry , cloudLogs , logging , billingBudget , dataStream , mail |
rule. cloudLogs. logGroupId[] |
string Log group identifiers, at least one value is required. |
rule. cloudLogs. batchSettings |
object Required. Batch settings for processing log events. |
rule. cloudLogs. batchSettings. 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 Acceptable values are 0 to 100, inclusive. |
rule. cloudLogs. batchSettings. cutoff |
string Maximum wait time. Trigger will send the batch of messages to the function when the number of messages in the log group reaches Acceptable values are 1 seconds to 60 seconds, inclusive. |
rule. cloudLogs. invokeFunction |
object Instructions for invoking a function with retries as needed. rule.cloudLogs includes only one of the fields invokeFunction , invokeContainer |
rule. cloudLogs. invokeFunction. functionId |
string Required. ID of the function to invoke. The maximum string length in characters is 50. |
rule. cloudLogs. invokeFunction. functionTag |
string Version tag of the function to execute. |
rule. cloudLogs. invokeFunction. serviceAccountId |
string ID of the service account which has permission to invoke the function. |
rule. cloudLogs. invokeFunction. retrySettings |
object 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. |
rule. cloudLogs. invokeFunction. retrySettings. retryAttempts |
string (int64) Maximum number of retries (extra invokes) before the action is considered failed. Acceptable values are 1 to 5, inclusive. |
rule. cloudLogs. invokeFunction. retrySettings. interval |
string Required. Time in seconds to wait between individual retries. Acceptable values are 10 seconds to 60 seconds, inclusive. |
rule. cloudLogs. invokeFunction. deadLetterQueue |
object DLQ policy (no value means discarding a message). |
rule. cloudLogs. invokeFunction. deadLetterQueue. queueId |
string ID of the queue. |
rule. cloudLogs. invokeFunction. deadLetterQueue. serviceAccountId |
string Required. Service account which has write permission on the queue. The maximum string length in characters is 50. |
rule. cloudLogs. invokeContainer |
object Instructions for invoking a container with retries as needed. rule.cloudLogs includes only one of the fields invokeFunction , invokeContainer |
rule. cloudLogs. invokeContainer. containerId |
string Required. ID of the container to invoke. The maximum string length in characters is 50. |
rule. cloudLogs. invokeContainer. path |
string Endpoint HTTP path to invoke. |
rule. cloudLogs. invokeContainer. serviceAccountId |
string ID of the service account which has permission to invoke the container. |
rule. cloudLogs. invokeContainer. retrySettings |
object 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. |
rule. cloudLogs. invokeContainer. retrySettings. retryAttempts |
string (int64) Maximum number of retries (extra invokes) before the action is considered failed. Acceptable values are 1 to 5, inclusive. |
rule. cloudLogs. invokeContainer. retrySettings. interval |
string Required. Time in seconds to wait between individual retries. Acceptable values are 10 seconds to 60 seconds, inclusive. |
rule. cloudLogs. invokeContainer. deadLetterQueue |
object DLQ policy (no value means discarding a message). |
rule. cloudLogs. invokeContainer. deadLetterQueue. queueId |
string ID of the queue. |
rule. cloudLogs. invokeContainer. deadLetterQueue. serviceAccountId |
string Required. Service account which has write permission on the queue. The maximum string length in characters is 50. |
rule. logging |
object rule includes only one of the fields timer , messageQueue , iotMessage , iotBrokerMessage , objectStorage , containerRegistry , cloudLogs , logging , billingBudget , dataStream , mail |
rule. logging. logGroupId |
string Log events filter settings. The maximum string length in characters is 50. |
rule. logging. resourceType[] |
string The maximum number of elements is 100. Each value must match the regular expression |
rule. logging. resourceId[] |
string The maximum number of elements is 100. Each value must match the regular expression |
rule. logging. streamName[] |
string The maximum number of elements is 100. Each value must match the regular expression |
rule. logging. levels[] |
string The maximum number of elements is 10.
|
rule. logging. batchSettings |
object Required. Batch settings for processing log events. |
rule. logging. batchSettings. 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 Acceptable values are 1 to 1000, inclusive. |
rule. logging. batchSettings. cutoff |
string Maximum wait time. Trigger will send the batch of messages the time since the last batch exceeds the Acceptable values are 1 seconds to 60 seconds, inclusive. |
rule. logging. invokeFunction |
object Instructions for invoking a function with retries as needed. rule.logging includes only one of the fields invokeFunction , invokeContainer , gatewayWebsocketBroadcast |
rule. logging. invokeFunction. functionId |
string Required. ID of the function to invoke. The maximum string length in characters is 50. |
rule. logging. invokeFunction. functionTag |
string Version tag of the function to execute. |
rule. logging. invokeFunction. serviceAccountId |
string ID of the service account which has permission to invoke the function. |
rule. logging. invokeFunction. retrySettings |
object 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. |
rule. logging. invokeFunction. retrySettings. retryAttempts |
string (int64) Maximum number of retries (extra invokes) before the action is considered failed. Acceptable values are 1 to 5, inclusive. |
rule. logging. invokeFunction. retrySettings. interval |
string Required. Time in seconds to wait between individual retries. Acceptable values are 10 seconds to 60 seconds, inclusive. |
rule. logging. invokeFunction. deadLetterQueue |
object DLQ policy (no value means discarding a message). |
rule. logging. invokeFunction. deadLetterQueue. queueId |
string ID of the queue. |
rule. logging. invokeFunction. deadLetterQueue. serviceAccountId |
string Required. Service account which has write permission on the queue. The maximum string length in characters is 50. |
rule. logging. invokeContainer |
object Instructions for invoking a container with retries as needed. rule.logging includes only one of the fields invokeFunction , invokeContainer , gatewayWebsocketBroadcast |
rule. logging. invokeContainer. containerId |
string Required. ID of the container to invoke. The maximum string length in characters is 50. |
rule. logging. invokeContainer. path |
string Endpoint HTTP path to invoke. |
rule. logging. invokeContainer. serviceAccountId |
string ID of the service account which has permission to invoke the container. |
rule. logging. invokeContainer. retrySettings |
object 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. |
rule. logging. invokeContainer. retrySettings. retryAttempts |
string (int64) Maximum number of retries (extra invokes) before the action is considered failed. Acceptable values are 1 to 5, inclusive. |
rule. logging. invokeContainer. retrySettings. interval |
string Required. Time in seconds to wait between individual retries. Acceptable values are 10 seconds to 60 seconds, inclusive. |
rule. logging. invokeContainer. deadLetterQueue |
object DLQ policy (no value means discarding a message). |
rule. logging. invokeContainer. deadLetterQueue. queueId |
string ID of the queue. |
rule. logging. invokeContainer. deadLetterQueue. serviceAccountId |
string Required. Service account which has write permission on the queue. The maximum string length in characters is 50. |
rule. logging. gatewayWebsocketBroadcast |
object Instructions for broadcasting to API gateway websocket once. rule.logging includes only one of the fields invokeFunction , invokeContainer , gatewayWebsocketBroadcast |
rule. logging. gatewayWebsocketBroadcast. gatewayId |
string Required. The maximum string length in characters is 50. |
rule. logging. gatewayWebsocketBroadcast. path |
string Required. |
rule. logging. gatewayWebsocketBroadcast. serviceAccountId |
string Required. sa which has permission for writing to websockets The maximum string length in characters is 50. |
rule. billingBudget |
object rule includes only one of the fields timer , messageQueue , iotMessage , iotBrokerMessage , objectStorage , containerRegistry , cloudLogs , logging , billingBudget , dataStream , mail |
rule. billingBudget. billingAccountId |
string Required. The maximum string length in characters is 50. |
rule. billingBudget. budgetId |
string The maximum string length in characters is 50. |
rule. billingBudget. invokeFunction |
object Instructions for invoking a function with retries as needed. rule.billingBudget includes only one of the fields invokeFunction , invokeContainer , gatewayWebsocketBroadcast |
rule. billingBudget. invokeFunction. functionId |
string Required. ID of the function to invoke. The maximum string length in characters is 50. |
rule. billingBudget. invokeFunction. functionTag |
string Version tag of the function to execute. |
rule. billingBudget. invokeFunction. serviceAccountId |
string ID of the service account which has permission to invoke the function. |
rule. billingBudget. invokeFunction. retrySettings |
object 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. |
rule. billingBudget. invokeFunction. retrySettings. retryAttempts |
string (int64) Maximum number of retries (extra invokes) before the action is considered failed. Acceptable values are 1 to 5, inclusive. |
rule. billingBudget. invokeFunction. retrySettings. interval |
string Required. Time in seconds to wait between individual retries. Acceptable values are 10 seconds to 60 seconds, inclusive. |
rule. billingBudget. invokeFunction. deadLetterQueue |
object DLQ policy (no value means discarding a message). |
rule. billingBudget. invokeFunction. deadLetterQueue. queueId |
string ID of the queue. |
rule. billingBudget. invokeFunction. deadLetterQueue. serviceAccountId |
string Required. Service account which has write permission on the queue. The maximum string length in characters is 50. |
rule. billingBudget. invokeContainer |
object Instructions for invoking a container with retries as needed. rule.billingBudget includes only one of the fields invokeFunction , invokeContainer , gatewayWebsocketBroadcast |
rule. billingBudget. invokeContainer. containerId |
string Required. ID of the container to invoke. The maximum string length in characters is 50. |
rule. billingBudget. invokeContainer. path |
string Endpoint HTTP path to invoke. |
rule. billingBudget. invokeContainer. serviceAccountId |
string ID of the service account which has permission to invoke the container. |
rule. billingBudget. invokeContainer. retrySettings |
object 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. |
rule. billingBudget. invokeContainer. retrySettings. retryAttempts |
string (int64) Maximum number of retries (extra invokes) before the action is considered failed. Acceptable values are 1 to 5, inclusive. |
rule. billingBudget. invokeContainer. retrySettings. interval |
string Required. Time in seconds to wait between individual retries. Acceptable values are 10 seconds to 60 seconds, inclusive. |
rule. billingBudget. invokeContainer. deadLetterQueue |
object DLQ policy (no value means discarding a message). |
rule. billingBudget. invokeContainer. deadLetterQueue. queueId |
string ID of the queue. |
rule. billingBudget. invokeContainer. deadLetterQueue. serviceAccountId |
string Required. Service account which has write permission on the queue. The maximum string length in characters is 50. |
rule. billingBudget. gatewayWebsocketBroadcast |
object Instructions for broadcasting to API gateway websocket once. rule.billingBudget includes only one of the fields invokeFunction , invokeContainer , gatewayWebsocketBroadcast |
rule. billingBudget. gatewayWebsocketBroadcast. gatewayId |
string Required. The maximum string length in characters is 50. |
rule. billingBudget. gatewayWebsocketBroadcast. path |
string Required. |
rule. billingBudget. gatewayWebsocketBroadcast. serviceAccountId |
string Required. sa which has permission for writing to websockets The maximum string length in characters is 50. |
rule. dataStream |
object rule includes only one of the fields timer , messageQueue , iotMessage , iotBrokerMessage , objectStorage , containerRegistry , cloudLogs , logging , billingBudget , dataStream , mail |
rule. dataStream. endpoint |
string Data stream endpoint. |
rule. dataStream. database |
string Data stream database. |
rule. dataStream. stream |
string Stream name. |
rule. dataStream. serviceAccountId |
string ID of the service account which has permission to read data stream. |
rule. dataStream. batchSettings |
object Batch settings for processing events. |
rule. dataStream. batchSettings. 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 Acceptable values are 1 to 65536, inclusive. |
rule. dataStream. batchSettings. cutoff |
string Maximum wait time. Trigger will send the batch of messages the time since the last batch exceeds the Acceptable values are 1 seconds to 60 seconds, inclusive. |
rule. dataStream. invokeFunction |
object Instructions for invoking a function with retries as needed. rule.dataStream includes only one of the fields invokeFunction , invokeContainer , gatewayWebsocketBroadcast |
rule. dataStream. invokeFunction. functionId |
string Required. ID of the function to invoke. The maximum string length in characters is 50. |
rule. dataStream. invokeFunction. functionTag |
string Version tag of the function to execute. |
rule. dataStream. invokeFunction. serviceAccountId |
string ID of the service account which has permission to invoke the function. |
rule. dataStream. invokeFunction. retrySettings |
object 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. |
rule. dataStream. invokeFunction. retrySettings. retryAttempts |
string (int64) Maximum number of retries (extra invokes) before the action is considered failed. Acceptable values are 1 to 5, inclusive. |
rule. dataStream. invokeFunction. retrySettings. interval |
string Required. Time in seconds to wait between individual retries. Acceptable values are 10 seconds to 60 seconds, inclusive. |
rule. dataStream. invokeFunction. deadLetterQueue |
object DLQ policy (no value means discarding a message). |
rule. dataStream. invokeFunction. deadLetterQueue. queueId |
string ID of the queue. |
rule. dataStream. invokeFunction. deadLetterQueue. serviceAccountId |
string Required. Service account which has write permission on the queue. The maximum string length in characters is 50. |
rule. dataStream. invokeContainer |
object Instructions for invoking a container with retries as needed. rule.dataStream includes only one of the fields invokeFunction , invokeContainer , gatewayWebsocketBroadcast |
rule. dataStream. invokeContainer. containerId |
string Required. ID of the container to invoke. The maximum string length in characters is 50. |
rule. dataStream. invokeContainer. path |
string Endpoint HTTP path to invoke. |
rule. dataStream. invokeContainer. serviceAccountId |
string ID of the service account which has permission to invoke the container. |
rule. dataStream. invokeContainer. retrySettings |
object 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. |
rule. dataStream. invokeContainer. retrySettings. retryAttempts |
string (int64) Maximum number of retries (extra invokes) before the action is considered failed. Acceptable values are 1 to 5, inclusive. |
rule. dataStream. invokeContainer. retrySettings. interval |
string Required. Time in seconds to wait between individual retries. Acceptable values are 10 seconds to 60 seconds, inclusive. |
rule. dataStream. invokeContainer. deadLetterQueue |
object DLQ policy (no value means discarding a message). |
rule. dataStream. invokeContainer. deadLetterQueue. queueId |
string ID of the queue. |
rule. dataStream. invokeContainer. deadLetterQueue. serviceAccountId |
string Required. Service account which has write permission on the queue. The maximum string length in characters is 50. |
rule. dataStream. gatewayWebsocketBroadcast |
object Instructions for broadcasting to API gateway websocket once. rule.dataStream includes only one of the fields invokeFunction , invokeContainer , gatewayWebsocketBroadcast |
rule. dataStream. gatewayWebsocketBroadcast. gatewayId |
string Required. The maximum string length in characters is 50. |
rule. dataStream. gatewayWebsocketBroadcast. path |
string Required. |
rule. dataStream. gatewayWebsocketBroadcast. serviceAccountId |
string Required. sa which has permission for writing to websockets The maximum string length in characters is 50. |
rule. |
object rule includes only one of the fields timer , messageQueue , iotMessage , iotBrokerMessage , objectStorage , containerRegistry , cloudLogs , logging , billingBudget , dataStream , mail |
rule. mail. |
string Address to receive emails for trigger activation. Field is ignored for write requests and populated on trigger creation. |
rule. mail. batchSettings |
object Batch settings for processing events. |
rule. mail. batchSettings. size |
string (int64) Batch size. Trigger will send the batch of messages to the function when the number of messages in the queue reaches Acceptable values are 0 to 1000, inclusive. |
rule. mail. batchSettings. cutoff |
string Required. Maximum wait time. Trigger will send the batch of messages to the function when the number of messages in the queue reaches |
rule. mail. attachmentsBucket |
object Bucket settings for saving attachments. |
rule. mail. attachmentsBucket. bucketId |
string Bucket for saving. The string length in characters must be 3-63. Value must match the regular expression |
rule. mail. attachmentsBucket. serviceAccountId |
string Required. SA which has write permission on storage. The maximum string length in characters is 50. |
rule. mail. invokeFunction |
object Instructions for invoking a function with retries as needed. rule.mail includes only one of the fields invokeFunction , invokeContainer , gatewayWebsocketBroadcast |
rule. mail. invokeFunction. functionId |
string Required. ID of the function to invoke. The maximum string length in characters is 50. |
rule. mail. invokeFunction. functionTag |
string Version tag of the function to execute. |
rule. mail. invokeFunction. serviceAccountId |
string ID of the service account which has permission to invoke the function. |
rule. mail. invokeFunction. retrySettings |
object 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. |
rule. mail. invokeFunction. retrySettings. retryAttempts |
string (int64) Maximum number of retries (extra invokes) before the action is considered failed. Acceptable values are 1 to 5, inclusive. |
rule. mail. invokeFunction. retrySettings. interval |
string Required. Time in seconds to wait between individual retries. Acceptable values are 10 seconds to 60 seconds, inclusive. |
rule. mail. invokeFunction. deadLetterQueue |
object DLQ policy (no value means discarding a message). |
rule. mail. invokeFunction. deadLetterQueue. queueId |
string ID of the queue. |
rule. mail. invokeFunction. deadLetterQueue. serviceAccountId |
string Required. Service account which has write permission on the queue. The maximum string length in characters is 50. |
rule. mail. invokeContainer |
object Instructions for invoking a container with retries as needed. rule.mail includes only one of the fields invokeFunction , invokeContainer , gatewayWebsocketBroadcast |
rule. mail. invokeContainer. containerId |
string Required. ID of the container to invoke. The maximum string length in characters is 50. |
rule. mail. invokeContainer. path |
string Endpoint HTTP path to invoke. |
rule. mail. invokeContainer. serviceAccountId |
string ID of the service account which has permission to invoke the container. |
rule. mail. invokeContainer. retrySettings |
object 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. |
rule. mail. invokeContainer. retrySettings. retryAttempts |
string (int64) Maximum number of retries (extra invokes) before the action is considered failed. Acceptable values are 1 to 5, inclusive. |
rule. mail. invokeContainer. retrySettings. interval |
string Required. Time in seconds to wait between individual retries. Acceptable values are 10 seconds to 60 seconds, inclusive. |
rule. mail. invokeContainer. deadLetterQueue |
object DLQ policy (no value means discarding a message). |
rule. mail. invokeContainer. deadLetterQueue. queueId |
string ID of the queue. |
rule. mail. invokeContainer. deadLetterQueue. serviceAccountId |
string Required. Service account which has write permission on the queue. The maximum string length in characters is 50. |
rule. mail. gatewayWebsocketBroadcast |
object Instructions for broadcasting to API gateway websocket once. rule.mail includes only one of the fields invokeFunction , invokeContainer , gatewayWebsocketBroadcast |
rule. mail. gatewayWebsocketBroadcast. gatewayId |
string Required. The maximum string length in characters is 50. |
rule. mail. gatewayWebsocketBroadcast. path |
string Required. |
rule. mail. gatewayWebsocketBroadcast. serviceAccountId |
string Required. sa which has permission for writing to websockets The maximum string length in characters is 50. |
Response
HTTP Code: 200 - OK
{
"id": "string",
"description": "string",
"createdAt": "string",
"createdBy": "string",
"modifiedAt": "string",
"done": true,
"metadata": "object",
// includes only one of the fields `error`, `response`
"error": {
"code": "integer",
"message": "string",
"details": [
"object"
]
},
"response": "object",
// end of the list of possible fields
}
An Operation resource. For more information, see Operation.
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 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 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 (boolean) If the value is |
metadata | object 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 | object The error result of the operation in case of failure or cancellation. includes only one of the fields error , response |
error. code |
integer (int32) Error code. An enum value of google.rpc.Code. |
error. message |
string An error message. |
error. details[] |
object A list of messages that carry the error details. |
response | object includes only one of the fields error , response 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. |