EventRouter Service, gRPC: RuleService.List
Retrieves the list of rules in the specified folder.
gRPC request
rpc List (ListRulesRequest) returns (ListRulesResponse)
ListRulesRequest
{
// Includes only one of the fields `bus_id`, `folder_id`
"bus_id": "string",
"folder_id": "string",
// end of the list of possible fields
"page_size": "int64",
"page_token": "string",
"filter": "string"
}
|
Field |
Description |
|
bus_id |
string ID of the bus to list rules in. Includes only one of the fields ID of the folder on bus to list rules in. |
|
folder_id |
string ID of the folder to list rules in. Includes only one of the fields ID of the folder on bus to list rules in. |
|
page_size |
int64 The maximum number of results per response. |
|
page_token |
string Page token. To get the next page of results, set |
|
filter |
string Supported fields for filter: |
ListRulesResponse
{
"rules": [
{
"id": "string",
"bus_id": "string",
"folder_id": "string",
"cloud_id": "string",
"created_at": "google.protobuf.Timestamp",
"name": "string",
"description": "string",
"labels": "map<string, string>",
"filter": {
// Includes only one of the fields `jq_filter`
"jq_filter": "string"
// end of the list of possible fields
},
"targets": [
{
// Includes only one of the fields `yds`, `ymq`, `function`, `container`, `gateway_ws_broadcast`, `logging`, `workflow`
"yds": {
"database": "string",
"stream_name": "string",
"service_account_id": "string"
},
"ymq": {
"queue_arn": "string",
"service_account_id": "string"
},
"function": {
"function_id": "string",
"function_tag": "string",
"service_account_id": "string",
"batch_settings": {
"max_count": "int64",
"max_bytes": "int64",
"cutoff": "google.protobuf.Duration"
}
},
"container": {
"container_id": "string",
"container_revision_id": "string",
"path": "string",
"service_account_id": "string",
"batch_settings": {
"max_count": "int64",
"max_bytes": "int64",
"cutoff": "google.protobuf.Duration"
}
},
"gateway_ws_broadcast": {
"gateway_id": "string",
"path": "string",
"service_account_id": "string",
"batch_settings": {
"max_count": "int64",
"max_bytes": "int64",
"cutoff": "google.protobuf.Duration"
}
},
"logging": {
// Includes only one of the fields `log_group_id`, `folder_id`
"log_group_id": "string",
"folder_id": "string",
// end of the list of possible fields
"service_account_id": "string"
},
"workflow": {
"workflow_id": "string",
"service_account_id": "string",
"batch_settings": {
"max_count": "int64",
"max_bytes": "int64",
"cutoff": "google.protobuf.Duration"
}
},
// end of the list of possible fields
"transformer": {
// Includes only one of the fields `jq_transformer`
"jq_transformer": "string"
// end of the list of possible fields
},
"retry_settings": {
"retry_attempts": "int64",
"maximum_age": "google.protobuf.Duration"
},
// Includes only one of the fields `dead_letter_queue`
"dead_letter_queue": {
"queue_arn": "string",
"service_account_id": "string"
},
// end of the list of possible fields
"status": "Status"
}
],
"deletion_protection": "bool",
"status": "Status"
}
],
"next_page_token": "string"
}
|
Field |
Description |
|
rules[] |
List of rules. |
|
next_page_token |
string Token for getting the next page of the list of rules. |
Rule
|
Field |
Description |
|
id |
string ID of the rule. |
|
bus_id |
string ID of the bus that the rule belongs to. |
|
folder_id |
string ID of the folder that the rule resides in. |
|
cloud_id |
string ID of the cloud that the rule resides in. |
|
created_at |
Creation timestamp. |
|
name |
string Name of the rule. |
|
description |
string Description of the rule. |
|
labels |
object (map<string, string>) Resource labels as |
|
filter |
Filter for the rule. |
|
targets[] |
Targets of the rule. |
|
deletion_protection |
bool Flag that disallow deletion of the rule. |
|
status |
enum Status Rule status
|
Filter
|
Field |
Description |
|
jq_filter |
string JQ filter for matching events. Includes only one of the fields |
Target
|
Field |
Description |
|
yds |
Includes only one of the fields |
|
ymq |
Includes only one of the fields |
|
function |
Includes only one of the fields |
|
container |
Includes only one of the fields |
|
gateway_ws_broadcast |
GatewayWebsocketBroadcastTarget Includes only one of the fields |
|
logging |
Includes only one of the fields |
|
workflow |
Includes only one of the fields |
|
transformer |
Transformer of the target. |
|
retry_settings |
Retry settings of the target. |
|
dead_letter_queue |
Dead letter queue. Includes only one of the fields Dead letter settings of the target. |
|
status |
enum Status Status of the target.
|
YdsTarget
|
Field |
Description |
|
database |
string Required field. Stream database. |
|
stream_name |
string Required field. Full stream name, like /ru-central1/aoegtvhtp8ob********/cc8004q4lbo6********/test. |
|
service_account_id |
string Required field. Service account, which has write permission on the stream. |
YmqTarget
|
Field |
Description |
|
queue_arn |
string Required field. Queue ARN. |
|
service_account_id |
string Required field. Service account which has write access to the queue. |
FunctionTarget
|
Field |
Description |
|
function_id |
string Required field. Function ID. |
|
function_tag |
string Function tag, optional. |
|
service_account_id |
string Service account which has call permission on the function, optional. |
|
batch_settings |
Batch settings. |
BatchSettings
|
Field |
Description |
|
max_count |
int64 Maximum batch size: trigger will send a batch if number of events exceeds this value. |
|
max_bytes |
int64 Maximum batch size: trigger will send a batch if total size of events exceeds this value. |
|
cutoff |
Required field. Maximum batch size: trigger will send a batch if its lifetime exceeds this value. |
ContainerTarget
|
Field |
Description |
|
container_id |
string Required field. Container ID. |
|
container_revision_id |
string Container revision ID. |
|
path |
string Endpoint HTTP path to invoke. |
|
service_account_id |
string Service account which should be used to call a container, optional. |
|
batch_settings |
Batch settings. |
GatewayWebsocketBroadcastTarget
|
Field |
Description |
|
gateway_id |
string Required field. Gateway ID. |
|
path |
string Required field. Path. |
|
service_account_id |
string Required field. Service account which has permission for writing to websockets. |
|
batch_settings |
Batch settings. |
LoggingTarget
|
Field |
Description |
|
log_group_id |
string Includes only one of the fields Log group ID or folder ID. |
|
folder_id |
string Includes only one of the fields Log group ID or folder ID. |
|
service_account_id |
string Required field. Service account which has permission for writing logs. |
WorkflowTarget
|
Field |
Description |
|
workflow_id |
string Required field. Workflow ID. |
|
service_account_id |
string Required field. SA which should be used to start workflow. |
|
batch_settings |
Batch settings. |
Transformer
|
Field |
Description |
|
jq_transformer |
string JQ string inrerpolation expression for changing event format. Includes only one of the fields |
RetrySettings
|
Field |
Description |
|
retry_attempts |
int64 Maximum number of retries (extra calls) before an action fails. |
|
maximum_age |
Event goes to dlq when its age exceeds this value. Default is 24h. |
PutQueueMessage
|
Field |
Description |
|
queue_arn |
string ID of the queue. |
|
service_account_id |
string Required field. Service account which has write permission on the queue. |