Yandex Cloud
  • Services
  • Solutions
  • Why Yandex Cloud
  • Blog
  • Pricing
  • Documentation
  • Contact us
Get started
Language / Region
Yandex project
© 2023 Intertech Services AG
Yandex Cloud Functions
  • Comparison with other Yandex Cloud services
  • Getting started
  • Step-by-step instructions
  • Concepts
  • Developing in Node.js
  • Developing in Python
  • Developing in Go
  • Developing in PHP
  • Developing in Bash
  • Developing in Java
  • Developing in R
  • Developing in C#
  • Practical guidelines
  • Pricing policy
  • Access management
  • API Functions reference
  • API Triggers reference
    • Authentication in the API
    • gRPC
    • REST
      • Overview
      • Trigger
        • Overview
        • create
        • delete
        • get
        • list
        • listOperations
        • pause
        • resume
        • update
  • Questions and answers
  1. API Triggers reference
  2. REST
  3. Trigger
  4. create

Cloud Functions Triggers Service, REST: Trigger.create

Written by
Yandex Cloud
,
improved by
amatol
  • HTTP request
  • Body parameters
  • Response

Creates a trigger in the specified folder.

HTTP request

POST https://serverless-triggers.api.cloud.yandex.net/triggers/v1/triggers

Body parameters

{
  "folderId": "string",
  "name": "string",
  "description": "string",
  "labels": "object",
  "rule": {

    // `rule` includes only one of the fields `timer`, `messageQueue`, `iotMessage`, `iotBrokerMessage`, `objectStorage`, `containerRegistry`, `cloudLogs`, `logging`, `billingBudget`, `dataStream`, `mail`
    "timer": {
      "cronExpression": "string",

      // `rule.timer` includes only one of the fields `invokeFunction`, `invokeFunctionWithRetry`, `invokeContainerWithRetry`
      "invokeFunction": {
        "functionId": "string",
        "functionTag": "string",
        "serviceAccountId": "string"
      },
      "invokeFunctionWithRetry": {
        "functionId": "string",
        "functionTag": "string",
        "serviceAccountId": "string",
        "retrySettings": {
          "retryAttempts": "string",
          "interval": "string"
        },
        "deadLetterQueue": {
          "queueId": "string",
          "serviceAccountId": "string"
        }
      },
      "invokeContainerWithRetry": {
        "containerId": "string",
        "path": "string",
        "serviceAccountId": "string",
        "retrySettings": {
          "retryAttempts": "string",
          "interval": "string"
        },
        "deadLetterQueue": {
          "queueId": "string",
          "serviceAccountId": "string"
        }
      },
      // end of the list of possible fields`rule.timer`

    },
    "messageQueue": {
      "queueId": "string",
      "serviceAccountId": "string",
      "batchSettings": {
        "size": "string",
        "cutoff": "string"
      },
      "visibilityTimeout": "string",

      // `rule.messageQueue` includes only one of the fields `invokeFunction`, `invokeContainer`
      "invokeFunction": {
        "functionId": "string",
        "functionTag": "string",
        "serviceAccountId": "string"
      },
      "invokeContainer": {
        "containerId": "string",
        "path": "string",
        "serviceAccountId": "string"
      },
      // end of the list of possible fields`rule.messageQueue`

    },
    "iotMessage": {
      "registryId": "string",
      "deviceId": "string",
      "mqttTopic": "string",

      // `rule.iotMessage` includes only one of the fields `invokeFunction`, `invokeContainer`
      "invokeFunction": {
        "functionId": "string",
        "functionTag": "string",
        "serviceAccountId": "string",
        "retrySettings": {
          "retryAttempts": "string",
          "interval": "string"
        },
        "deadLetterQueue": {
          "queueId": "string",
          "serviceAccountId": "string"
        }
      },
      "invokeContainer": {
        "containerId": "string",
        "path": "string",
        "serviceAccountId": "string",
        "retrySettings": {
          "retryAttempts": "string",
          "interval": "string"
        },
        "deadLetterQueue": {
          "queueId": "string",
          "serviceAccountId": "string"
        }
      },
      // end of the list of possible fields`rule.iotMessage`

    },
    "iotBrokerMessage": {
      "brokerId": "string",
      "mqttTopic": "string",

      // `rule.iotBrokerMessage` includes only one of the fields `invokeFunction`, `invokeContainer`
      "invokeFunction": {
        "functionId": "string",
        "functionTag": "string",
        "serviceAccountId": "string",
        "retrySettings": {
          "retryAttempts": "string",
          "interval": "string"
        },
        "deadLetterQueue": {
          "queueId": "string",
          "serviceAccountId": "string"
        }
      },
      "invokeContainer": {
        "containerId": "string",
        "path": "string",
        "serviceAccountId": "string",
        "retrySettings": {
          "retryAttempts": "string",
          "interval": "string"
        },
        "deadLetterQueue": {
          "queueId": "string",
          "serviceAccountId": "string"
        }
      },
      // end of the list of possible fields`rule.iotBrokerMessage`

    },
    "objectStorage": {
      "eventType": [
        "string"
      ],
      "bucketId": "string",
      "prefix": "string",
      "suffix": "string",

      // `rule.objectStorage` includes only one of the fields `invokeFunction`, `invokeContainer`
      "invokeFunction": {
        "functionId": "string",
        "functionTag": "string",
        "serviceAccountId": "string",
        "retrySettings": {
          "retryAttempts": "string",
          "interval": "string"
        },
        "deadLetterQueue": {
          "queueId": "string",
          "serviceAccountId": "string"
        }
      },
      "invokeContainer": {
        "containerId": "string",
        "path": "string",
        "serviceAccountId": "string",
        "retrySettings": {
          "retryAttempts": "string",
          "interval": "string"
        },
        "deadLetterQueue": {
          "queueId": "string",
          "serviceAccountId": "string"
        }
      },
      // end of the list of possible fields`rule.objectStorage`

    },
    "containerRegistry": {
      "eventType": [
        "string"
      ],
      "registryId": "string",
      "imageName": "string",
      "tag": "string",

      // `rule.containerRegistry` includes only one of the fields `invokeFunction`, `invokeContainer`
      "invokeFunction": {
        "functionId": "string",
        "functionTag": "string",
        "serviceAccountId": "string",
        "retrySettings": {
          "retryAttempts": "string",
          "interval": "string"
        },
        "deadLetterQueue": {
          "queueId": "string",
          "serviceAccountId": "string"
        }
      },
      "invokeContainer": {
        "containerId": "string",
        "path": "string",
        "serviceAccountId": "string",
        "retrySettings": {
          "retryAttempts": "string",
          "interval": "string"
        },
        "deadLetterQueue": {
          "queueId": "string",
          "serviceAccountId": "string"
        }
      },
      // end of the list of possible fields`rule.containerRegistry`

    },
    "cloudLogs": {
      "logGroupId": [
        "string"
      ],
      "batchSettings": {
        "size": "string",
        "cutoff": "string"
      },

      // `rule.cloudLogs` includes only one of the fields `invokeFunction`, `invokeContainer`
      "invokeFunction": {
        "functionId": "string",
        "functionTag": "string",
        "serviceAccountId": "string",
        "retrySettings": {
          "retryAttempts": "string",
          "interval": "string"
        },
        "deadLetterQueue": {
          "queueId": "string",
          "serviceAccountId": "string"
        }
      },
      "invokeContainer": {
        "containerId": "string",
        "path": "string",
        "serviceAccountId": "string",
        "retrySettings": {
          "retryAttempts": "string",
          "interval": "string"
        },
        "deadLetterQueue": {
          "queueId": "string",
          "serviceAccountId": "string"
        }
      },
      // end of the list of possible fields`rule.cloudLogs`

    },
    "logging": {
      "logGroupId": "string",
      "resourceType": [
        "string"
      ],
      "resourceId": [
        "string"
      ],
      "levels": [
        "string"
      ],
      "batchSettings": {
        "size": "string",
        "cutoff": "string"
      },

      // `rule.logging` includes only one of the fields `invokeFunction`, `invokeContainer`
      "invokeFunction": {
        "functionId": "string",
        "functionTag": "string",
        "serviceAccountId": "string",
        "retrySettings": {
          "retryAttempts": "string",
          "interval": "string"
        },
        "deadLetterQueue": {
          "queueId": "string",
          "serviceAccountId": "string"
        }
      },
      "invokeContainer": {
        "containerId": "string",
        "path": "string",
        "serviceAccountId": "string",
        "retrySettings": {
          "retryAttempts": "string",
          "interval": "string"
        },
        "deadLetterQueue": {
          "queueId": "string",
          "serviceAccountId": "string"
        }
      },
      // end of the list of possible fields`rule.logging`

    },
    "billingBudget": {
      "billingAccountId": "string",
      "budgetId": "string",

      // `rule.billingBudget` includes only one of the fields `invokeFunction`, `invokeContainer`
      "invokeFunction": {
        "functionId": "string",
        "functionTag": "string",
        "serviceAccountId": "string",
        "retrySettings": {
          "retryAttempts": "string",
          "interval": "string"
        },
        "deadLetterQueue": {
          "queueId": "string",
          "serviceAccountId": "string"
        }
      },
      "invokeContainer": {
        "containerId": "string",
        "path": "string",
        "serviceAccountId": "string",
        "retrySettings": {
          "retryAttempts": "string",
          "interval": "string"
        },
        "deadLetterQueue": {
          "queueId": "string",
          "serviceAccountId": "string"
        }
      },
      // end of the list of possible fields`rule.billingBudget`

    },
    "dataStream": {
      "endpoint": "string",
      "database": "string",
      "stream": "string",
      "serviceAccountId": "string",
      "batchSettings": {
        "size": "string",
        "cutoff": "string"
      },

      // `rule.dataStream` includes only one of the fields `invokeFunction`, `invokeContainer`
      "invokeFunction": {
        "functionId": "string",
        "functionTag": "string",
        "serviceAccountId": "string",
        "retrySettings": {
          "retryAttempts": "string",
          "interval": "string"
        },
        "deadLetterQueue": {
          "queueId": "string",
          "serviceAccountId": "string"
        }
      },
      "invokeContainer": {
        "containerId": "string",
        "path": "string",
        "serviceAccountId": "string",
        "retrySettings": {
          "retryAttempts": "string",
          "interval": "string"
        },
        "deadLetterQueue": {
          "queueId": "string",
          "serviceAccountId": "string"
        }
      },
      // end of the list of possible fields`rule.dataStream`

    },
    "mail": {
      "email": "string",

      // `rule.mail` includes only one of the fields `invokeFunction`, `invokeContainer`
      "invokeFunction": {
        "functionId": "string",
        "functionTag": "string",
        "serviceAccountId": "string",
        "retrySettings": {
          "retryAttempts": "string",
          "interval": "string"
        },
        "deadLetterQueue": {
          "queueId": "string",
          "serviceAccountId": "string"
        }
      },
      "invokeContainer": {
        "containerId": "string",
        "path": "string",
        "serviceAccountId": "string",
        "retrySettings": {
          "retryAttempts": "string",
          "interval": "string"
        },
        "deadLetterQueue": {
          "queueId": "string",
          "serviceAccountId": "string"
        }
      },
      // end of the list of possible fields`rule.mail`

    },
    // end of the list of possible fields`rule`

  }
}
Field Description
folderId string

Required. ID of the folder to create a trigger in.

To get a folder ID make a list request.

name string

Name of the trigger. The name must be unique within the folder.

Value must match the regular expression |[a-z][-a-z0-9]{1,61}[a-z0-9].

description string

Description of the trigger.

The maximum string length in characters is 256.

labels object

Resource labels as key:value pairs.

No more than 64 per resource. The string length in characters for each key must be 1-63. Each key must match the regular expression [a-z][-_0-9a-z]*. The maximum string length in characters for each value is 63. Each value must match the regular expression [-_0-9a-z]*.

rule object

Required. Trigger type.

Description of a rule for trigger activation.

rule.
timer
object
Rule for a timed trigger.
rule includes only one of the fields timer, messageQueue, iotMessage, iotBrokerMessage, objectStorage, containerRegistry, cloudLogs, logging, billingBudget, dataStream, mail
rule.
timer.
cronExpression
string

Required. Description of a schedule as a cron expression.

The maximum string length in characters is 100.

rule.
timer.
invokeFunction
object
Instructions for invoking a function once.
rule.timer includes only one of the fields invokeFunction, invokeFunctionWithRetry, invokeContainerWithRetry
rule.
timer.
invokeFunction.
functionId
string

Required. ID of the function to invoke.

The maximum string length in characters is 50.

rule.
timer.
invokeFunction.
functionTag
string

Version tag of the function to execute.

rule.
timer.
invokeFunction.
serviceAccountId
string

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

rule.
timer.
invokeFunctionWithRetry
object
Instructions for invoking a function with retries as needed.
rule.timer includes only one of the fields invokeFunction, invokeFunctionWithRetry, invokeContainerWithRetry
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.
timer.
invokeContainerWithRetry
object
Instructions for invoking a container with retries as needed.
rule.timer includes only one of the fields invokeFunction, invokeFunctionWithRetry, invokeContainerWithRetry
rule.
timer.
invokeContainerWithRetry.
containerId
string

Required. ID of the container to invoke.

The maximum string length in characters is 50.

rule.
timer.
invokeContainerWithRetry.
path
string

Endpoint HTTP path to invoke.

rule.
timer.
invokeContainerWithRetry.
serviceAccountId
string

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

rule.
timer.
invokeContainerWithRetry.
retrySettings
object

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

Settings for retrying to invoke a function.

rule.
timer.
invokeContainerWithRetry.
retrySettings.
retryAttempts
string (int64)

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

Acceptable values are 1 to 5, inclusive.

rule.
timer.
invokeContainerWithRetry.
retrySettings.
interval
string

Required. Time in seconds to wait between individual retries.

rule.
timer.
invokeContainerWithRetry.
deadLetterQueue
object

DLQ policy (no value means discarding a message).

rule.
timer.
invokeContainerWithRetry.
deadLetterQueue.
queueId
string

ID of the queue.

rule.
timer.
invokeContainerWithRetry.
deadLetterQueue.
serviceAccountId
string

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

The maximum string length in characters is 50.

rule.
messageQueue
object
Rule for a message queue trigger.
rule includes only one of the fields timer, messageQueue, iotMessage, iotBrokerMessage, objectStorage, containerRegistry, cloudLogs, logging, billingBudget, dataStream, mail
rule.
messageQueue.
queueId
string

Required. ID of the message queue in Message Queue.

rule.
messageQueue.
serviceAccountId
string

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

The maximum string length in characters is 50.

rule.
messageQueue.
batchSettings
object
Required. Batch settings for processing messages in the queue.
rule.
messageQueue.
batchSettings.
size
string (int64)

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

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 size, or the cutoff time has passed.

rule.
messageQueue.
visibilityTimeout
string

Queue visibility timeout override.

The maximum value is 43200 seconds.

rule.
messageQueue.
invokeFunction
object
Instructions for invoking a function once.
rule.messageQueue includes only one of the fields invokeFunction, invokeContainer
rule.
messageQueue.
invokeFunction.
functionId
string

Required. ID of the function to invoke.

The maximum string length in characters is 50.

rule.
messageQueue.
invokeFunction.
functionTag
string

Version tag of the function to execute.

rule.
messageQueue.
invokeFunction.
serviceAccountId
string

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

rule.
messageQueue.
invokeContainer
object
Instructions for invoking a container once.
rule.messageQueue includes only one of the fields invokeFunction, invokeContainer
rule.
messageQueue.
invokeContainer.
containerId
string

Required. ID of the container to invoke.

The maximum string length in characters is 50.

rule.
messageQueue.
invokeContainer.
path
string

Endpoint HTTP path to invoke.

rule.
messageQueue.
invokeContainer.
serviceAccountId
string

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

rule.
iotMessage
object
Rule for a IoT Core trigger.
rule includes only one of the fields timer, messageQueue, iotMessage, iotBrokerMessage, objectStorage, containerRegistry, cloudLogs, logging, billingBudget, dataStream, mail
rule.
iotMessage.
registryId
string

Required. ID of the IoT Core registry.

rule.
iotMessage.
deviceId
string

ID of the IoT Core device in the registry.

rule.
iotMessage.
mqttTopic
string

MQTT topic whose messages activate the trigger.

rule.
iotMessage.
invokeFunction
object
Instructions for invoking a function with retry.
rule.iotMessage includes only one of the fields invokeFunction, invokeContainer
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.
iotMessage.
invokeContainer
object
Instructions for invoking a container with retry.
rule.iotMessage includes only one of the fields invokeFunction, invokeContainer
rule.
iotMessage.
invokeContainer.
containerId
string

Required. ID of the container to invoke.

The maximum string length in characters is 50.

rule.
iotMessage.
invokeContainer.
path
string

Endpoint HTTP path to invoke.

rule.
iotMessage.
invokeContainer.
serviceAccountId
string

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

rule.
iotMessage.
invokeContainer.
retrySettings
object

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

Settings for retrying to invoke a function.

rule.
iotMessage.
invokeContainer.
retrySettings.
retryAttempts
string (int64)

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

Acceptable values are 1 to 5, inclusive.

rule.
iotMessage.
invokeContainer.
retrySettings.
interval
string

Required. Time in seconds to wait between individual retries.

rule.
iotMessage.
invokeContainer.
deadLetterQueue
object

DLQ policy (no value means discarding a message).

rule.
iotMessage.
invokeContainer.
deadLetterQueue.
queueId
string

ID of the queue.

rule.
iotMessage.
invokeContainer.
deadLetterQueue.
serviceAccountId
string

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

The maximum string length in characters is 50.

rule.
iotBrokerMessage
object
rule includes only one of the fields timer, messageQueue, iotMessage, iotBrokerMessage, objectStorage, containerRegistry, cloudLogs, logging, billingBudget, dataStream, mail

Rule for activating a IoT Core Broker trigger.

rule.
iotBrokerMessage.
brokerId
string

Required. ID of the IoT Core broker.

rule.
iotBrokerMessage.
mqttTopic
string

MQTT topic whose messages activate the trigger.

rule.
iotBrokerMessage.
invokeFunction
object
Instructions for invoking a function with retries as needed.
rule.iotBrokerMessage includes only one of the fields invokeFunction, invokeContainer
rule.
iotBrokerMessage.
invokeFunction.
functionId
string

Required. ID of the function to invoke.

The maximum string length in characters is 50.

rule.
iotBrokerMessage.
invokeFunction.
functionTag
string

Version tag of the function to execute.

rule.
iotBrokerMessage.
invokeFunction.
serviceAccountId
string

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

rule.
iotBrokerMessage.
invokeFunction.
retrySettings
object

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

Settings for retrying to invoke a function.

rule.
iotBrokerMessage.
invokeFunction.
retrySettings.
retryAttempts
string (int64)

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

Acceptable values are 1 to 5, inclusive.

rule.
iotBrokerMessage.
invokeFunction.
retrySettings.
interval
string

Required. Time in seconds to wait between individual retries.

rule.
iotBrokerMessage.
invokeFunction.
deadLetterQueue
object

DLQ policy (no value means discarding a message).

rule.
iotBrokerMessage.
invokeFunction.
deadLetterQueue.
queueId
string

ID of the queue.

rule.
iotBrokerMessage.
invokeFunction.
deadLetterQueue.
serviceAccountId
string

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

The maximum string length in characters is 50.

rule.
iotBrokerMessage.
invokeContainer
object
Instructions for invoking a container with retries as needed.
rule.iotBrokerMessage includes only one of the fields invokeFunction, invokeContainer
rule.
iotBrokerMessage.
invokeContainer.
containerId
string

Required. ID of the container to invoke.

The maximum string length in characters is 50.

rule.
iotBrokerMessage.
invokeContainer.
path
string

Endpoint HTTP path to invoke.

rule.
iotBrokerMessage.
invokeContainer.
serviceAccountId
string

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

rule.
iotBrokerMessage.
invokeContainer.
retrySettings
object

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

Settings for retrying to invoke a function.

rule.
iotBrokerMessage.
invokeContainer.
retrySettings.
retryAttempts
string (int64)

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

Acceptable values are 1 to 5, inclusive.

rule.
iotBrokerMessage.
invokeContainer.
retrySettings.
interval
string

Required. Time in seconds to wait between individual retries.

rule.
iotBrokerMessage.
invokeContainer.
deadLetterQueue
object

DLQ policy (no value means discarding a message).

rule.
iotBrokerMessage.
invokeContainer.
deadLetterQueue.
queueId
string

ID of the queue.

rule.
iotBrokerMessage.
invokeContainer.
deadLetterQueue.
serviceAccountId
string

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

The maximum string length in characters is 50.

rule.
objectStorage
object
rule includes only one of the fields timer, messageQueue, iotMessage, iotBrokerMessage, objectStorage, containerRegistry, cloudLogs, logging, billingBudget, dataStream, mail
rule.
objectStorage.
eventType[]
string

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

Must contain at least one element.

rule.
objectStorage.
bucketId
string

ID of the bucket.

rule.
objectStorage.
prefix
string

Prefix of the object key. Filter, optional.

rule.
objectStorage.
suffix
string

Suffix of the object key. Filter, optional.

rule.
objectStorage.
invokeFunction
object
Instructions for invoking a function with retries as needed.
rule.objectStorage includes only one of the fields invokeFunction, invokeContainer
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.
objectStorage.
invokeContainer
object
Instructions for invoking a container with retries as needed.
rule.objectStorage includes only one of the fields invokeFunction, invokeContainer
rule.
objectStorage.
invokeContainer.
containerId
string

Required. ID of the container to invoke.

The maximum string length in characters is 50.

rule.
objectStorage.
invokeContainer.
path
string

Endpoint HTTP path to invoke.

rule.
objectStorage.
invokeContainer.
serviceAccountId
string

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

rule.
objectStorage.
invokeContainer.
retrySettings
object

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

Settings for retrying to invoke a function.

rule.
objectStorage.
invokeContainer.
retrySettings.
retryAttempts
string (int64)

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

Acceptable values are 1 to 5, inclusive.

rule.
objectStorage.
invokeContainer.
retrySettings.
interval
string

Required. Time in seconds to wait between individual retries.

rule.
objectStorage.
invokeContainer.
deadLetterQueue
object

DLQ policy (no value means discarding a message).

rule.
objectStorage.
invokeContainer.
deadLetterQueue.
queueId
string

ID of the queue.

rule.
objectStorage.
invokeContainer.
deadLetterQueue.
serviceAccountId
string

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

The maximum string length in characters is 50.

rule.
containerRegistry
object
rule includes only one of the fields timer, messageQueue, iotMessage, iotBrokerMessage, objectStorage, containerRegistry, cloudLogs, logging, billingBudget, dataStream, mail
rule.
containerRegistry.
eventType[]
string

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

Must contain at least one element.

rule.
containerRegistry.
registryId
string

ID of the registry.

rule.
containerRegistry.
imageName
string

Docker-image name. Filter, optional.

rule.
containerRegistry.
tag
string

Docker-image tag. Filter, optional.

rule.
containerRegistry.
invokeFunction
object
Instructions for invoking a function with retries as needed.
rule.containerRegistry includes only one of the fields invokeFunction, invokeContainer
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.
containerRegistry.
invokeContainer
object
Instructions for invoking a container with retries as needed.
rule.containerRegistry includes only one of the fields invokeFunction, invokeContainer
rule.
containerRegistry.
invokeContainer.
containerId
string

Required. ID of the container to invoke.

The maximum string length in characters is 50.

rule.
containerRegistry.
invokeContainer.
path
string

Endpoint HTTP path to invoke.

rule.
containerRegistry.
invokeContainer.
serviceAccountId
string

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

rule.
containerRegistry.
invokeContainer.
retrySettings
object

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

Settings for retrying to invoke a function.

rule.
containerRegistry.
invokeContainer.
retrySettings.
retryAttempts
string (int64)

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

Acceptable values are 1 to 5, inclusive.

rule.
containerRegistry.
invokeContainer.
retrySettings.
interval
string

Required. Time in seconds to wait between individual retries.

rule.
containerRegistry.
invokeContainer.
deadLetterQueue
object

DLQ policy (no value means discarding a message).

rule.
containerRegistry.
invokeContainer.
deadLetterQueue.
queueId
string

ID of the queue.

rule.
containerRegistry.
invokeContainer.
deadLetterQueue.
serviceAccountId
string

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

The maximum string length in characters is 50.

rule.
cloudLogs
object
rule includes only one of the fields timer, messageQueue, iotMessage, iotBrokerMessage, objectStorage, containerRegistry, cloudLogs, logging, billingBudget, dataStream, mail
rule.
cloudLogs.
logGroupId[]
string

Log group identifiers, at least one value is required.

rule.
cloudLogs.
batchSettings
object
Required. Batch settings for processing log events.
rule.
cloudLogs.
batchSettings.
size
string (int64)

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

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 size, or the cutoff time has passed.

Acceptable values are 1 seconds to 60 seconds, inclusive.

rule.
cloudLogs.
invokeFunction
object
Instructions for invoking a function with retries as needed.
rule.cloudLogs includes only one of the fields invokeFunction, invokeContainer
rule.
cloudLogs.
invokeFunction.
functionId
string

Required. ID of the function to invoke.

The maximum string length in characters is 50.

rule.
cloudLogs.
invokeFunction.
functionTag
string

Version tag of the function to execute.

rule.
cloudLogs.
invokeFunction.
serviceAccountId
string

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

rule.
cloudLogs.
invokeFunction.
retrySettings
object

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

Settings for retrying to invoke a function.

rule.
cloudLogs.
invokeFunction.
retrySettings.
retryAttempts
string (int64)

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

Acceptable values are 1 to 5, inclusive.

rule.
cloudLogs.
invokeFunction.
retrySettings.
interval
string

Required. Time in seconds to wait between individual retries.

rule.
cloudLogs.
invokeFunction.
deadLetterQueue
object

DLQ policy (no value means discarding a message).

rule.
cloudLogs.
invokeFunction.
deadLetterQueue.
queueId
string

ID of the queue.

rule.
cloudLogs.
invokeFunction.
deadLetterQueue.
serviceAccountId
string

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

The maximum string length in characters is 50.

rule.
cloudLogs.
invokeContainer
object
Instructions for invoking a container with retries as needed.
rule.cloudLogs includes only one of the fields invokeFunction, invokeContainer
rule.
cloudLogs.
invokeContainer.
containerId
string

Required. ID of the container to invoke.

The maximum string length in characters is 50.

rule.
cloudLogs.
invokeContainer.
path
string

Endpoint HTTP path to invoke.

rule.
cloudLogs.
invokeContainer.
serviceAccountId
string

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

rule.
cloudLogs.
invokeContainer.
retrySettings
object

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

Settings for retrying to invoke a function.

rule.
cloudLogs.
invokeContainer.
retrySettings.
retryAttempts
string (int64)

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

Acceptable values are 1 to 5, inclusive.

rule.
cloudLogs.
invokeContainer.
retrySettings.
interval
string

Required. Time in seconds to wait between individual retries.

rule.
cloudLogs.
invokeContainer.
deadLetterQueue
object

DLQ policy (no value means discarding a message).

rule.
cloudLogs.
invokeContainer.
deadLetterQueue.
queueId
string

ID of the queue.

rule.
cloudLogs.
invokeContainer.
deadLetterQueue.
serviceAccountId
string

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

The maximum string length in characters is 50.

rule.
logging
object
rule includes only one of the fields timer, messageQueue, iotMessage, iotBrokerMessage, objectStorage, containerRegistry, cloudLogs, logging, billingBudget, dataStream, mail
rule.
logging.
logGroupId
string

Log events filter settings.

The maximum string length in characters is 50.

rule.
logging.
resourceType[]
string

The maximum number of elements is 100. Each value must match the regular expression [a-zA-Z][-a-zA-Z0-9_.]{1,62}.

rule.
logging.
resourceId[]
string

The maximum number of elements is 100. Each value must match the regular expression [a-zA-Z][-a-zA-Z0-9_.]{1,62}.

rule.
logging.
levels[]
string

The maximum number of elements is 10.

  • 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.

rule.
logging.
batchSettings
object
Required. Batch settings for processing log events.
rule.
logging.
batchSettings.
size
string (int64)

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

Acceptable values are 1 to 100, inclusive.

rule.
logging.
batchSettings.
cutoff
string

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.

Acceptable values are 1 seconds to 60 seconds, inclusive.

rule.
logging.
invokeFunction
object
Instructions for invoking a function with retries as needed.
rule.logging includes only one of the fields invokeFunction, invokeContainer
rule.
logging.
invokeFunction.
functionId
string

Required. ID of the function to invoke.

The maximum string length in characters is 50.

rule.
logging.
invokeFunction.
functionTag
string

Version tag of the function to execute.

rule.
logging.
invokeFunction.
serviceAccountId
string

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

rule.
logging.
invokeFunction.
retrySettings
object

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

Settings for retrying to invoke a function.

rule.
logging.
invokeFunction.
retrySettings.
retryAttempts
string (int64)

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

Acceptable values are 1 to 5, inclusive.

rule.
logging.
invokeFunction.
retrySettings.
interval
string

Required. Time in seconds to wait between individual retries.

rule.
logging.
invokeFunction.
deadLetterQueue
object

DLQ policy (no value means discarding a message).

rule.
logging.
invokeFunction.
deadLetterQueue.
queueId
string

ID of the queue.

rule.
logging.
invokeFunction.
deadLetterQueue.
serviceAccountId
string

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

The maximum string length in characters is 50.

rule.
logging.
invokeContainer
object
Instructions for invoking a container with retries as needed.
rule.logging includes only one of the fields invokeFunction, invokeContainer
rule.
logging.
invokeContainer.
containerId
string

Required. ID of the container to invoke.

The maximum string length in characters is 50.

rule.
logging.
invokeContainer.
path
string

Endpoint HTTP path to invoke.

rule.
logging.
invokeContainer.
serviceAccountId
string

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

rule.
logging.
invokeContainer.
retrySettings
object

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

Settings for retrying to invoke a function.

rule.
logging.
invokeContainer.
retrySettings.
retryAttempts
string (int64)

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

Acceptable values are 1 to 5, inclusive.

rule.
logging.
invokeContainer.
retrySettings.
interval
string

Required. Time in seconds to wait between individual retries.

rule.
logging.
invokeContainer.
deadLetterQueue
object

DLQ policy (no value means discarding a message).

rule.
logging.
invokeContainer.
deadLetterQueue.
queueId
string

ID of the queue.

rule.
logging.
invokeContainer.
deadLetterQueue.
serviceAccountId
string

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

The maximum string length in characters is 50.

rule.
billingBudget
object
rule includes only one of the fields timer, messageQueue, iotMessage, iotBrokerMessage, objectStorage, containerRegistry, cloudLogs, logging, billingBudget, dataStream, mail
rule.
billingBudget.
billingAccountId
string

Required. The maximum string length in characters is 50.

rule.
billingBudget.
budgetId
string

The maximum string length in characters is 50.

rule.
billingBudget.
invokeFunction
object
Instructions for invoking a function with retries as needed.
rule.billingBudget includes only one of the fields invokeFunction, invokeContainer
rule.
billingBudget.
invokeFunction.
functionId
string

Required. ID of the function to invoke.

The maximum string length in characters is 50.

rule.
billingBudget.
invokeFunction.
functionTag
string

Version tag of the function to execute.

rule.
billingBudget.
invokeFunction.
serviceAccountId
string

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

rule.
billingBudget.
invokeFunction.
retrySettings
object

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

Settings for retrying to invoke a function.

rule.
billingBudget.
invokeFunction.
retrySettings.
retryAttempts
string (int64)

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

Acceptable values are 1 to 5, inclusive.

rule.
billingBudget.
invokeFunction.
retrySettings.
interval
string

Required. Time in seconds to wait between individual retries.

rule.
billingBudget.
invokeFunction.
deadLetterQueue
object

DLQ policy (no value means discarding a message).

rule.
billingBudget.
invokeFunction.
deadLetterQueue.
queueId
string

ID of the queue.

rule.
billingBudget.
invokeFunction.
deadLetterQueue.
serviceAccountId
string

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

The maximum string length in characters is 50.

rule.
billingBudget.
invokeContainer
object
Instructions for invoking a container with retries as needed.
rule.billingBudget includes only one of the fields invokeFunction, invokeContainer
rule.
billingBudget.
invokeContainer.
containerId
string

Required. ID of the container to invoke.

The maximum string length in characters is 50.

rule.
billingBudget.
invokeContainer.
path
string

Endpoint HTTP path to invoke.

rule.
billingBudget.
invokeContainer.
serviceAccountId
string

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

rule.
billingBudget.
invokeContainer.
retrySettings
object

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

Settings for retrying to invoke a function.

rule.
billingBudget.
invokeContainer.
retrySettings.
retryAttempts
string (int64)

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

Acceptable values are 1 to 5, inclusive.

rule.
billingBudget.
invokeContainer.
retrySettings.
interval
string

Required. Time in seconds to wait between individual retries.

rule.
billingBudget.
invokeContainer.
deadLetterQueue
object

DLQ policy (no value means discarding a message).

rule.
billingBudget.
invokeContainer.
deadLetterQueue.
queueId
string

ID of the queue.

rule.
billingBudget.
invokeContainer.
deadLetterQueue.
serviceAccountId
string

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

The maximum string length in characters is 50.

rule.
dataStream
object
rule includes only one of the fields timer, messageQueue, iotMessage, iotBrokerMessage, objectStorage, containerRegistry, cloudLogs, logging, billingBudget, dataStream, mail
rule.
dataStream.
endpoint
string

Data stream endpoint.

rule.
dataStream.
database
string

Data stream database.

rule.
dataStream.
stream
string

Stream name.

rule.
dataStream.
serviceAccountId
string

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

rule.
dataStream.
batchSettings
object
Batch settings for processing events.
rule.
dataStream.
batchSettings.
size
string (int64)

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

Acceptable values are 1 to 65536, inclusive.

rule.
dataStream.
batchSettings.
cutoff
string

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

Acceptable values are 1 seconds to 60 seconds, inclusive.

rule.
dataStream.
invokeFunction
object
Instructions for invoking a function with retries as needed.
rule.dataStream includes only one of the fields invokeFunction, invokeContainer
rule.
dataStream.
invokeFunction.
functionId
string

Required. ID of the function to invoke.

The maximum string length in characters is 50.

rule.
dataStream.
invokeFunction.
functionTag
string

Version tag of the function to execute.

rule.
dataStream.
invokeFunction.
serviceAccountId
string

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

rule.
dataStream.
invokeFunction.
retrySettings
object

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

Settings for retrying to invoke a function.

rule.
dataStream.
invokeFunction.
retrySettings.
retryAttempts
string (int64)

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

Acceptable values are 1 to 5, inclusive.

rule.
dataStream.
invokeFunction.
retrySettings.
interval
string

Required. Time in seconds to wait between individual retries.

rule.
dataStream.
invokeFunction.
deadLetterQueue
object

DLQ policy (no value means discarding a message).

rule.
dataStream.
invokeFunction.
deadLetterQueue.
queueId
string

ID of the queue.

rule.
dataStream.
invokeFunction.
deadLetterQueue.
serviceAccountId
string

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

The maximum string length in characters is 50.

rule.
dataStream.
invokeContainer
object
Instructions for invoking a container with retries as needed.
rule.dataStream includes only one of the fields invokeFunction, invokeContainer
rule.
dataStream.
invokeContainer.
containerId
string

Required. ID of the container to invoke.

The maximum string length in characters is 50.

rule.
dataStream.
invokeContainer.
path
string

Endpoint HTTP path to invoke.

rule.
dataStream.
invokeContainer.
serviceAccountId
string

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

rule.
dataStream.
invokeContainer.
retrySettings
object

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

Settings for retrying to invoke a function.

rule.
dataStream.
invokeContainer.
retrySettings.
retryAttempts
string (int64)

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

Acceptable values are 1 to 5, inclusive.

rule.
dataStream.
invokeContainer.
retrySettings.
interval
string

Required. Time in seconds to wait between individual retries.

rule.
dataStream.
invokeContainer.
deadLetterQueue
object

DLQ policy (no value means discarding a message).

rule.
dataStream.
invokeContainer.
deadLetterQueue.
queueId
string

ID of the queue.

rule.
dataStream.
invokeContainer.
deadLetterQueue.
serviceAccountId
string

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

The maximum string length in characters is 50.

rule.
mail
object
rule includes only one of the fields timer, messageQueue, iotMessage, iotBrokerMessage, objectStorage, containerRegistry, cloudLogs, logging, billingBudget, dataStream, mail
rule.
mail.
email
string

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

rule.
mail.
invokeFunction
object
Instructions for invoking a function with retries as needed.
rule.mail includes only one of the fields invokeFunction, invokeContainer
rule.
mail.
invokeFunction.
functionId
string

Required. ID of the function to invoke.

The maximum string length in characters is 50.

rule.
mail.
invokeFunction.
functionTag
string

Version tag of the function to execute.

rule.
mail.
invokeFunction.
serviceAccountId
string

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

rule.
mail.
invokeFunction.
retrySettings
object

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

Settings for retrying to invoke a function.

rule.
mail.
invokeFunction.
retrySettings.
retryAttempts
string (int64)

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

Acceptable values are 1 to 5, inclusive.

rule.
mail.
invokeFunction.
retrySettings.
interval
string

Required. Time in seconds to wait between individual retries.

rule.
mail.
invokeFunction.
deadLetterQueue
object

DLQ policy (no value means discarding a message).

rule.
mail.
invokeFunction.
deadLetterQueue.
queueId
string

ID of the queue.

rule.
mail.
invokeFunction.
deadLetterQueue.
serviceAccountId
string

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

The maximum string length in characters is 50.

rule.
mail.
invokeContainer
object
Instructions for invoking a container with retries as needed.
rule.mail includes only one of the fields invokeFunction, invokeContainer
rule.
mail.
invokeContainer.
containerId
string

Required. ID of the container to invoke.

The maximum string length in characters is 50.

rule.
mail.
invokeContainer.
path
string

Endpoint HTTP path to invoke.

rule.
mail.
invokeContainer.
serviceAccountId
string

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

rule.
mail.
invokeContainer.
retrySettings
object

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

Settings for retrying to invoke a function.

rule.
mail.
invokeContainer.
retrySettings.
retryAttempts
string (int64)

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

Acceptable values are 1 to 5, inclusive.

rule.
mail.
invokeContainer.
retrySettings.
interval
string

Required. Time in seconds to wait between individual retries.

rule.
mail.
invokeContainer.
deadLetterQueue
object

DLQ policy (no value means discarding a message).

rule.
mail.
invokeContainer.
deadLetterQueue.
queueId
string

ID of the queue.

rule.
mail.
invokeContainer.
deadLetterQueue.
serviceAccountId
string

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

The maximum string length in characters is 50.

Response

HTTP Code: 200 - OK

{
  "id": "string",
  "description": "string",
  "createdAt": "string",
  "createdBy": "string",
  "modifiedAt": "string",
  "done": true,
  "metadata": "object",

  //  includes only one of the fields `error`, `response`
  "error": {
    "code": "integer",
    "message": "string",
    "details": [
      "object"
    ]
  },
  "response": "object",
  // end of the list of possible fields

}

An Operation resource. For more information, see Operation.

Field Description
id string

ID of the operation.

description string

Description of the operation. 0-256 characters long.

createdAt string (date-time)

Creation timestamp.

String in RFC3339 text format. The range of possible values is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

To work with values in this field, use the APIs described in the Protocol Buffers reference. In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).

createdBy string

ID of the user or service account who initiated the operation.

modifiedAt string (date-time)

The time when the Operation resource was last modified.

String in RFC3339 text format. The range of possible values is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

To work with values in this field, use the APIs described in the Protocol Buffers reference. In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).

done boolean (boolean)

If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.

metadata object

Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any.

error object
The error result of the operation in case of failure or cancellation.
includes only one of the fields error, response
error.
code
integer (int32)

Error code. An enum value of google.rpc.Code.

error.
message
string

An error message.

error.
details[]
object

A list of messages that carry the error details.

response object
includes only one of the fields error, response

The normal response of the operation in case of success. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is the standard Create/Update, the response should be the target resource of the operation. Any method that returns a long-running operation should document the response type, if any.

Was the article helpful?

Language / Region
Yandex project
© 2023 Intertech Services AG
In this article:
  • HTTP request
  • Body parameters
  • Response