Cloud Functions Triggers Service, gRPC: TriggerService.Pause
- gRPC request
- PauseTriggerRequest
- operation.Operation
- PauseTriggerMetadata
- Trigger
- Rule
- Timer
- InvokeFunctionOnce
- InvokeFunctionWithRetry
- RetrySettings
- PutQueueMessage
- InvokeContainerWithRetry
- GatewayWebsocketBroadcast
- MessageQueue
- BatchSettings
- InvokeContainerOnce
- IoTMessage
- IoTBrokerMessage
- ObjectStorage
- ContainerRegistry
- CloudLogs
- CloudLogsBatchSettings
- Logging
- LoggingBatchSettings
- BillingBudget
- DataStream
- DataStreamBatchSettings
- ObjectStorageBucketSettings
Pauses the specified trigger.
gRPC request
rpc Pause (PauseTriggerRequest) returns (operation.Operation)
PauseTriggerRequest
{
"trigger_id": "string"
}
Field |
Description |
trigger_id |
string Required field. ID of the trigger to pause To get a trigger ID make a TriggerService.List request. |
operation.Operation
{
"id": "string",
"description": "string",
"created_at": "google.protobuf.Timestamp",
"created_by": "string",
"modified_at": "google.protobuf.Timestamp",
"done": "bool",
"metadata": {
"trigger_id": "string"
},
// Includes only one of the fields `error`, `response`
"error": "google.rpc.Status",
"response": {
"id": "string",
"folder_id": "string",
"created_at": "google.protobuf.Timestamp",
"name": "string",
"description": "string",
"labels": "map<string, string>",
"rule": {
// 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`
"timer": {
"cron_expression": "string",
"payload": "string",
// Includes only one of the fields `invoke_function`, `invoke_function_with_retry`, `invoke_container_with_retry`, `gateway_websocket_broadcast`
"invoke_function": {
"function_id": "string",
"function_tag": "string",
"service_account_id": "string"
},
"invoke_function_with_retry": {
"function_id": "string",
"function_tag": "string",
"service_account_id": "string",
"retry_settings": {
"retry_attempts": "int64",
"interval": "google.protobuf.Duration"
},
"dead_letter_queue": {
"queue_id": "string",
"service_account_id": "string"
}
},
"invoke_container_with_retry": {
"container_id": "string",
"path": "string",
"service_account_id": "string",
"retry_settings": {
"retry_attempts": "int64",
"interval": "google.protobuf.Duration"
},
"dead_letter_queue": {
"queue_id": "string",
"service_account_id": "string"
}
},
"gateway_websocket_broadcast": {
"gateway_id": "string",
"path": "string",
"service_account_id": "string"
}
// end of the list of possible fields
},
"message_queue": {
"queue_id": "string",
"service_account_id": "string",
"batch_settings": {
"size": "int64",
"cutoff": "google.protobuf.Duration"
},
"visibility_timeout": "google.protobuf.Duration",
// Includes only one of the fields `invoke_function`, `invoke_container`, `gateway_websocket_broadcast`
"invoke_function": {
"function_id": "string",
"function_tag": "string",
"service_account_id": "string"
},
"invoke_container": {
"container_id": "string",
"path": "string",
"service_account_id": "string"
},
"gateway_websocket_broadcast": {
"gateway_id": "string",
"path": "string",
"service_account_id": "string"
}
// end of the list of possible fields
},
"iot_message": {
"registry_id": "string",
"device_id": "string",
"mqtt_topic": "string",
"batch_settings": {
"size": "int64",
"cutoff": "google.protobuf.Duration"
},
// Includes only one of the fields `invoke_function`, `invoke_container`, `gateway_websocket_broadcast`
"invoke_function": {
"function_id": "string",
"function_tag": "string",
"service_account_id": "string",
"retry_settings": {
"retry_attempts": "int64",
"interval": "google.protobuf.Duration"
},
"dead_letter_queue": {
"queue_id": "string",
"service_account_id": "string"
}
},
"invoke_container": {
"container_id": "string",
"path": "string",
"service_account_id": "string",
"retry_settings": {
"retry_attempts": "int64",
"interval": "google.protobuf.Duration"
},
"dead_letter_queue": {
"queue_id": "string",
"service_account_id": "string"
}
},
"gateway_websocket_broadcast": {
"gateway_id": "string",
"path": "string",
"service_account_id": "string"
}
// end of the list of possible fields
},
"iot_broker_message": {
"broker_id": "string",
"mqtt_topic": "string",
"batch_settings": {
"size": "int64",
"cutoff": "google.protobuf.Duration"
},
// Includes only one of the fields `invoke_function`, `invoke_container`, `gateway_websocket_broadcast`
"invoke_function": {
"function_id": "string",
"function_tag": "string",
"service_account_id": "string",
"retry_settings": {
"retry_attempts": "int64",
"interval": "google.protobuf.Duration"
},
"dead_letter_queue": {
"queue_id": "string",
"service_account_id": "string"
}
},
"invoke_container": {
"container_id": "string",
"path": "string",
"service_account_id": "string",
"retry_settings": {
"retry_attempts": "int64",
"interval": "google.protobuf.Duration"
},
"dead_letter_queue": {
"queue_id": "string",
"service_account_id": "string"
}
},
"gateway_websocket_broadcast": {
"gateway_id": "string",
"path": "string",
"service_account_id": "string"
}
// end of the list of possible fields
},
"object_storage": {
"event_type": [
"ObjectStorageEventType"
],
"bucket_id": "string",
"prefix": "string",
"suffix": "string",
"batch_settings": {
"size": "int64",
"cutoff": "google.protobuf.Duration"
},
// Includes only one of the fields `invoke_function`, `invoke_container`, `gateway_websocket_broadcast`
"invoke_function": {
"function_id": "string",
"function_tag": "string",
"service_account_id": "string",
"retry_settings": {
"retry_attempts": "int64",
"interval": "google.protobuf.Duration"
},
"dead_letter_queue": {
"queue_id": "string",
"service_account_id": "string"
}
},
"invoke_container": {
"container_id": "string",
"path": "string",
"service_account_id": "string",
"retry_settings": {
"retry_attempts": "int64",
"interval": "google.protobuf.Duration"
},
"dead_letter_queue": {
"queue_id": "string",
"service_account_id": "string"
}
},
"gateway_websocket_broadcast": {
"gateway_id": "string",
"path": "string",
"service_account_id": "string"
}
// end of the list of possible fields
},
"container_registry": {
"event_type": [
"ContainerRegistryEventType"
],
"registry_id": "string",
"image_name": "string",
"tag": "string",
"batch_settings": {
"size": "int64",
"cutoff": "google.protobuf.Duration"
},
// Includes only one of the fields `invoke_function`, `invoke_container`, `gateway_websocket_broadcast`
"invoke_function": {
"function_id": "string",
"function_tag": "string",
"service_account_id": "string",
"retry_settings": {
"retry_attempts": "int64",
"interval": "google.protobuf.Duration"
},
"dead_letter_queue": {
"queue_id": "string",
"service_account_id": "string"
}
},
"invoke_container": {
"container_id": "string",
"path": "string",
"service_account_id": "string",
"retry_settings": {
"retry_attempts": "int64",
"interval": "google.protobuf.Duration"
},
"dead_letter_queue": {
"queue_id": "string",
"service_account_id": "string"
}
},
"gateway_websocket_broadcast": {
"gateway_id": "string",
"path": "string",
"service_account_id": "string"
}
// end of the list of possible fields
},
"cloud_logs": {
"log_group_id": [
"string"
],
"batch_settings": {
"size": "int64",
"cutoff": "google.protobuf.Duration"
},
// Includes only one of the fields `invoke_function`, `invoke_container`
"invoke_function": {
"function_id": "string",
"function_tag": "string",
"service_account_id": "string",
"retry_settings": {
"retry_attempts": "int64",
"interval": "google.protobuf.Duration"
},
"dead_letter_queue": {
"queue_id": "string",
"service_account_id": "string"
}
},
"invoke_container": {
"container_id": "string",
"path": "string",
"service_account_id": "string",
"retry_settings": {
"retry_attempts": "int64",
"interval": "google.protobuf.Duration"
},
"dead_letter_queue": {
"queue_id": "string",
"service_account_id": "string"
}
}
// end of the list of possible fields
},
"logging": {
"log_group_id": "string",
"resource_type": [
"string"
],
"resource_id": [
"string"
],
"stream_name": [
"string"
],
"levels": [
"Level"
],
"batch_settings": {
"size": "int64",
"cutoff": "google.protobuf.Duration"
},
// Includes only one of the fields `invoke_function`, `invoke_container`, `gateway_websocket_broadcast`
"invoke_function": {
"function_id": "string",
"function_tag": "string",
"service_account_id": "string",
"retry_settings": {
"retry_attempts": "int64",
"interval": "google.protobuf.Duration"
},
"dead_letter_queue": {
"queue_id": "string",
"service_account_id": "string"
}
},
"invoke_container": {
"container_id": "string",
"path": "string",
"service_account_id": "string",
"retry_settings": {
"retry_attempts": "int64",
"interval": "google.protobuf.Duration"
},
"dead_letter_queue": {
"queue_id": "string",
"service_account_id": "string"
}
},
"gateway_websocket_broadcast": {
"gateway_id": "string",
"path": "string",
"service_account_id": "string"
}
// end of the list of possible fields
},
"billing_budget": {
"billing_account_id": "string",
"budget_id": "string",
// Includes only one of the fields `invoke_function`, `invoke_container`, `gateway_websocket_broadcast`
"invoke_function": {
"function_id": "string",
"function_tag": "string",
"service_account_id": "string",
"retry_settings": {
"retry_attempts": "int64",
"interval": "google.protobuf.Duration"
},
"dead_letter_queue": {
"queue_id": "string",
"service_account_id": "string"
}
},
"invoke_container": {
"container_id": "string",
"path": "string",
"service_account_id": "string",
"retry_settings": {
"retry_attempts": "int64",
"interval": "google.protobuf.Duration"
},
"dead_letter_queue": {
"queue_id": "string",
"service_account_id": "string"
}
},
"gateway_websocket_broadcast": {
"gateway_id": "string",
"path": "string",
"service_account_id": "string"
}
// end of the list of possible fields
},
"data_stream": {
"endpoint": "string",
"database": "string",
"stream": "string",
"service_account_id": "string",
"batch_settings": {
"size": "int64",
"cutoff": "google.protobuf.Duration"
},
// Includes only one of the fields `invoke_function`, `invoke_container`, `gateway_websocket_broadcast`
"invoke_function": {
"function_id": "string",
"function_tag": "string",
"service_account_id": "string",
"retry_settings": {
"retry_attempts": "int64",
"interval": "google.protobuf.Duration"
},
"dead_letter_queue": {
"queue_id": "string",
"service_account_id": "string"
}
},
"invoke_container": {
"container_id": "string",
"path": "string",
"service_account_id": "string",
"retry_settings": {
"retry_attempts": "int64",
"interval": "google.protobuf.Duration"
},
"dead_letter_queue": {
"queue_id": "string",
"service_account_id": "string"
}
},
"gateway_websocket_broadcast": {
"gateway_id": "string",
"path": "string",
"service_account_id": "string"
}
// end of the list of possible fields
},
"mail": {
"email": "string",
"batch_settings": {
"size": "int64",
"cutoff": "google.protobuf.Duration"
},
"attachments_bucket": {
"bucket_id": "string",
"service_account_id": "string"
},
// Includes only one of the fields `invoke_function`, `invoke_container`, `gateway_websocket_broadcast`
"invoke_function": {
"function_id": "string",
"function_tag": "string",
"service_account_id": "string",
"retry_settings": {
"retry_attempts": "int64",
"interval": "google.protobuf.Duration"
},
"dead_letter_queue": {
"queue_id": "string",
"service_account_id": "string"
}
},
"invoke_container": {
"container_id": "string",
"path": "string",
"service_account_id": "string",
"retry_settings": {
"retry_attempts": "int64",
"interval": "google.protobuf.Duration"
},
"dead_letter_queue": {
"queue_id": "string",
"service_account_id": "string"
}
},
"gateway_websocket_broadcast": {
"gateway_id": "string",
"path": "string",
"service_account_id": "string"
}
// end of the list of possible fields
}
// end of the list of possible fields
},
"status": "Status"
}
// 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. |
created_at |
Creation timestamp. |
created_by |
string ID of the user or service account who initiated the operation. |
modified_at |
The time when the Operation resource was last modified. |
done |
bool If the value is |
metadata |
Service-specific metadata associated with the operation. |
error |
The error result of the operation in case of failure or cancellation. Includes only one of the fields The operation result. |
response |
The normal response of the operation in case of success. Includes only one of the fields The operation result. |
PauseTriggerMetadata
Field |
Description |
trigger_id |
string Required field. ID of the trigger that is being paused. |
Trigger
A trigger to invoke a serverless function. For more information, see Triggers.
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 |
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 |
rule |
Required field. Rule for trigger activation (always consistent with the trigger type). |
status |
enum Status Trigger status.
|
Rule
Description of a rule for trigger activation.
Field |
Description |
timer |
Rule for a timed trigger. Includes only one of the fields |
message_queue |
Rule for a message queue trigger. Includes only one of the fields |
iot_message |
Rule for a IoT Core trigger. Includes only one of the fields |
iot_broker_message |
Includes only one of the fields |
object_storage |
Includes only one of the fields |
container_registry |
Includes only one of the fields |
cloud_logs |
Includes only one of the fields |
logging |
Includes only one of the fields |
billing_budget |
Includes only one of the fields |
data_stream |
Includes only one of the fields |
|
Includes only one of the fields |
Timer
Rule for activating a timed trigger.
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 |
Instructions for invoking a function once. Includes only one of the fields Action to be executed when the current time matches the |
invoke_function_with_retry |
Instructions for invoking a function with retry. Includes only one of the fields Action to be executed when the current time matches the |
invoke_container_with_retry |
Instructions for invoking a container with retry. Includes only one of the fields Action to be executed when the current time matches the |
gateway_websocket_broadcast |
Instructions for broadcasting to API gateway websocket once. Includes only one of the fields Action to be executed when the current time matches the |
InvokeFunctionOnce
A single function invocation.
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. |
InvokeFunctionWithRetry
A function invocation with retries.
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 |
Retry policy. If the field is not specified, or the value is empty, no retries will be attempted. |
dead_letter_queue |
DLQ policy (no value means discarding a message). |
RetrySettings
Settings for retrying to invoke a function.
Field |
Description |
retry_attempts |
int64 Maximum number of retries (extra invokes) before the action is considered failed. |
interval |
Required field. Time in seconds to wait between individual retries. |
PutQueueMessage
Field |
Description |
queue_id |
string ID of the queue. |
service_account_id |
string Required field. Service account which has write permission on the queue. |
InvokeContainerWithRetry
A container invocation with retries.
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 |
Retry policy. If the field is not specified, or the value is empty, no retries will be attempted. |
dead_letter_queue |
DLQ policy (no value means discarding a message). |
GatewayWebsocketBroadcast
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 |
MessageQueue
Rule for activating a message queue trigger.
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 |
Required field. Batch settings for processing messages in the queue. |
visibility_timeout |
Queue visibility timeout override. |
invoke_function |
Instructions for invoking a function once. Includes only one of the fields Action to be executed when the there's a new message in the queue. |
invoke_container |
Instructions for invoking a container once. Includes only one of the fields Action to be executed when the there's a new message in the queue. |
gateway_websocket_broadcast |
Instructions for broadcasting to API gateway websocket once. Includes only one of the fields Action to be executed when the there's a new message in the queue. |
BatchSettings
Settings for batch processing of messages in a queue.
Field |
Description |
size |
int64 Batch size. Trigger will send the batch of messages to the function |
cutoff |
Required field. Maximum wait time. Trigger will send the batch of messages to the function when |
InvokeContainerOnce
A single container invocation.
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. |
IoTMessage
Rule for activating a IoT Core trigger.
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 |
Batch settings for processing events. |
invoke_function |
Instructions for invoking a function with retries as needed. Includes only one of the fields Action to be executed when the there's a new message in the MQTT topic. |
invoke_container |
Instructions for invoking a container with retries as needed. Includes only one of the fields Action to be executed when the there's a new message in the MQTT topic. |
gateway_websocket_broadcast |
Instructions for broadcasting to API gateway websocket once. Includes only one of the fields Action to be executed when the there's a new message in the MQTT topic. |
IoTBrokerMessage
Rule for activating a IoT Core Broker trigger.
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 |
Batch settings for processing events. |
invoke_function |
Instructions for invoking a function with retries as needed. Includes only one of the fields Action to be executed when the there's a new message in the MQTT topic. |
invoke_container |
Instructions for invoking a container with retries as needed. Includes only one of the fields Action to be executed when the there's a new message in the MQTT topic. |
gateway_websocket_broadcast |
Instructions for broadcasting to API gateway websocket once. Includes only one of the fields Action to be executed when the there's a new message in the MQTT topic. |
ObjectStorage
Field |
Description |
event_type[] |
enum ObjectStorageEventType Type (name) of events, at least one value is required.
|
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 |
Batch settings for processing events. |
invoke_function |
Instructions for invoking a function with retries as needed. Includes only one of the fields |
invoke_container |
Instructions for invoking a container with retries as needed. Includes only one of the fields |
gateway_websocket_broadcast |
Instructions for broadcasting to API gateway websocket once. Includes only one of the fields |
ContainerRegistry
Field |
Description |
event_type[] |
enum ContainerRegistryEventType Type (name) of events, at least one value is required.
|
registry_id |
string ID of the registry. |
image_name |
string Docker-image name. Filter, optional. |
tag |
string Docker-image tag. Filter, optional. |
batch_settings |
Batch settings for processing events. |
invoke_function |
Instructions for invoking a function with retries as needed. Includes only one of the fields |
invoke_container |
Instructions for invoking a container with retries as needed. Includes only one of the fields |
gateway_websocket_broadcast |
Instructions for broadcasting to API gateway websocket once. Includes only one of the fields |
CloudLogs
Field |
Description |
log_group_id[] |
string Log group identifiers, at least one value is required. |
batch_settings |
Required field. Batch settings for processing log events. |
invoke_function |
Instructions for invoking a function with retries as needed. Includes only one of the fields |
invoke_container |
Instructions for invoking a container with retries as needed. Includes only one of the fields |
CloudLogsBatchSettings
Field |
Description |
size |
int64 Batch size. Trigger will send the batch of messages to the function |
cutoff |
Maximum wait time. Trigger will send the batch of messages to the function when |
Logging
Field |
Description |
log_group_id |
string Log events filter settings. |
resource_type[] |
string |
resource_id[] |
string |
stream_name[] |
string |
levels[] |
enum Level
|
batch_settings |
Required field. Batch settings for processing log events. |
invoke_function |
Instructions for invoking a function with retries as needed. Includes only one of the fields |
invoke_container |
Instructions for invoking a container with retries as needed. Includes only one of the fields |
gateway_websocket_broadcast |
Instructions for broadcasting to API gateway websocket once. Includes only one of the fields |
LoggingBatchSettings
Field |
Description |
size |
int64 Batch size. Trigger will send the batch of messages to the associated function |
cutoff |
Maximum wait time. Trigger will send the batch of messages the time since the last batch |
BillingBudget
Field |
Description |
billing_account_id |
string Required field. |
budget_id |
string |
invoke_function |
Includes only one of the fields |
invoke_container |
Includes only one of the fields |
gateway_websocket_broadcast |
Includes only one of the fields |
DataStream
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 |
Batch settings for processing events. |
invoke_function |
Includes only one of the fields |
invoke_container |
Includes only one of the fields |
gateway_websocket_broadcast |
Includes only one of the fields |
DataStreamBatchSettings
Field |
Description |
size |
int64 Batch size in bytes. Trigger will send the batch of messages to the associated function |
cutoff |
Maximum wait time. Trigger will send the batch of messages the time since the last batch |
Field |
Description |
|
string Address to receive emails for trigger activation. |
batch_settings |
Batch settings for processing events. |
attachments_bucket |
Bucket settings for saving attachments. |
invoke_function |
Includes only one of the fields |
invoke_container |
Includes only one of the fields |
gateway_websocket_broadcast |
Includes only one of the fields |
ObjectStorageBucketSettings
Field |
Description |
bucket_id |
string Bucket for saving. |
service_account_id |
string Required field. SA which has write permission on storage. |