Cloud Functions Triggers Service, gRPC: TriggerService.List

Field

Description

folder_id

string

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

A filter expression that filters triggers listed in the response.

The expression must specify:

1. The field name. Currently filtering can only be applied to the Trigger.name field.
2. An = operator.
3. The value in double quotes ("). Must be 3-63 characters long and match the regular expression [a-z][-a-z0-9]{1,61}[a-z0-9].
   Example of a filter: name=my-trigger.

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.

Field

Description

id

string

ID of the trigger. Generated at creation time.

folder_id

string

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

created_at

google.protobuf.Timestamp

Creation timestamp for the trigger.

name

string

Name of the trigger.

description

string

Description of the trigger.

labels

object (map<string, string>)

Trigger labels as key:value pairs.

rule

Rule

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

status

enum Status

Trigger status.

• STATUS_UNSPECIFIED
• ACTIVE
• PAUSED

Field

Description

timer

Timer

Rule for a timed trigger.

Includes only one of the fields timer, message_queue, iot_message, iot_broker_message, object_storage, container_registry, cloud_logs, logging, billing_budget, data_stream, mail.

message_queue

MessageQueue

Rule for a message queue trigger.

Includes only one of the fields timer, message_queue, iot_message, iot_broker_message, object_storage, container_registry, cloud_logs, logging, billing_budget, data_stream, mail.

iot_message

IoTMessage

Rule for a IoT Core trigger.

Includes only one of the fields timer, message_queue, iot_message, iot_broker_message, object_storage, container_registry, cloud_logs, logging, billing_budget, data_stream, mail.

iot_broker_message

IoTBrokerMessage

Includes only one of the fields timer, message_queue, iot_message, iot_broker_message, object_storage, container_registry, cloud_logs, logging, billing_budget, data_stream, mail.

object_storage

ObjectStorage

Includes only one of the fields timer, message_queue, iot_message, iot_broker_message, object_storage, container_registry, cloud_logs, logging, billing_budget, data_stream, mail.

container_registry

ContainerRegistry

Includes only one of the fields timer, message_queue, iot_message, iot_broker_message, object_storage, container_registry, cloud_logs, logging, billing_budget, data_stream, mail.

cloud_logs

CloudLogs

Includes only one of the fields timer, message_queue, iot_message, iot_broker_message, object_storage, container_registry, cloud_logs, logging, billing_budget, data_stream, mail.

logging

Logging

Includes only one of the fields timer, message_queue, iot_message, iot_broker_message, object_storage, container_registry, cloud_logs, logging, billing_budget, data_stream, mail.

billing_budget

BillingBudget

Includes only one of the fields timer, message_queue, iot_message, iot_broker_message, object_storage, container_registry, cloud_logs, logging, billing_budget, data_stream, mail.

data_stream

DataStream

Includes only one of the fields timer, message_queue, iot_message, iot_broker_message, object_storage, container_registry, cloud_logs, logging, billing_budget, data_stream, mail.

mail

Mail

Includes only one of the fields timer, message_queue, iot_message, iot_broker_message, object_storage, container_registry, cloud_logs, logging, billing_budget, data_stream, mail.

Field

Description

cron_expression

string

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

payload

string

Payload to be passed to function.

invoke_function

InvokeFunctionOnce

Instructions for invoking a function once.

Includes only one of the fields invoke_function, invoke_function_with_retry, invoke_container_with_retry, gateway_websocket_broadcast.

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

invoke_function_with_retry

InvokeFunctionWithRetry

Instructions for invoking a function with retry.

Includes only one of the fields invoke_function, invoke_function_with_retry, invoke_container_with_retry, gateway_websocket_broadcast.

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

invoke_container_with_retry

InvokeContainerWithRetry

Instructions for invoking a container with retry.

Includes only one of the fields invoke_function, invoke_function_with_retry, invoke_container_with_retry, gateway_websocket_broadcast.

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

gateway_websocket_broadcast

GatewayWebsocketBroadcast

Instructions for broadcasting to API gateway websocket once.

Includes only one of the fields invoke_function, invoke_function_with_retry, invoke_container_with_retry, gateway_websocket_broadcast.

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

Field

Description

function_id

string

Required field. ID of the function to invoke.

function_tag

string

Version tag of the function to execute.

service_account_id

string

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

Field

Description

function_id

string

Required field. ID of the function to invoke.

function_tag

string

Version tag of the function to execute.

service_account_id

string

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

retry_settings

RetrySettings

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

dead_letter_queue

PutQueueMessage

DLQ policy (no value means discarding a message).

Field

Description

retry_attempts

int64

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

interval

google.protobuf.Duration

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

Field

Description

queue_id

string

ID of the queue.

service_account_id

string

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

Field

Description

container_id

string

Required field. ID of the container to invoke.

path

string

Endpoint HTTP path to invoke.

service_account_id

string

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

retry_settings

RetrySettings

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

dead_letter_queue

PutQueueMessage

DLQ policy (no value means discarding a message).

Field

Description

gateway_id

string

Required field.

path

string

Required field.

service_account_id

string

Required field. sa which has permission for writing to websockets

Field

Description

queue_id

string

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

service_account_id

string

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

batch_settings

BatchSettings

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

visibility_timeout

google.protobuf.Duration

Queue visibility timeout override.

invoke_function

InvokeFunctionOnce

Instructions for invoking a function once.

Includes only one of the fields invoke_function, invoke_container, gateway_websocket_broadcast.

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

invoke_container

InvokeContainerOnce

Instructions for invoking a container once.

Includes only one of the fields invoke_function, invoke_container, gateway_websocket_broadcast.

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

gateway_websocket_broadcast

GatewayWebsocketBroadcast

Instructions for broadcasting to API gateway websocket once.

Includes only one of the fields invoke_function, invoke_container, gateway_websocket_broadcast.

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

Field

Description

size

int64

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

cutoff

google.protobuf.Duration

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

Field

Description

container_id

string

Required field. ID of the container to invoke.

path

string

Endpoint HTTP path to invoke.

service_account_id

string

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

Field

Description

registry_id

string

Required field. ID of the IoT Core registry.

device_id

string

ID of the IoT Core device in the registry.

mqtt_topic

string

MQTT topic whose messages activate the trigger.

batch_settings

BatchSettings

Batch settings for processing events.

invoke_function

InvokeFunctionWithRetry

Instructions for invoking a function with retries as needed.

Includes only one of the fields invoke_function, invoke_container, gateway_websocket_broadcast.

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

invoke_container

InvokeContainerWithRetry

Instructions for invoking a container with retries as needed.

Includes only one of the fields invoke_function, invoke_container, gateway_websocket_broadcast.

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

gateway_websocket_broadcast

GatewayWebsocketBroadcast

Instructions for broadcasting to API gateway websocket once.

Includes only one of the fields invoke_function, invoke_container, gateway_websocket_broadcast.

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

Field

Description

broker_id

string

Required field. ID of the IoT Core broker.

mqtt_topic

string

MQTT topic whose messages activate the trigger.

batch_settings

BatchSettings

Batch settings for processing events.

invoke_function

InvokeFunctionWithRetry

Instructions for invoking a function with retries as needed.

Includes only one of the fields invoke_function, invoke_container, gateway_websocket_broadcast.

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

invoke_container

InvokeContainerWithRetry

Instructions for invoking a container with retries as needed.

Includes only one of the fields invoke_function, invoke_container, gateway_websocket_broadcast.

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

gateway_websocket_broadcast

GatewayWebsocketBroadcast

Instructions for broadcasting to API gateway websocket once.

Includes only one of the fields invoke_function, invoke_container, gateway_websocket_broadcast.

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

Field

Description

event_type[]

enum ObjectStorageEventType

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

• OBJECT_STORAGE_EVENT_TYPE_UNSPECIFIED
• OBJECT_STORAGE_EVENT_TYPE_CREATE_OBJECT
• OBJECT_STORAGE_EVENT_TYPE_UPDATE_OBJECT
• OBJECT_STORAGE_EVENT_TYPE_DELETE_OBJECT

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.

batch_settings

BatchSettings

Batch settings for processing events.

invoke_function

InvokeFunctionWithRetry

Instructions for invoking a function with retries as needed.

Includes only one of the fields invoke_function, invoke_container, gateway_websocket_broadcast.

invoke_container

InvokeContainerWithRetry

Instructions for invoking a container with retries as needed.

Includes only one of the fields invoke_function, invoke_container, gateway_websocket_broadcast.

gateway_websocket_broadcast

GatewayWebsocketBroadcast

Instructions for broadcasting to API gateway websocket once.

Includes only one of the fields invoke_function, invoke_container, gateway_websocket_broadcast.

Field

Description

event_type[]

enum ContainerRegistryEventType

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

• CONTAINER_REGISTRY_EVENT_TYPE_UNSPECIFIED
• CONTAINER_REGISTRY_EVENT_TYPE_CREATE_IMAGE
• CONTAINER_REGISTRY_EVENT_TYPE_DELETE_IMAGE
• CONTAINER_REGISTRY_EVENT_TYPE_CREATE_IMAGE_TAG
• CONTAINER_REGISTRY_EVENT_TYPE_DELETE_IMAGE_TAG

registry_id

string

ID of the registry.

image_name

string

Docker-image name. Filter, optional.

tag

string

Docker-image tag. Filter, optional.

batch_settings

BatchSettings

Batch settings for processing events.

invoke_function

InvokeFunctionWithRetry

Instructions for invoking a function with retries as needed.

Includes only one of the fields invoke_function, invoke_container, gateway_websocket_broadcast.

invoke_container

InvokeContainerWithRetry

Instructions for invoking a container with retries as needed.

Includes only one of the fields invoke_function, invoke_container, gateway_websocket_broadcast.

gateway_websocket_broadcast

GatewayWebsocketBroadcast

Instructions for broadcasting to API gateway websocket once.

Includes only one of the fields invoke_function, invoke_container, gateway_websocket_broadcast.

Field

Description

log_group_id[]

string

Log group identifiers, at least one value is required.

batch_settings

CloudLogsBatchSettings

Required field. Batch settings for processing log events.

invoke_function

InvokeFunctionWithRetry

Instructions for invoking a function with retries as needed.

Includes only one of the fields invoke_function, invoke_container.

invoke_container

InvokeContainerWithRetry

Instructions for invoking a container with retries as needed.

Includes only one of the fields invoke_function, invoke_container.

Field

Description

size

int64

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

cutoff

google.protobuf.Duration

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

Field

Description

log_group_id

string

Log events filter settings.

resource_type[]

string

resource_id[]

string

stream_name[]

string

levels[]

enum Level

• LEVEL_UNSPECIFIED: Default log level.

  Equivalent to not specifying log level at all.

• TRACE: Trace log level.

  Possible use case: verbose logging of some business logic.

• DEBUG: Debug log level.

  Possible use case: debugging special cases in application logic.

• INFO: Info log level.

  Mostly used for information messages.

• WARN: Warn log level.

  May be used to alert about significant events.

• ERROR: Error log level.

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

• FATAL: Fatal log level.

  May be used to alert about unrecoverable failures and events.

batch_settings

LoggingBatchSettings

Required field. Batch settings for processing log events.

invoke_function

InvokeFunctionWithRetry

Instructions for invoking a function with retries as needed.

Includes only one of the fields invoke_function, invoke_container, gateway_websocket_broadcast.

invoke_container

InvokeContainerWithRetry

Instructions for invoking a container with retries as needed.

Includes only one of the fields invoke_function, invoke_container, gateway_websocket_broadcast.

gateway_websocket_broadcast

GatewayWebsocketBroadcast

Instructions for broadcasting to API gateway websocket once.

Includes only one of the fields invoke_function, invoke_container, gateway_websocket_broadcast.

Field

Description

size

int64

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

cutoff

google.protobuf.Duration

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

Field

Description

billing_account_id

string

Required field.

budget_id

string

invoke_function

InvokeFunctionWithRetry

Includes only one of the fields invoke_function, invoke_container, gateway_websocket_broadcast.

invoke_container

InvokeContainerWithRetry

Includes only one of the fields invoke_function, invoke_container, gateway_websocket_broadcast.

gateway_websocket_broadcast

GatewayWebsocketBroadcast

Includes only one of the fields invoke_function, invoke_container, gateway_websocket_broadcast.

Field

Description

endpoint

string

Data stream endpoint.

database

string

Data stream database.

stream

string

Stream name.

service_account_id

string

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

batch_settings

DataStreamBatchSettings

Batch settings for processing events.

invoke_function

InvokeFunctionWithRetry

Includes only one of the fields invoke_function, invoke_container, gateway_websocket_broadcast.

invoke_container

InvokeContainerWithRetry

Includes only one of the fields invoke_function, invoke_container, gateway_websocket_broadcast.

gateway_websocket_broadcast

GatewayWebsocketBroadcast

Includes only one of the fields invoke_function, invoke_container, gateway_websocket_broadcast.

Field

Description

size

int64

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

cutoff

google.protobuf.Duration

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

Field

Description

email

string

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

batch_settings

BatchSettings

Batch settings for processing events.

attachments_bucket

ObjectStorageBucketSettings

Bucket settings for saving attachments.

invoke_function

InvokeFunctionWithRetry

Includes only one of the fields invoke_function, invoke_container, gateway_websocket_broadcast.

invoke_container

InvokeContainerWithRetry

Includes only one of the fields invoke_function, invoke_container, gateway_websocket_broadcast.

gateway_websocket_broadcast

GatewayWebsocketBroadcast

Includes only one of the fields invoke_function, invoke_container, gateway_websocket_broadcast.

Field

Description

bucket_id

string

Bucket for saving.

service_account_id

string

Required field. SA which has write permission on storage.