TriggerService

A set of methods for managing triggers for serverless functions.

Call	Description
Get	Returns the specified trigger.
List	Retrieves the list of triggers in the specified folder.
Create	Creates a trigger in the specified folder.
Update	Updates the specified trigger.
Delete	Deletes the specified trigger.
Pause	Pauses the specified trigger.
Resume	Restarts the specified trigger.
ListOperations	Lists operations for the specified trigger.

Calls TriggerService

Get

Returns the specified trigger.
To get the list of all available triggers, make a List request.

rpc Get (GetTriggerRequest) returns (Trigger)

GetTriggerRequest

Field	Description
trigger_id	string Required. ID of the trigger to return. To get a trigger ID make a TriggerService.List request.

Trigger

Field	Description
id	string ID of the trigger. Generated at creation time.
folder_id	string Required. ID of the folder that the trigger belongs to. The maximum string length in characters is 50.
created_at	google.protobuf.Timestamp Creation timestamp for the trigger.
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	map<string,string> Trigger labels as key:value pairs.
rule	Rule Required. Rule for trigger activation (always consistent with the trigger type).
status	enum Status Trigger status.

Rule

Field	Description
rule	oneof: timer, message_queue, iot_message, object_storage, container_registry, cloud_logs or logging
timer	Timer Rule for a timed trigger.
message_queue	MessageQueue Rule for a message queue trigger.
iot_message	IoTMessage Rule for a Yandex IoT Core trigger.
object_storage	ObjectStorage
container_registry	ContainerRegistry
cloud_logs	CloudLogs
logging	Logging

Timer

Field	Description
cron_expression	string Required. Description of a schedule as a cron expression. The maximum string length in characters is 100.
action	oneof: invoke_function, invoke_function_with_retry or invoke_container_with_retry Action to be executed when the current time matches the cron_expression.
invoke_function	InvokeFunctionOnce Instructions for invoking a function once.
invoke_function_with_retry	InvokeFunctionWithRetry Instructions for invoking a function with retry.
invoke_container_with_retry	InvokeContainerWithRetry Instructions for invoking a container with retry.

MessageQueue

Field	Description
queue_id	string Required. ID of the message queue in Yandex Message Queue.
service_account_id	string Required. ID of the service account which has read access to the message queue. The maximum string length in characters is 50.
batch_settings	BatchSettings Required. Batch settings for processing messages in the queue.
visibility_timeout	google.protobuf.Duration Queue visibility timeout override. The maximum value is 12h.
action	oneof: invoke_function or invoke_container Action to be executed when the there's a new message in the queue.
invoke_function	InvokeFunctionOnce Instructions for invoking a function once.
invoke_container	InvokeContainerOnce Instructions for invoking a container once.

IoTMessage

Field	Description
registry_id	string Required. ID of the Yandex IoT Core registry.
device_id	string ID of the Yandex IoT Core device in the registry.
mqtt_topic	string MQTT topic whose messages activate the trigger.
action	oneof: invoke_function or invoke_container Action to be executed when the there's a new message in the MQTT topic.
invoke_function	InvokeFunctionWithRetry Instructions for invoking a function with retries as needed.
invoke_container	InvokeContainerWithRetry Instructions for invoking a container with retries as needed.

ObjectStorage

Field	Description
event_type[]	ObjectStorageEventType Type (name) of events, at least one value is required. The number of elements must be greater than 0.
bucket_id	string ID of the bucket.
prefix	string Prefix of the object key. Filter, optional.
suffix	string Suffix of the object key. Filter, optional.
action	oneof: invoke_function or invoke_container
invoke_function	InvokeFunctionWithRetry Instructions for invoking a function with retries as needed.
invoke_container	InvokeContainerWithRetry Instructions for invoking a container with retries as needed.

ContainerRegistry

Field	Description
event_type[]	ContainerRegistryEventType Type (name) of events, at least one value is required. The number of elements must be greater than 0.
registry_id	string ID of the registry.
image_name	string Docker-image name. Filter, optional.
tag	string Docker-image tag. Filter, optional.
action	oneof: invoke_function or invoke_container
invoke_function	InvokeFunctionWithRetry Instructions for invoking a function with retries as needed.
invoke_container	InvokeContainerWithRetry Instructions for invoking a container with retries as needed.

CloudLogs

Field	Description
log_group_id[]	string Log group identifiers, at least one value is required.
batch_settings	CloudLogsBatchSettings Required. Batch settings for processing log events.
action	oneof: invoke_function or invoke_container
invoke_function	InvokeFunctionWithRetry Instructions for invoking a function with retries as needed.
invoke_container	InvokeContainerWithRetry Instructions for invoking a container with retries as needed.

Logging

Field	Description
log_group_id	string Log events filter settings. The maximum string length in characters is 50.
resource_type[]	string Each value must match the regular expression [a-zA-Z][-a-zA-Z0-9_.]{1,62}. The maximum number of elements is 100.
resource_id[]	string Each value must match the regular expression [a-zA-Z][-a-zA-Z0-9_.]{1,62}. The maximum number of elements is 100.
levels[]	yandex.cloud.logging.v1.LogLevel.Level The maximum number of elements is 10.
batch_settings	LoggingBatchSettings Required. Batch settings for processing log events.
action	oneof: invoke_function or invoke_container
invoke_function	InvokeFunctionWithRetry Instructions for invoking a function with retries as needed.
invoke_container	InvokeContainerWithRetry Instructions for invoking a container with retries as needed.

List

Retrieves the list of triggers in the specified folder.

rpc List (ListTriggersRequest) returns (ListTriggersResponse)

ListTriggersRequest

Field	Description
folder_id	string Required. ID of the folder to list triggers in. To get a folder ID use a yandex.cloud.resourcemanager.v1.FolderService.List request.
page_size	int64 The maximum number of results per page to return. If the number of available results is larger than pageSize, the service returns a ListTriggersResponse.next_page_token that can be used to get the next page of results in subsequent list requests. Default value: 100.
page_token	string Page token. To get the next page of results, set pageToken to the ListTriggersResponse.next_page_token returned by a previous list request.
filter	string The field name. Currently filtering can only be applied to the Trigger.name field. A conditional operator. Can be either = or != for single values, IN or NOT IN The value. Must be 3-63 characters long and match the regular expression ^[a-z][-a-z0-9]{1,61}[a-z0-9]$.

ListTriggersResponse

Field	Description
triggers[]	Trigger List of triggers in the specified folder.
next_page_token	string Token for getting the next page of the list. If the number of results is greater than the specified ListTriggersRequest.page_size, use nextPageToken as the value for the ListTriggersRequest.page_token parameter in the next list request. Each subsequent page will have its own nextPageToken to continue paging through the results.

Trigger

Field	Description
id	string ID of the trigger. Generated at creation time.
folder_id	string Required. ID of the folder that the trigger belongs to. The maximum string length in characters is 50.
created_at	google.protobuf.Timestamp Creation timestamp for the trigger.
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	map<string,string> Trigger labels as key:value pairs.
rule	Rule Required. Rule for trigger activation (always consistent with the trigger type).
status	enum Status Trigger status.

Rule

Field	Description
rule	oneof: timer, message_queue, iot_message, object_storage, container_registry, cloud_logs or logging
timer	Timer Rule for a timed trigger.
message_queue	MessageQueue Rule for a message queue trigger.
iot_message	IoTMessage Rule for a Yandex IoT Core trigger.
object_storage	ObjectStorage
container_registry	ContainerRegistry
cloud_logs	CloudLogs
logging	Logging

Timer

Field	Description
cron_expression	string Required. Description of a schedule as a cron expression. The maximum string length in characters is 100.
action	oneof: invoke_function, invoke_function_with_retry or invoke_container_with_retry Action to be executed when the current time matches the cron_expression.
invoke_function	InvokeFunctionOnce Instructions for invoking a function once.
invoke_function_with_retry	InvokeFunctionWithRetry Instructions for invoking a function with retry.
invoke_container_with_retry	InvokeContainerWithRetry Instructions for invoking a container with retry.

MessageQueue

Field	Description
queue_id	string Required. ID of the message queue in Yandex Message Queue.
service_account_id	string Required. ID of the service account which has read access to the message queue. The maximum string length in characters is 50.
batch_settings	BatchSettings Required. Batch settings for processing messages in the queue.
visibility_timeout	google.protobuf.Duration Queue visibility timeout override. The maximum value is 12h.
action	oneof: invoke_function or invoke_container Action to be executed when the there's a new message in the queue.
invoke_function	InvokeFunctionOnce Instructions for invoking a function once.
invoke_container	InvokeContainerOnce Instructions for invoking a container once.

IoTMessage

Field	Description
registry_id	string Required. ID of the Yandex IoT Core registry.
device_id	string ID of the Yandex IoT Core device in the registry.
mqtt_topic	string MQTT topic whose messages activate the trigger.
action	oneof: invoke_function or invoke_container Action to be executed when the there's a new message in the MQTT topic.
invoke_function	InvokeFunctionWithRetry Instructions for invoking a function with retries as needed.
invoke_container	InvokeContainerWithRetry Instructions for invoking a container with retries as needed.

ObjectStorage

Field	Description
event_type[]	ObjectStorageEventType Type (name) of events, at least one value is required. The number of elements must be greater than 0.
bucket_id	string ID of the bucket.
prefix	string Prefix of the object key. Filter, optional.
suffix	string Suffix of the object key. Filter, optional.
action	oneof: invoke_function or invoke_container
invoke_function	InvokeFunctionWithRetry Instructions for invoking a function with retries as needed.
invoke_container	InvokeContainerWithRetry Instructions for invoking a container with retries as needed.

ContainerRegistry

Field	Description
event_type[]	ContainerRegistryEventType Type (name) of events, at least one value is required. The number of elements must be greater than 0.
registry_id	string ID of the registry.
image_name	string Docker-image name. Filter, optional.
tag	string Docker-image tag. Filter, optional.
action	oneof: invoke_function or invoke_container
invoke_function	InvokeFunctionWithRetry Instructions for invoking a function with retries as needed.
invoke_container	InvokeContainerWithRetry Instructions for invoking a container with retries as needed.

CloudLogs

Field	Description
log_group_id[]	string Log group identifiers, at least one value is required.
batch_settings	CloudLogsBatchSettings Required. Batch settings for processing log events.
action	oneof: invoke_function or invoke_container
invoke_function	InvokeFunctionWithRetry Instructions for invoking a function with retries as needed.
invoke_container	InvokeContainerWithRetry Instructions for invoking a container with retries as needed.

Logging

Field	Description
log_group_id	string Log events filter settings. The maximum string length in characters is 50.
resource_type[]	string Each value must match the regular expression [a-zA-Z][-a-zA-Z0-9_.]{1,62}. The maximum number of elements is 100.
resource_id[]	string Each value must match the regular expression [a-zA-Z][-a-zA-Z0-9_.]{1,62}. The maximum number of elements is 100.
levels[]	yandex.cloud.logging.v1.LogLevel.Level The maximum number of elements is 10.
batch_settings	LoggingBatchSettings Required. Batch settings for processing log events.
action	oneof: invoke_function or invoke_container
invoke_function	InvokeFunctionWithRetry Instructions for invoking a function with retries as needed.
invoke_container	InvokeContainerWithRetry Instructions for invoking a container with retries as needed.

Create

Creates a trigger in the specified folder.

rpc Create (CreateTriggerRequest) returns (operation.Operation)

Metadata and response of Operation:

    Operation.metadata:CreateTriggerMetadata

    Operation.response:Trigger

CreateTriggerRequest

Field	Description
folder_id	string Required. ID of the folder to create a trigger in. To get a folder ID make a yandex.cloud.resourcemanager.v1.FolderService.List request.
name	string Name of the trigger. The name must be unique within the folder. Value must match the regular expression `
description	string Description of the trigger. The maximum string length in characters is 256.
labels	map<string,string> Resource labels as key:value pairs. 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	Trigger.Rule Required. Trigger type.

Operation

Field	Description
id	string ID of the operation.
description	string Description of the operation. 0-256 characters long.
created_at	google.protobuf.Timestamp Creation timestamp.
created_by	string ID of the user or service account who initiated the operation.
modified_at	google.protobuf.Timestamp The time when the Operation resource was last modified.
done	bool 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	google.protobuf.Any<CreateTriggerMetadata> 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.
result	oneof: error or 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.
error	google.rpc.Status The error result of the operation in case of failure or cancellation.
response	google.protobuf.Any<Trigger> if operation finished successfully.

CreateTriggerMetadata

Field	Description
trigger_id	string ID of the trigger that is being created.

Trigger

Field	Description
id	string ID of the trigger. Generated at creation time.
folder_id	string Required. ID of the folder that the trigger belongs to. The maximum string length in characters is 50.
created_at	google.protobuf.Timestamp Creation timestamp for the trigger.
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	map<string,string> Trigger labels as key:value pairs.
rule	Rule Required. Rule for trigger activation (always consistent with the trigger type).
status	enum Status Trigger status.

Rule

Field	Description
rule	oneof: timer, message_queue, iot_message, object_storage, container_registry, cloud_logs or logging
timer	Timer Rule for a timed trigger.
message_queue	MessageQueue Rule for a message queue trigger.
iot_message	IoTMessage Rule for a Yandex IoT Core trigger.
object_storage	ObjectStorage
container_registry	ContainerRegistry
cloud_logs	CloudLogs
logging	Logging

Timer

Field	Description
cron_expression	string Required. Description of a schedule as a cron expression. The maximum string length in characters is 100.
action	oneof: invoke_function, invoke_function_with_retry or invoke_container_with_retry Action to be executed when the current time matches the cron_expression.
invoke_function	InvokeFunctionOnce Instructions for invoking a function once.
invoke_function_with_retry	InvokeFunctionWithRetry Instructions for invoking a function with retry.
invoke_container_with_retry	InvokeContainerWithRetry Instructions for invoking a container with retry.

MessageQueue

Field	Description
queue_id	string Required. ID of the message queue in Yandex Message Queue.
service_account_id	string Required. ID of the service account which has read access to the message queue. The maximum string length in characters is 50.
batch_settings	BatchSettings Required. Batch settings for processing messages in the queue.
visibility_timeout	google.protobuf.Duration Queue visibility timeout override. The maximum value is 12h.
action	oneof: invoke_function or invoke_container Action to be executed when the there's a new message in the queue.
invoke_function	InvokeFunctionOnce Instructions for invoking a function once.
invoke_container	InvokeContainerOnce Instructions for invoking a container once.

IoTMessage

Field	Description
registry_id	string Required. ID of the Yandex IoT Core registry.
device_id	string ID of the Yandex IoT Core device in the registry.
mqtt_topic	string MQTT topic whose messages activate the trigger.
action	oneof: invoke_function or invoke_container Action to be executed when the there's a new message in the MQTT topic.
invoke_function	InvokeFunctionWithRetry Instructions for invoking a function with retries as needed.
invoke_container	InvokeContainerWithRetry Instructions for invoking a container with retries as needed.

ObjectStorage

Field	Description
event_type[]	ObjectStorageEventType Type (name) of events, at least one value is required. The number of elements must be greater than 0.
bucket_id	string ID of the bucket.
prefix	string Prefix of the object key. Filter, optional.
suffix	string Suffix of the object key. Filter, optional.
action	oneof: invoke_function or invoke_container
invoke_function	InvokeFunctionWithRetry Instructions for invoking a function with retries as needed.
invoke_container	InvokeContainerWithRetry Instructions for invoking a container with retries as needed.

ContainerRegistry

Field	Description
event_type[]	ContainerRegistryEventType Type (name) of events, at least one value is required. The number of elements must be greater than 0.
registry_id	string ID of the registry.
image_name	string Docker-image name. Filter, optional.
tag	string Docker-image tag. Filter, optional.
action	oneof: invoke_function or invoke_container
invoke_function	InvokeFunctionWithRetry Instructions for invoking a function with retries as needed.
invoke_container	InvokeContainerWithRetry Instructions for invoking a container with retries as needed.

CloudLogs

Field	Description
log_group_id[]	string Log group identifiers, at least one value is required.
batch_settings	CloudLogsBatchSettings Required. Batch settings for processing log events.
action	oneof: invoke_function or invoke_container
invoke_function	InvokeFunctionWithRetry Instructions for invoking a function with retries as needed.
invoke_container	InvokeContainerWithRetry Instructions for invoking a container with retries as needed.

Logging

Field	Description
log_group_id	string Log events filter settings. The maximum string length in characters is 50.
resource_type[]	string Each value must match the regular expression [a-zA-Z][-a-zA-Z0-9_.]{1,62}. The maximum number of elements is 100.
resource_id[]	string Each value must match the regular expression [a-zA-Z][-a-zA-Z0-9_.]{1,62}. The maximum number of elements is 100.
levels[]	yandex.cloud.logging.v1.LogLevel.Level The maximum number of elements is 10.
batch_settings	LoggingBatchSettings Required. Batch settings for processing log events.
action	oneof: invoke_function or invoke_container
invoke_function	InvokeFunctionWithRetry Instructions for invoking a function with retries as needed.
invoke_container	InvokeContainerWithRetry Instructions for invoking a container with retries as needed.

Update

Updates the specified trigger.

rpc Update (UpdateTriggerRequest) returns (operation.Operation)

Metadata and response of Operation:

    Operation.metadata:UpdateTriggerMetadata

    Operation.response:Trigger

UpdateTriggerRequest

Field	Description
trigger_id	string Required. ID of the trigger to update. To get a trigger ID make a TriggerService.List request.
update_mask	google.protobuf.FieldMask Field mask that specifies which attributes of the trigger should be updated.
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	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]*.

Operation

Field	Description
id	string ID of the operation.
description	string Description of the operation. 0-256 characters long.
created_at	google.protobuf.Timestamp Creation timestamp.
created_by	string ID of the user or service account who initiated the operation.
modified_at	google.protobuf.Timestamp The time when the Operation resource was last modified.
done	bool 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	google.protobuf.Any<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.
result	oneof: error or 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.
error	google.rpc.Status The error result of the operation in case of failure or cancellation.
response	google.protobuf.Any<Trigger> if operation finished successfully.

UpdateTriggerMetadata

Field	Description
trigger_id	string Required. ID of the trigger that is being updated.

Trigger

Field	Description
id	string ID of the trigger. Generated at creation time.
folder_id	string Required. ID of the folder that the trigger belongs to. The maximum string length in characters is 50.
created_at	google.protobuf.Timestamp Creation timestamp for the trigger.
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	map<string,string> Trigger labels as key:value pairs.
rule	Rule Required. Rule for trigger activation (always consistent with the trigger type).
status	enum Status Trigger status.

Rule

Field	Description
rule	oneof: timer, message_queue, iot_message, object_storage, container_registry, cloud_logs or logging
timer	Timer Rule for a timed trigger.
message_queue	MessageQueue Rule for a message queue trigger.
iot_message	IoTMessage Rule for a Yandex IoT Core trigger.
object_storage	ObjectStorage
container_registry	ContainerRegistry
cloud_logs	CloudLogs
logging	Logging

Timer

Field	Description
cron_expression	string Required. Description of a schedule as a cron expression. The maximum string length in characters is 100.
action	oneof: invoke_function, invoke_function_with_retry or invoke_container_with_retry Action to be executed when the current time matches the cron_expression.
invoke_function	InvokeFunctionOnce Instructions for invoking a function once.
invoke_function_with_retry	InvokeFunctionWithRetry Instructions for invoking a function with retry.
invoke_container_with_retry	InvokeContainerWithRetry Instructions for invoking a container with retry.

MessageQueue

Field	Description
queue_id	string Required. ID of the message queue in Yandex Message Queue.
service_account_id	string Required. ID of the service account which has read access to the message queue. The maximum string length in characters is 50.
batch_settings	BatchSettings Required. Batch settings for processing messages in the queue.
visibility_timeout	google.protobuf.Duration Queue visibility timeout override. The maximum value is 12h.
action	oneof: invoke_function or invoke_container Action to be executed when the there's a new message in the queue.
invoke_function	InvokeFunctionOnce Instructions for invoking a function once.
invoke_container	InvokeContainerOnce Instructions for invoking a container once.

IoTMessage

Field	Description
registry_id	string Required. ID of the Yandex IoT Core registry.
device_id	string ID of the Yandex IoT Core device in the registry.
mqtt_topic	string MQTT topic whose messages activate the trigger.
action	oneof: invoke_function or invoke_container Action to be executed when the there's a new message in the MQTT topic.
invoke_function	InvokeFunctionWithRetry Instructions for invoking a function with retries as needed.
invoke_container	InvokeContainerWithRetry Instructions for invoking a container with retries as needed.

ObjectStorage

Field	Description
event_type[]	ObjectStorageEventType Type (name) of events, at least one value is required. The number of elements must be greater than 0.
bucket_id	string ID of the bucket.
prefix	string Prefix of the object key. Filter, optional.
suffix	string Suffix of the object key. Filter, optional.
action	oneof: invoke_function or invoke_container
invoke_function	InvokeFunctionWithRetry Instructions for invoking a function with retries as needed.
invoke_container	InvokeContainerWithRetry Instructions for invoking a container with retries as needed.

ContainerRegistry

Field	Description
event_type[]	ContainerRegistryEventType Type (name) of events, at least one value is required. The number of elements must be greater than 0.
registry_id	string ID of the registry.
image_name	string Docker-image name. Filter, optional.
tag	string Docker-image tag. Filter, optional.
action	oneof: invoke_function or invoke_container
invoke_function	InvokeFunctionWithRetry Instructions for invoking a function with retries as needed.
invoke_container	InvokeContainerWithRetry Instructions for invoking a container with retries as needed.

CloudLogs

Field	Description
log_group_id[]	string Log group identifiers, at least one value is required.
batch_settings	CloudLogsBatchSettings Required. Batch settings for processing log events.
action	oneof: invoke_function or invoke_container
invoke_function	InvokeFunctionWithRetry Instructions for invoking a function with retries as needed.
invoke_container	InvokeContainerWithRetry Instructions for invoking a container with retries as needed.

Logging

Field	Description
log_group_id	string Log events filter settings. The maximum string length in characters is 50.
resource_type[]	string Each value must match the regular expression [a-zA-Z][-a-zA-Z0-9_.]{1,62}. The maximum number of elements is 100.
resource_id[]	string Each value must match the regular expression [a-zA-Z][-a-zA-Z0-9_.]{1,62}. The maximum number of elements is 100.
levels[]	yandex.cloud.logging.v1.LogLevel.Level The maximum number of elements is 10.
batch_settings	LoggingBatchSettings Required. Batch settings for processing log events.
action	oneof: invoke_function or invoke_container
invoke_function	InvokeFunctionWithRetry Instructions for invoking a function with retries as needed.
invoke_container	InvokeContainerWithRetry Instructions for invoking a container with retries as needed.

Delete

Deletes the specified trigger.

rpc Delete (DeleteTriggerRequest) returns (operation.Operation)

Metadata and response of Operation:

    Operation.metadata:DeleteTriggerMetadata

    Operation.response:google.protobuf.Empty

DeleteTriggerRequest

Field	Description
trigger_id	string Required. ID of the trigger to delete. To get a trigger ID make a TriggerService.List request.

Operation

Field	Description
id	string ID of the operation.
description	string Description of the operation. 0-256 characters long.
created_at	google.protobuf.Timestamp Creation timestamp.
created_by	string ID of the user or service account who initiated the operation.
modified_at	google.protobuf.Timestamp The time when the Operation resource was last modified.
done	bool 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	google.protobuf.Any<DeleteTriggerMetadata> 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.
result	oneof: error or 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.
error	google.rpc.Status The error result of the operation in case of failure or cancellation.
response	google.protobuf.Any<google.protobuf.Empty> if operation finished successfully.

DeleteTriggerMetadata

Field	Description
trigger_id	string Required. ID of the trigger that is being deleted.

Pause

Pauses the specified trigger.

rpc Pause (PauseTriggerRequest) returns (operation.Operation)

Metadata and response of Operation:

    Operation.metadata:PauseTriggerMetadata

    Operation.response:Trigger

PauseTriggerRequest

Field	Description
trigger_id	string Required. ID of the trigger to pause To get a trigger ID make a TriggerService.List request.

Operation

Field	Description
id	string ID of the operation.
description	string Description of the operation. 0-256 characters long.
created_at	google.protobuf.Timestamp Creation timestamp.
created_by	string ID of the user or service account who initiated the operation.
modified_at	google.protobuf.Timestamp The time when the Operation resource was last modified.
done	bool 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	google.protobuf.Any<PauseTriggerMetadata> 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.
result	oneof: error or 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.
error	google.rpc.Status The error result of the operation in case of failure or cancellation.
response	google.protobuf.Any<Trigger> if operation finished successfully.

PauseTriggerMetadata

Field	Description
trigger_id	string Required. ID of the trigger that is being paused.

Trigger

Field	Description
id	string ID of the trigger. Generated at creation time.
folder_id	string Required. ID of the folder that the trigger belongs to. The maximum string length in characters is 50.
created_at	google.protobuf.Timestamp Creation timestamp for the trigger.
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	map<string,string> Trigger labels as key:value pairs.
rule	Rule Required. Rule for trigger activation (always consistent with the trigger type).
status	enum Status Trigger status.

Rule

Field	Description
rule	oneof: timer, message_queue, iot_message, object_storage, container_registry, cloud_logs or logging
timer	Timer Rule for a timed trigger.
message_queue	MessageQueue Rule for a message queue trigger.
iot_message	IoTMessage Rule for a Yandex IoT Core trigger.
object_storage	ObjectStorage
container_registry	ContainerRegistry
cloud_logs	CloudLogs
logging	Logging

Timer

Field	Description
cron_expression	string Required. Description of a schedule as a cron expression. The maximum string length in characters is 100.
action	oneof: invoke_function, invoke_function_with_retry or invoke_container_with_retry Action to be executed when the current time matches the cron_expression.
invoke_function	InvokeFunctionOnce Instructions for invoking a function once.
invoke_function_with_retry	InvokeFunctionWithRetry Instructions for invoking a function with retry.
invoke_container_with_retry	InvokeContainerWithRetry Instructions for invoking a container with retry.

MessageQueue

Field	Description
queue_id	string Required. ID of the message queue in Yandex Message Queue.
service_account_id	string Required. ID of the service account which has read access to the message queue. The maximum string length in characters is 50.
batch_settings	BatchSettings Required. Batch settings for processing messages in the queue.
visibility_timeout	google.protobuf.Duration Queue visibility timeout override. The maximum value is 12h.
action	oneof: invoke_function or invoke_container Action to be executed when the there's a new message in the queue.
invoke_function	InvokeFunctionOnce Instructions for invoking a function once.
invoke_container	InvokeContainerOnce Instructions for invoking a container once.

IoTMessage

Field	Description
registry_id	string Required. ID of the Yandex IoT Core registry.
device_id	string ID of the Yandex IoT Core device in the registry.
mqtt_topic	string MQTT topic whose messages activate the trigger.
action	oneof: invoke_function or invoke_container Action to be executed when the there's a new message in the MQTT topic.
invoke_function	InvokeFunctionWithRetry Instructions for invoking a function with retries as needed.
invoke_container	InvokeContainerWithRetry Instructions for invoking a container with retries as needed.

ObjectStorage

Field	Description
event_type[]	ObjectStorageEventType Type (name) of events, at least one value is required. The number of elements must be greater than 0.
bucket_id	string ID of the bucket.
prefix	string Prefix of the object key. Filter, optional.
suffix	string Suffix of the object key. Filter, optional.
action	oneof: invoke_function or invoke_container
invoke_function	InvokeFunctionWithRetry Instructions for invoking a function with retries as needed.
invoke_container	InvokeContainerWithRetry Instructions for invoking a container with retries as needed.

ContainerRegistry

Field	Description
event_type[]	ContainerRegistryEventType Type (name) of events, at least one value is required. The number of elements must be greater than 0.
registry_id	string ID of the registry.
image_name	string Docker-image name. Filter, optional.
tag	string Docker-image tag. Filter, optional.
action	oneof: invoke_function or invoke_container
invoke_function	InvokeFunctionWithRetry Instructions for invoking a function with retries as needed.
invoke_container	InvokeContainerWithRetry Instructions for invoking a container with retries as needed.

CloudLogs

Field	Description
log_group_id[]	string Log group identifiers, at least one value is required.
batch_settings	CloudLogsBatchSettings Required. Batch settings for processing log events.
action	oneof: invoke_function or invoke_container
invoke_function	InvokeFunctionWithRetry Instructions for invoking a function with retries as needed.
invoke_container	InvokeContainerWithRetry Instructions for invoking a container with retries as needed.

Logging

Field	Description
log_group_id	string Log events filter settings. The maximum string length in characters is 50.
resource_type[]	string Each value must match the regular expression [a-zA-Z][-a-zA-Z0-9_.]{1,62}. The maximum number of elements is 100.
resource_id[]	string Each value must match the regular expression [a-zA-Z][-a-zA-Z0-9_.]{1,62}. The maximum number of elements is 100.
levels[]	yandex.cloud.logging.v1.LogLevel.Level The maximum number of elements is 10.
batch_settings	LoggingBatchSettings Required. Batch settings for processing log events.
action	oneof: invoke_function or invoke_container
invoke_function	InvokeFunctionWithRetry Instructions for invoking a function with retries as needed.
invoke_container	InvokeContainerWithRetry Instructions for invoking a container with retries as needed.

Resume

Restarts the specified trigger.

rpc Resume (ResumeTriggerRequest) returns (operation.Operation)

Metadata and response of Operation:

    Operation.metadata:ResumeTriggerMetadata

    Operation.response:Trigger

ResumeTriggerRequest

Field	Description
trigger_id	string Required. ID of the trigger to pause To get a trigger ID make a TriggerService.List request.

Operation

Field	Description
id	string ID of the operation.
description	string Description of the operation. 0-256 characters long.
created_at	google.protobuf.Timestamp Creation timestamp.
created_by	string ID of the user or service account who initiated the operation.
modified_at	google.protobuf.Timestamp The time when the Operation resource was last modified.
done	bool 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	google.protobuf.Any<ResumeTriggerMetadata> 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.
result	oneof: error or 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.
error	google.rpc.Status The error result of the operation in case of failure or cancellation.
response	google.protobuf.Any<Trigger> if operation finished successfully.

ResumeTriggerMetadata

Field	Description
trigger_id	string Required. ID of the trigger that is being paused.

Trigger

Field	Description
id	string ID of the trigger. Generated at creation time.
folder_id	string Required. ID of the folder that the trigger belongs to. The maximum string length in characters is 50.
created_at	google.protobuf.Timestamp Creation timestamp for the trigger.
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	map<string,string> Trigger labels as key:value pairs.
rule	Rule Required. Rule for trigger activation (always consistent with the trigger type).
status	enum Status Trigger status.

Rule

Field	Description
rule	oneof: timer, message_queue, iot_message, object_storage, container_registry, cloud_logs or logging
timer	Timer Rule for a timed trigger.
message_queue	MessageQueue Rule for a message queue trigger.
iot_message	IoTMessage Rule for a Yandex IoT Core trigger.
object_storage	ObjectStorage
container_registry	ContainerRegistry
cloud_logs	CloudLogs
logging	Logging

Timer

Field	Description
cron_expression	string Required. Description of a schedule as a cron expression. The maximum string length in characters is 100.
action	oneof: invoke_function, invoke_function_with_retry or invoke_container_with_retry Action to be executed when the current time matches the cron_expression.
invoke_function	InvokeFunctionOnce Instructions for invoking a function once.
invoke_function_with_retry	InvokeFunctionWithRetry Instructions for invoking a function with retry.
invoke_container_with_retry	InvokeContainerWithRetry Instructions for invoking a container with retry.

MessageQueue

Field	Description
queue_id	string Required. ID of the message queue in Yandex Message Queue.
service_account_id	string Required. ID of the service account which has read access to the message queue. The maximum string length in characters is 50.
batch_settings	BatchSettings Required. Batch settings for processing messages in the queue.
visibility_timeout	google.protobuf.Duration Queue visibility timeout override. The maximum value is 12h.
action	oneof: invoke_function or invoke_container Action to be executed when the there's a new message in the queue.
invoke_function	InvokeFunctionOnce Instructions for invoking a function once.
invoke_container	InvokeContainerOnce Instructions for invoking a container once.

IoTMessage

Field	Description
registry_id	string Required. ID of the Yandex IoT Core registry.
device_id	string ID of the Yandex IoT Core device in the registry.
mqtt_topic	string MQTT topic whose messages activate the trigger.
action	oneof: invoke_function or invoke_container Action to be executed when the there's a new message in the MQTT topic.
invoke_function	InvokeFunctionWithRetry Instructions for invoking a function with retries as needed.
invoke_container	InvokeContainerWithRetry Instructions for invoking a container with retries as needed.

ObjectStorage

Field	Description
event_type[]	ObjectStorageEventType Type (name) of events, at least one value is required. The number of elements must be greater than 0.
bucket_id	string ID of the bucket.
prefix	string Prefix of the object key. Filter, optional.
suffix	string Suffix of the object key. Filter, optional.
action	oneof: invoke_function or invoke_container
invoke_function	InvokeFunctionWithRetry Instructions for invoking a function with retries as needed.
invoke_container	InvokeContainerWithRetry Instructions for invoking a container with retries as needed.

ContainerRegistry

Field	Description
event_type[]	ContainerRegistryEventType Type (name) of events, at least one value is required. The number of elements must be greater than 0.
registry_id	string ID of the registry.
image_name	string Docker-image name. Filter, optional.
tag	string Docker-image tag. Filter, optional.
action	oneof: invoke_function or invoke_container
invoke_function	InvokeFunctionWithRetry Instructions for invoking a function with retries as needed.
invoke_container	InvokeContainerWithRetry Instructions for invoking a container with retries as needed.

CloudLogs

Field	Description
log_group_id[]	string Log group identifiers, at least one value is required.
batch_settings	CloudLogsBatchSettings Required. Batch settings for processing log events.
action	oneof: invoke_function or invoke_container
invoke_function	InvokeFunctionWithRetry Instructions for invoking a function with retries as needed.
invoke_container	InvokeContainerWithRetry Instructions for invoking a container with retries as needed.

Logging

Field	Description
log_group_id	string Log events filter settings. The maximum string length in characters is 50.
resource_type[]	string Each value must match the regular expression [a-zA-Z][-a-zA-Z0-9_.]{1,62}. The maximum number of elements is 100.
resource_id[]	string Each value must match the regular expression [a-zA-Z][-a-zA-Z0-9_.]{1,62}. The maximum number of elements is 100.
levels[]	yandex.cloud.logging.v1.LogLevel.Level The maximum number of elements is 10.
batch_settings	LoggingBatchSettings Required. Batch settings for processing log events.
action	oneof: invoke_function or invoke_container
invoke_function	InvokeFunctionWithRetry Instructions for invoking a function with retries as needed.
invoke_container	InvokeContainerWithRetry Instructions for invoking a container with retries as needed.

ListOperations

Lists operations for the specified trigger.

rpc ListOperations (ListTriggerOperationsRequest) returns (ListTriggerOperationsResponse)

ListTriggerOperationsRequest

Field	Description
trigger_id	string Required. ID of the trigger to list operations for.
page_size	int64 The maximum number of results per page that should be returned. If the number of available results is larger than pageSize, the service returns a ListTriggerOperationsResponse.next_page_token that can be used to get the next page of results in subsequent list requests. Default value: 100. Acceptable values are 0 to 1000, inclusive.
page_token	string Page token. To get the next page of results, set pageToken to the ListTriggerOperationsResponse.next_page_token returned by a previous list request. The maximum string length in characters is 100.
filter	string The field name. Currently filtering can only be applied to the Trigger.name field. A conditional operator. Can be either = or != for single values, IN or NOT IN The value. Must be 3-63 characters long and match the regular expression ^[a-z][-a-z0-9]{1,61}[a-z0-9]$. The maximum string length in characters is 1000.

ListTriggerOperationsResponse

Field	Description
operations[]	operation.Operation List of operations for the specified trigger.
next_page_token	string Token for getting the next page of the list. If the number of results is greater than the specified ListTriggerOperationsRequest.page_size, use nextPageToken as the value for the ListTriggerOperationsRequest.page_token parameter in the next list request. Each subsequent page will have its own nextPageToken to continue paging through the results.

Operation

Field	Description
id	string ID of the operation.
description	string Description of the operation. 0-256 characters long.
created_at	google.protobuf.Timestamp Creation timestamp.
created_by	string ID of the user or service account who initiated the operation.
modified_at	google.protobuf.Timestamp The time when the Operation resource was last modified.
done	bool 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	google.protobuf.Any 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.
result	oneof: error or 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.
error	google.rpc.Status The error result of the operation in case of failure or cancellation.
response	google.protobuf.Any 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.