Skip to main content

types

AndPredicate​

predicate : Predicate​

BatchSettings​

Settings for batch processing of messages in a queue.

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​

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.

BillingBudget​

billingAccountId : string​
budgetId : string​

One of action​

  • invokeFunction : InvokeFunctionWithRetry​
  • invokeContainer : InvokeContainerWithRetry​
  • gatewayWebsocketBroadcast : GatewayWebsocketBroadcast​

CloudLogsBatchSettings​

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.

DataStream​

endpoint : string​

Data stream endpoint.

database : string​

Data stream database.

stream : string​

Stream name.

serviceAccountId : string​

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

batchSettings : DataStreamBatchSettings​

Batch settings for processing events.

  • invokeFunction : InvokeFunctionWithRetry​
  • invokeContainer : InvokeContainerWithRetry​
  • gatewayWebsocketBroadcast : GatewayWebsocketBroadcast​

DataStreamBatchSettings​

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.

FieldValuePredicate​

fieldPath : string​

One of value​

  • exact : string​

    string representation of the value matches exactly to the given string

  • prefix : string​

    value has given prefix

  • suffix : string​

    value has given suffix

GatewayWebsocketBroadcast​

gatewayId : string​
path : string​
serviceAccountId : string​

sa which has permission for writing to websockets

InvokeContainerOnce​

A single container invocation.

containerId : string​

ID of the container to invoke.

path : string​

Endpoint HTTP path to invoke.

serviceAccountId : string​

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

InvokeContainerWithRetry​

A container invocation with retries.

containerId : string​

ID of the container to invoke.

path : string​

Endpoint HTTP path to invoke.

serviceAccountId : string​

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

retrySettings : RetrySettings​

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

deadLetterQueue : PutQueueMessage​

DLQ policy (no value means discarding a message).

InvokeFunctionOnce​

A single function invocation.

functionId : string​

ID of the function to invoke.

functionTag : string​

Version tag of the function to execute.

serviceAccountId : string​

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

InvokeFunctionWithRetry​

A function invocation with retries.

functionId : string​

ID of the function to invoke.

functionTag : string​

Version tag of the function to execute.

serviceAccountId : string​

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

retrySettings : RetrySettings​

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

deadLetterQueue : PutQueueMessage​

DLQ policy (no value means discarding a message).

LoggingBatchSettings​

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.

Mail​

email : string​

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

batchSettings : BatchSettings​

Batch settings for processing events.

attachmentsBucket : ObjectStorageBucketSettings​

Bucket settings for saving attachments.

  • invokeFunction : InvokeFunctionWithRetry​
  • invokeContainer : InvokeContainerWithRetry​
  • gatewayWebsocketBroadcast : GatewayWebsocketBroadcast​

ObjectStorageBucketSettings​

bucketId : string​

Bucket for saving.

serviceAccountId : string​

SA which has write permission on storage.

Predicate​

One of predicate​

  • andPredicate : AndPredicate​
  • fieldValuePredicate : FieldValuePredicate​

PutQueueMessage​

queueId : string​

ID of the queue.

serviceAccountId : string​

Service account which has write permission on the queue.

RetrySettings​

Settings for retrying to invoke a function.

retryAttempts : int64​

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

interval : google.protobuf.Duration​

Time in seconds to wait between individual retries.

Trigger​

A trigger to invoke a serverless function. For more information, see Triggers.

Rule​

Description of a rule for trigger activation.

One of rule​

  • timer : Timer​

    Rule for a timed trigger.

  • messageQueue : MessageQueue​

    Rule for a message queue trigger.

  • iotMessage : IoTMessage​

    Rule for a IoT Core trigger.

  • iotBrokerMessage : IoTBrokerMessage​
  • objectStorage : ObjectStorage​
  • containerRegistry : ContainerRegistry​
  • cloudLogs : CloudLogs​
  • logging : Logging​
  • billingBudget : BillingBudget​
  • dataStream : DataStream​

Timer​

Rule for activating a timed trigger.

cronExpression : string​

Description of a schedule as a cron expression.

payload : string​

Payload to be passed to function.

  • invokeFunction : InvokeFunctionOnce​

    Instructions for invoking a function once.

  • invokeFunctionWithRetry : InvokeFunctionWithRetry​

    Instructions for invoking a function with retry.

  • invokeContainerWithRetry : InvokeContainerWithRetry​

    Instructions for invoking a container with retry.

  • gatewayWebsocketBroadcast : GatewayWebsocketBroadcast​

    Instructions for broadcasting to API gateway websocket once.

MessageQueue​

Rule for activating a message queue trigger.

queueId : string​

ID of the message queue in Message Queue.

serviceAccountId : string​

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

batchSettings : BatchSettings​

Batch settings for processing messages in the queue.

visibilityTimeout : google.protobuf.Duration​

Queue visibility timeout override.

  • invokeFunction : InvokeFunctionOnce​

    Instructions for invoking a function once.

  • invokeContainer : InvokeContainerOnce​

    Instructions for invoking a container once.

  • gatewayWebsocketBroadcast : GatewayWebsocketBroadcast​

    Instructions for broadcasting to API gateway websocket once.

IoTMessage​

Rule for activating a IoT Core trigger.

registryId : string​

ID of the IoT Core registry.

deviceId : string​

ID of the IoT Core device in the registry.

mqttTopic : string​

MQTT topic whose messages activate the trigger.

batchSettings : BatchSettings​

Batch settings for processing events.

  • invokeFunction : InvokeFunctionWithRetry​

    Instructions for invoking a function with retries as needed.

  • invokeContainer : InvokeContainerWithRetry​

    Instructions for invoking a container with retries as needed.

  • gatewayWebsocketBroadcast : GatewayWebsocketBroadcast​

    Instructions for broadcasting to API gateway websocket once.

IoTBrokerMessage​

Rule for activating a IoT Core Broker trigger.

brokerId : string​

ID of the IoT Core broker.

mqttTopic : string​

MQTT topic whose messages activate the trigger.

batchSettings : BatchSettings​

Batch settings for processing events.

  • invokeFunction : InvokeFunctionWithRetry​

    Instructions for invoking a function with retries as needed.

  • invokeContainer : InvokeContainerWithRetry​

    Instructions for invoking a container with retries as needed.

  • gatewayWebsocketBroadcast : GatewayWebsocketBroadcast​

    Instructions for broadcasting to API gateway websocket once.

ObjectStorageEventType​

  • OBJECT_STORAGE_EVENT_TYPE_UNSPECIFIED

  • OBJECT_STORAGE_EVENT_TYPE_CREATE_OBJECT

  • OBJECT_STORAGE_EVENT_TYPE_UPDATE_OBJECT

  • OBJECT_STORAGE_EVENT_TYPE_DELETE_OBJECT

ObjectStorage​

eventType : ObjectStorageEventType​

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

bucketId : string​

ID of the bucket.

prefix : string​

Prefix of the object key. Filter, optional.

suffix : string​

Suffix of the object key. Filter, optional.

batchSettings : BatchSettings​

Batch settings for processing events.

  • invokeFunction : InvokeFunctionWithRetry​

    Instructions for invoking a function with retries as needed.

  • invokeContainer : InvokeContainerWithRetry​

    Instructions for invoking a container with retries as needed.

  • gatewayWebsocketBroadcast : GatewayWebsocketBroadcast​

    Instructions for broadcasting to API gateway websocket once.

ContainerRegistryEventType​

  • 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

ContainerRegistry​

eventType : ContainerRegistryEventType​

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

registryId : string​

ID of the registry.

imageName : string​

Docker-image name. Filter, optional.

tag : string​

Docker-image tag. Filter, optional.

batchSettings : BatchSettings​

Batch settings for processing events.

  • invokeFunction : InvokeFunctionWithRetry​

    Instructions for invoking a function with retries as needed.

  • invokeContainer : InvokeContainerWithRetry​

    Instructions for invoking a container with retries as needed.

  • gatewayWebsocketBroadcast : GatewayWebsocketBroadcast​

    Instructions for broadcasting to API gateway websocket once.

CloudLogs​

logGroupId : string​

Log group identifiers, at least one value is required.

batchSettings : CloudLogsBatchSettings​

Batch settings for processing log events.

  • invokeFunction : InvokeFunctionWithRetry​

    Instructions for invoking a function with retries as needed.

  • invokeContainer : InvokeContainerWithRetry​

    Instructions for invoking a container with retries as needed.

Logging​

logGroupId : string​

Log events filter settings.

resourceType : string​
resourceId : string​
streamName : string​
levels : yandex.cloud.logging.v1.LogLevel.Level​
batchSettings : LoggingBatchSettings​

Batch settings for processing log events.

  • invokeFunction : InvokeFunctionWithRetry​

    Instructions for invoking a function with retries as needed.

  • invokeContainer : InvokeContainerWithRetry​

    Instructions for invoking a container with retries as needed.

  • gatewayWebsocketBroadcast : GatewayWebsocketBroadcast​

    Instructions for broadcasting to API gateway websocket once.

Status​

  • STATUS_UNSPECIFIED

  • ACTIVE

  • PAUSED

id : string​

ID of the trigger. Generated at creation time.

folderId : string​

ID of the folder that the trigger belongs to.

createdAt : google.protobuf.Timestamp​

Creation timestamp for the trigger.

name : string​

Name of the trigger.

description : string​

Description of the trigger.

labels : string​

Trigger labels as key:value pairs.

rule : Rule​

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

status : Status​

Trigger status.