EventRouter Service, gRPC: RuleService.Update

Written by

Yandex Cloud

Updated at November 7, 2024

gRPC request
UpdateRuleRequest
Filter
Target
YdsTarget
YmqTarget
FunctionTarget
BatchSettings
ContainerTarget
GatewayWebsocketBroadcastTarget
LoggingTarget
WorkflowTarget
Transformer
RetrySettings
PutQueueMessage
operation.Operation
UpdateRuleMetadata
Rule
Filter
Target
YdsTarget
YmqTarget
FunctionTarget
BatchSettings
ContainerTarget
GatewayWebsocketBroadcastTarget
LoggingTarget
WorkflowTarget
Transformer
RetrySettings
PutQueueMessage

Updates the specified rule.

gRPC request

rpc Update (UpdateRuleRequest) returns (operation.Operation)

UpdateRuleRequest

{
  "ruleId": "string",
  "updateMask": "google.protobuf.FieldMask",
  "name": "string",
  "description": "string",
  "labels": "string",
  "filter": {
    // Includes only one of the fields `jqFilter`
    "jqFilter": "string"
    // end of the list of possible fields
  },
  "targets": [
    {
      // Includes only one of the fields `yds`, `ymq`, `function`, `container`, `gatewayWsBroadcast`, `logging`, `workflow`
      "yds": {
        "database": "string",
        "streamName": "string",
        "serviceAccountId": "string"
      },
      "ymq": {
        "queueArn": "string",
        "serviceAccountId": "string"
      },
      "function": {
        "functionId": "string",
        "functionTag": "string",
        "serviceAccountId": "string",
        "batchSettings": {
          "maxCount": "int64",
          "maxBytes": "int64",
          "cutoff": "google.protobuf.Duration"
        }
      },
      "container": {
        "containerId": "string",
        "containerRevisionId": "string",
        "path": "string",
        "serviceAccountId": "string",
        "batchSettings": {
          "maxCount": "int64",
          "maxBytes": "int64",
          "cutoff": "google.protobuf.Duration"
        }
      },
      "gatewayWsBroadcast": {
        "gatewayId": "string",
        "path": "string",
        "serviceAccountId": "string",
        "batchSettings": {
          "maxCount": "int64",
          "maxBytes": "int64",
          "cutoff": "google.protobuf.Duration"
        }
      },
      "logging": {
        // Includes only one of the fields `logGroupId`, `folderId`
        "logGroupId": "string",
        "folderId": "string",
        // end of the list of possible fields
        "serviceAccountId": "string"
      },
      "workflow": {
        "workflowId": "string",
        "serviceAccountId": "string",
        "batchSettings": {
          "maxCount": "int64",
          "maxBytes": "int64",
          "cutoff": "google.protobuf.Duration"
        }
      },
      // end of the list of possible fields
      "transformer": {
        // Includes only one of the fields `jqTransformer`
        "jqTransformer": "string"
        // end of the list of possible fields
      },
      "retrySettings": {
        "retryAttempts": "int64",
        "maximumAge": "google.protobuf.Duration"
      },
      // Includes only one of the fields `deadLetterQueue`
      "deadLetterQueue": {
        "queueArn": "string",
        "serviceAccountId": "string"
      },
      // end of the list of possible fields
      "status": "Status"
    }
  ],
  "deletionProtection": "bool"
}

Field	Description
ruleId	string Required field. ID of the rule to update.
updateMask	google.protobuf.FieldMask Field mask that specifies which fields of the rule are going to be updated.
name	string New name of the rule.
description	string New description of the rule.
labels	string New labels for the rule.
filter	Filter New filter for the rule.
targets[]	Target New targets for the rule.
deletionProtection	bool New flag that disallow deletion of the rule.

Filter

Field

Description

jqFilter

string

JQ filter for matching events.

Includes only one of the fields jqFilter.

Target

Field	Description
yds	YdsTarget Includes only one of the fields `yds`, `ymq`, `function`, `container`, `gatewayWsBroadcast`, `logging`, `workflow`.
ymq	YmqTarget Includes only one of the fields `yds`, `ymq`, `function`, `container`, `gatewayWsBroadcast`, `logging`, `workflow`.
function	FunctionTarget Includes only one of the fields `yds`, `ymq`, `function`, `container`, `gatewayWsBroadcast`, `logging`, `workflow`.
container	ContainerTarget Includes only one of the fields `yds`, `ymq`, `function`, `container`, `gatewayWsBroadcast`, `logging`, `workflow`.
gatewayWsBroadcast	GatewayWebsocketBroadcastTarget Includes only one of the fields `yds`, `ymq`, `function`, `container`, `gatewayWsBroadcast`, `logging`, `workflow`.
logging	LoggingTarget Includes only one of the fields `yds`, `ymq`, `function`, `container`, `gatewayWsBroadcast`, `logging`, `workflow`.
workflow	WorkflowTarget Includes only one of the fields `yds`, `ymq`, `function`, `container`, `gatewayWsBroadcast`, `logging`, `workflow`.
transformer	Transformer Transformer of the target.
retrySettings	RetrySettings Retry settings of the target.
deadLetterQueue	PutQueueMessage Dead letter queue. Includes only one of the fields `deadLetterQueue`. Dead letter settings of the target.
status	enum Status Status of the target. `STATUS_UNSPECIFIED` `ENABLED`: Target is enabled. `DISABLED`: Target is disabled. `RESOURCE_NOT_FOUND`: Target does not exist. `PERMISSION_DENIED`: Service account does not have read permission on source. `SUBJECT_NOT_FOUND`: Service account not found.

YdsTarget

Field	Description
database	string Required field. Stream database.
streamName	string Required field. Full stream name, like /ru-central1/aoegtvhtp8ob******/cc8004q4lbo6******/test.
serviceAccountId	string Required field. Service account, which has write permission on the stream.

YmqTarget

Field

Description

queueArn

string

Required field. Queue ARN.
Example: yrn:yc:ymq:ru-central1:aoe***:test

serviceAccountId

string

Required field. Service account which has write access to the queue.

FunctionTarget

Field	Description
functionId	string Required field. Function ID.
functionTag	string Function tag, optional.
serviceAccountId	string Service account which has call permission on the function, optional.
batchSettings	BatchSettings Batch settings.

BatchSettings

Field	Description
maxCount	int64 Maximum batch size: trigger will send a batch if number of events exceeds this value.
maxBytes	int64 Maximum batch size: trigger will send a batch if total size of events exceeds this value.
cutoff	google.protobuf.Duration Required field. Maximum batch size: trigger will send a batch if its lifetime exceeds this value.

ContainerTarget

Field	Description
containerId	string Required field. Container ID.
containerRevisionId	string Container revision ID.
path	string Endpoint HTTP path to invoke.
serviceAccountId	string Service account which should be used to call a container, optional.
batchSettings	BatchSettings Batch settings.

GatewayWebsocketBroadcastTarget

Field	Description
gatewayId	string Required field. Gateway ID.
path	string Required field. Path.
serviceAccountId	string Required field. Service account which has permission for writing to websockets.
batchSettings	BatchSettings Batch settings.

LoggingTarget

Field	Description
logGroupId	string Includes only one of the fields `logGroupId`, `folderId`. Log group ID or folder ID.
folderId	string Includes only one of the fields `logGroupId`, `folderId`. Log group ID or folder ID.
serviceAccountId	string Required field. Service account which has permission for writing logs.

WorkflowTarget

Field	Description
workflowId	string Required field. Workflow ID.
serviceAccountId	string Required field. SA which should be used to start workflow.
batchSettings	BatchSettings Batch settings.

Transformer

Field

Description

jqTransformer

string

JQ string inrerpolation expression for changing event format.

Includes only one of the fields jqTransformer.

RetrySettings

Field

Description

retryAttempts

int64

Maximum number of retries (extra calls) before an action fails.

maximumAge

google.protobuf.Duration

Event goes to dlq when its age exceeds this value. Default is 24h.

PutQueueMessage

Field

Description

queueArn

string

ID of the queue.

serviceAccountId

string

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

operation.Operation

{
  "id": "string",
  "description": "string",
  "createdAt": "google.protobuf.Timestamp",
  "createdBy": "string",
  "modifiedAt": "google.protobuf.Timestamp",
  "done": "bool",
  "metadata": {
    "ruleId": "string"
  },
  // Includes only one of the fields `error`, `response`
  "error": "google.rpc.Status",
  "response": {
    "id": "string",
    "busId": "string",
    "folderId": "string",
    "cloudId": "string",
    "createdAt": "google.protobuf.Timestamp",
    "name": "string",
    "description": "string",
    "labels": "string",
    "filter": {
      // Includes only one of the fields `jqFilter`
      "jqFilter": "string"
      // end of the list of possible fields
    },
    "targets": [
      {
        // Includes only one of the fields `yds`, `ymq`, `function`, `container`, `gatewayWsBroadcast`, `logging`, `workflow`
        "yds": {
          "database": "string",
          "streamName": "string",
          "serviceAccountId": "string"
        },
        "ymq": {
          "queueArn": "string",
          "serviceAccountId": "string"
        },
        "function": {
          "functionId": "string",
          "functionTag": "string",
          "serviceAccountId": "string",
          "batchSettings": {
            "maxCount": "int64",
            "maxBytes": "int64",
            "cutoff": "google.protobuf.Duration"
          }
        },
        "container": {
          "containerId": "string",
          "containerRevisionId": "string",
          "path": "string",
          "serviceAccountId": "string",
          "batchSettings": {
            "maxCount": "int64",
            "maxBytes": "int64",
            "cutoff": "google.protobuf.Duration"
          }
        },
        "gatewayWsBroadcast": {
          "gatewayId": "string",
          "path": "string",
          "serviceAccountId": "string",
          "batchSettings": {
            "maxCount": "int64",
            "maxBytes": "int64",
            "cutoff": "google.protobuf.Duration"
          }
        },
        "logging": {
          // Includes only one of the fields `logGroupId`, `folderId`
          "logGroupId": "string",
          "folderId": "string",
          // end of the list of possible fields
          "serviceAccountId": "string"
        },
        "workflow": {
          "workflowId": "string",
          "serviceAccountId": "string",
          "batchSettings": {
            "maxCount": "int64",
            "maxBytes": "int64",
            "cutoff": "google.protobuf.Duration"
          }
        },
        // end of the list of possible fields
        "transformer": {
          // Includes only one of the fields `jqTransformer`
          "jqTransformer": "string"
          // end of the list of possible fields
        },
        "retrySettings": {
          "retryAttempts": "int64",
          "maximumAge": "google.protobuf.Duration"
        },
        // Includes only one of the fields `deadLetterQueue`
        "deadLetterQueue": {
          "queueArn": "string",
          "serviceAccountId": "string"
        },
        // end of the list of possible fields
        "status": "Status"
      }
    ],
    "deletionProtection": "bool",
    "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.
createdAt	google.protobuf.Timestamp Creation timestamp.
createdBy	string ID of the user or service account who initiated the operation.
modifiedAt	google.protobuf.Timestamp The time when the Operation resource was last modified.
done	bool 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	UpdateRuleMetadata 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	google.rpc.Status The error result of the operation in case of failure or cancellation. Includes only one of the fields `error`, `response`. The operation result. If `done == false` and there was no failure detected, neither `error` nor `response` is set. If `done == false` and there was a failure detected, `error` is set. If `done == true`, exactly one of `error` or `response` is set.
response	Rule 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. Includes only one of the fields `error`, `response`. The operation result. If `done == false` and there was no failure detected, neither `error` nor `response` is set. If `done == false` and there was a failure detected, `error` is set. If `done == true`, exactly one of `error` or `response` is set.

UpdateRuleMetadata

Field

Description

ruleId

string

Required field. ID of the rule that is being updated.

Rule

Field	Description
id	string ID of the rule.
busId	string ID of the bus that the rule belongs to.
folderId	string ID of the folder that the rule resides in.
cloudId	string ID of the cloud that the rule resides in.
createdAt	google.protobuf.Timestamp Creation timestamp.
name	string Name of the rule.
description	string Description of the rule.
labels	string Resource labels as `key:value` pairs.
filter	Filter Filter for the rule.
targets[]	Target Targets of the rule.
deletionProtection	bool Flag that disallow deletion of the rule.
status	enum Status Rule status `STATUS_UNSPECIFIED` `CREATING`: Rule creation in progress, rule is not enabled yet `ENABLED`: Rule is operating `UPDATING`: Rule update in progress, rule is disabled during update `DISABLED`: Rule is explicitly disabled by the user `DELETING`: Rule deletion in progress

Filter

Field

Description

jqFilter

string

JQ filter for matching events.

Includes only one of the fields jqFilter.

Target

Field	Description
yds	YdsTarget Includes only one of the fields `yds`, `ymq`, `function`, `container`, `gatewayWsBroadcast`, `logging`, `workflow`.
ymq	YmqTarget Includes only one of the fields `yds`, `ymq`, `function`, `container`, `gatewayWsBroadcast`, `logging`, `workflow`.
function	FunctionTarget Includes only one of the fields `yds`, `ymq`, `function`, `container`, `gatewayWsBroadcast`, `logging`, `workflow`.
container	ContainerTarget Includes only one of the fields `yds`, `ymq`, `function`, `container`, `gatewayWsBroadcast`, `logging`, `workflow`.
gatewayWsBroadcast	GatewayWebsocketBroadcastTarget Includes only one of the fields `yds`, `ymq`, `function`, `container`, `gatewayWsBroadcast`, `logging`, `workflow`.
logging	LoggingTarget Includes only one of the fields `yds`, `ymq`, `function`, `container`, `gatewayWsBroadcast`, `logging`, `workflow`.
workflow	WorkflowTarget Includes only one of the fields `yds`, `ymq`, `function`, `container`, `gatewayWsBroadcast`, `logging`, `workflow`.
transformer	Transformer Transformer of the target.
retrySettings	RetrySettings Retry settings of the target.
deadLetterQueue	PutQueueMessage Dead letter queue. Includes only one of the fields `deadLetterQueue`. Dead letter settings of the target.
status	enum Status Status of the target. `STATUS_UNSPECIFIED` `ENABLED`: Target is enabled. `DISABLED`: Target is disabled. `RESOURCE_NOT_FOUND`: Target does not exist. `PERMISSION_DENIED`: Service account does not have read permission on source. `SUBJECT_NOT_FOUND`: Service account not found.

YdsTarget

Field	Description
database	string Required field. Stream database.
streamName	string Required field. Full stream name, like /ru-central1/aoegtvhtp8ob******/cc8004q4lbo6******/test.
serviceAccountId	string Required field. Service account, which has write permission on the stream.

YmqTarget

Field

Description

queueArn

string

Required field. Queue ARN.
Example: yrn:yc:ymq:ru-central1:aoe***:test

serviceAccountId

string

Required field. Service account which has write access to the queue.

FunctionTarget

Field	Description
functionId	string Required field. Function ID.
functionTag	string Function tag, optional.
serviceAccountId	string Service account which has call permission on the function, optional.
batchSettings	BatchSettings Batch settings.

BatchSettings

Field	Description
maxCount	int64 Maximum batch size: trigger will send a batch if number of events exceeds this value.
maxBytes	int64 Maximum batch size: trigger will send a batch if total size of events exceeds this value.
cutoff	google.protobuf.Duration Required field. Maximum batch size: trigger will send a batch if its lifetime exceeds this value.

ContainerTarget

Field	Description
containerId	string Required field. Container ID.
containerRevisionId	string Container revision ID.
path	string Endpoint HTTP path to invoke.
serviceAccountId	string Service account which should be used to call a container, optional.
batchSettings	BatchSettings Batch settings.

GatewayWebsocketBroadcastTarget

Field	Description
gatewayId	string Required field. Gateway ID.
path	string Required field. Path.
serviceAccountId	string Required field. Service account which has permission for writing to websockets.
batchSettings	BatchSettings Batch settings.

LoggingTarget

Field	Description
logGroupId	string Includes only one of the fields `logGroupId`, `folderId`. Log group ID or folder ID.
folderId	string Includes only one of the fields `logGroupId`, `folderId`. Log group ID or folder ID.
serviceAccountId	string Required field. Service account which has permission for writing logs.

WorkflowTarget

Field	Description
workflowId	string Required field. Workflow ID.
serviceAccountId	string Required field. SA which should be used to start workflow.
batchSettings	BatchSettings Batch settings.

Transformer

Field

Description

jqTransformer

string

JQ string inrerpolation expression for changing event format.

Includes only one of the fields jqTransformer.

RetrySettings

Field

Description

retryAttempts

int64

Maximum number of retries (extra calls) before an action fails.

maximumAge

google.protobuf.Duration

Event goes to dlq when its age exceeds this value. Default is 24h.

PutQueueMessage

Field

Description

queueArn

string

ID of the queue.

serviceAccountId

string

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

EventRouter Service, gRPC: RuleService.Update

gRPC requestgRPC request

UpdateRuleRequestUpdateRuleRequest

FilterFilter

TargetTarget

YdsTargetYdsTarget

YmqTargetYmqTarget

FunctionTargetFunctionTarget

BatchSettingsBatchSettings

ContainerTargetContainerTarget

GatewayWebsocketBroadcastTargetGatewayWebsocketBroadcastTarget

LoggingTargetLoggingTarget

WorkflowTargetWorkflowTarget

TransformerTransformer

RetrySettingsRetrySettings

PutQueueMessagePutQueueMessage

operation.Operationoperation.Operation

UpdateRuleMetadataUpdateRuleMetadata

RuleRule

FilterFilter

TargetTarget

YdsTargetYdsTarget

YmqTargetYmqTarget

FunctionTargetFunctionTarget

BatchSettingsBatchSettings

ContainerTargetContainerTarget

GatewayWebsocketBroadcastTargetGatewayWebsocketBroadcastTarget

LoggingTargetLoggingTarget

WorkflowTargetWorkflowTarget

TransformerTransformer

RetrySettingsRetrySettings

PutQueueMessagePutQueueMessage

Was the article helpful?

gRPC request

UpdateRuleRequest

Filter

Target

YdsTarget

YmqTarget

FunctionTarget

BatchSettings

ContainerTarget

GatewayWebsocketBroadcastTarget

LoggingTarget

WorkflowTarget

Transformer

RetrySettings

PutQueueMessage

operation.Operation

UpdateRuleMetadata

Rule

Filter

Target

YdsTarget

YmqTarget

FunctionTarget

BatchSettings

ContainerTarget

GatewayWebsocketBroadcastTarget

LoggingTarget

WorkflowTarget

Transformer

RetrySettings

PutQueueMessage