Trigger
A set of methods for managing triggers for serverless functions.
JSON Representation
{
"id": "string",
"folderId": "string",
"createdAt": "string",
"name": "string",
"description": "string",
"labels": "object",
"rule": {
// `rule` includes only one of the fields `timer`, `messageQueue`, `iotMessage`, `objectStorage`, `containerRegistry`, `cloudLogs`
"timer": {
"cronExpression": "string",
// `rule.timer` includes only one of the fields `invokeFunction`, `invokeFunctionWithRetry`
"invokeFunction": {
"functionId": "string",
"functionTag": "string",
"serviceAccountId": "string"
},
"invokeFunctionWithRetry": {
"functionId": "string",
"functionTag": "string",
"serviceAccountId": "string",
"retrySettings": {
"retryAttempts": "string",
"interval": "string"
},
"deadLetterQueue": {
"queueId": "string",
"serviceAccountId": "string"
}
},
// end of the list of possible fields`rule.timer`
},
"messageQueue": {
"queueId": "string",
"serviceAccountId": "string",
"batchSettings": {
"size": "string",
"cutoff": "string"
},
"visibilityTimeout": "string",
"invokeFunction": {
"functionId": "string",
"functionTag": "string",
"serviceAccountId": "string"
}
},
"iotMessage": {
"registryId": "string",
"deviceId": "string",
"mqttTopic": "string",
"invokeFunction": {
"functionId": "string",
"functionTag": "string",
"serviceAccountId": "string",
"retrySettings": {
"retryAttempts": "string",
"interval": "string"
},
"deadLetterQueue": {
"queueId": "string",
"serviceAccountId": "string"
}
}
},
"objectStorage": {
"eventType": [
"string"
],
"bucketId": "string",
"prefix": "string",
"suffix": "string",
"invokeFunction": {
"functionId": "string",
"functionTag": "string",
"serviceAccountId": "string",
"retrySettings": {
"retryAttempts": "string",
"interval": "string"
},
"deadLetterQueue": {
"queueId": "string",
"serviceAccountId": "string"
}
}
},
"containerRegistry": {
"eventType": [
"string"
],
"registryId": "string",
"imageName": "string",
"tag": "string",
"invokeFunction": {
"functionId": "string",
"functionTag": "string",
"serviceAccountId": "string",
"retrySettings": {
"retryAttempts": "string",
"interval": "string"
},
"deadLetterQueue": {
"queueId": "string",
"serviceAccountId": "string"
}
}
},
"cloudLogs": {
"logGroupId": [
"string"
],
"batchSettings": {
"size": "string",
"cutoff": "string"
},
"invokeFunction": {
"functionId": "string",
"functionTag": "string",
"serviceAccountId": "string",
"retrySettings": {
"retryAttempts": "string",
"interval": "string"
},
"deadLetterQueue": {
"queueId": "string",
"serviceAccountId": "string"
}
}
},
// end of the list of possible fields`rule`
},
"status": "string"
}
Field | Description |
---|---|
id | string ID of the trigger. Generated at creation time. |
folderId | string Required. 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. |
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 Trigger labels as |
rule | object Required. Rule for trigger activation (always consistent with the trigger type). Description of a rule for trigger activation. |
rule. timer |
object rule includes only one of the fields timer , messageQueue , iotMessage , objectStorage , containerRegistry , cloudLogs Rule for activating a timed trigger. |
rule. timer. cronExpression |
string Required. Description of a schedule as a cron expression. The maximum string length in characters is 100. |
rule. timer. invokeFunction |
object rule.timer includes only one of the fields invokeFunction , invokeFunctionWithRetry A single function invocation. |
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 rule.timer includes only one of the fields invokeFunction , invokeFunctionWithRetry A function invocation with retries. |
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. |
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. messageQueue |
object rule includes only one of the fields timer , messageQueue , iotMessage , objectStorage , containerRegistry , cloudLogs Rule for activating a message queue trigger. |
rule. messageQueue. queueId |
string Required. ID of the message queue in Yandex 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 Settings for batch processing of messages in a 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 10, 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. A single function invocation. |
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. iotMessage |
object rule includes only one of the fields timer , messageQueue , iotMessage , objectStorage , containerRegistry , cloudLogs Rule for activating a Yandex IoT Core trigger. |
rule. iotMessage. registryId |
string Required. ID of the Yandex IoT Core registry. |
rule. iotMessage. deviceId |
string ID of the Yandex IoT Core device in the registry. |
rule. iotMessage. mqttTopic |
string MQTT topic whose messages activate the trigger. |
rule. iotMessage. invokeFunction |
object A function invocation with retries. |
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. |
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. objectStorage |
object rule includes only one of the fields timer , messageQueue , iotMessage , objectStorage , containerRegistry , cloudLogs |
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. invokeFunction |
object Instructions for invoking a function with retries as needed. A function invocation with retries. |
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. |
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. containerRegistry |
object rule includes only one of the fields timer , messageQueue , iotMessage , objectStorage , containerRegistry , cloudLogs |
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. invokeFunction |
object Instructions for invoking a function with retries as needed. A function invocation with retries. |
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. |
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. cloudLogs |
object rule includes only one of the fields timer , messageQueue , iotMessage , objectStorage , containerRegistry , cloudLogs |
rule. cloudLogs. logGroupId[] |
string Log group identifiers, at least one value is required. |
rule. cloudLogs. batchSettings |
object |
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. A function invocation with retries. |
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. |
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. |
status | string Trigger status. |
Methods
Method | Description |
---|---|
create | Creates a trigger in the specified folder. |
delete | Deletes the specified trigger. |
get | Returns the specified trigger. |
list | Retrieves the list of triggers in the specified folder. |
listOperations | Lists operations for the specified trigger. |
pause | Pauses the specified trigger. |
resume | Restarts the specified trigger. |
update | Updates the specified trigger. |