Services
RPC methods exposed by this API.RuleService
Messages
Data models used across requests/responses.AnnotationActionConfiguration
ArchiveRuleRequest
ArchiveRuleRequest is used to archive a rule by rule_id or client_key. If both are provided, only rule_id will be used.ArchiveRuleResponse
This message has no fields.AssetExpressionValidationResult
BatchArchiveRulesRequest
BatchArchiveRulesRequest is used to archive a rule by rule_id or client_key. For each rule if both are provided, only rule_id will be used.BatchArchiveRulesResponse
This message has no fields.BatchDeleteRulesRequest
BatchDeleteRulesRequest is used to delete a rule by rule_id or client_key. For each rule if both are provided, only rule_id will be used.BatchDeleteRulesResponse
This message has no fields.BatchGetRuleVersionsRequest
BatchGetRuleVersionsResponse
BatchGetRulesRequest
BatchGetRulesRequest is used to retrieve rules by rule_ids or client_keys. If both are provided, both will be used to retrieve rules.BatchGetRulesResponse
BatchUnarchiveRulesRequest
BatchUnarchiveRulesRequest is used to unarchive a rule by rule_id or client_key. For each rule if both are provided, only rule_id will be used.BatchUnarchiveRulesResponse
This message has no fields.BatchUndeleteRulesRequest
BatchUndeleteRulesRequest is used to delete a rule by rule_id or client_key. For each rule if both are provided, only rule_id will be used.BatchUndeleteRulesResponse
This message has no fields.BatchUpdateRulesRequest
Marked
deprecated = true because new integrations should validate input before submitting; existing SDK call sites that rely on this flag continue to work. |
BatchUpdateRulesResponse
BatchUpdateRulesResponse.RuleIdentifiers
CalculatedChannelConfig
CalculatedChannelConfig.ChannelReferencesEntry
ChannelReference
ContextualChannels
CreateRuleRequest
CreateRuleResponse
DeleteRuleRequest
DeleteRuleRequest is used to delete a rule by rule_id or client_key. If both are provided, only rule_id will be used.DeleteRuleResponse
This message has no fields.DryRunAnnotation
EvaluateRulesRequest
Deprecated - use RuleEvaluationService instead.EvaluateRulesResponse
Deprecated - use RuleEvaluationService instead.EvaluatedAnnotationOptions
GetRuleRequest
GetRuleRequest is used to retrieve a rule by rule_id or client_key. If both are provided, only rule_id will be used.GetRuleResponse
GetRuleVersionRequest
GetRuleVersionResponse
JsonRulesRequest
JsonRulesResponse
LastValueThreshold
This message has no fields.ListRuleVersionsRequest
ListRuleVersionsResponse
ListRulesRequest
ListRulesResponse
NotificationActionConfiguration
Rule
Note: this value is the server’s effective state, not necessarily what was requested. A rule saved via
BatchUpdateRulesRequest.override_expression_validation = true whose UDF inlining fails (e.g. type resolution exhausted; see error returned by BatchUpdateRules) is forced to is_live_evaluation_enabled = false even when the caller requested true. To recover after the underlying issue is fixed (channels populated, expression simplified, etc.), reissue an UpdateRule / BatchUpdateRules request that explicitly sets is_live_evaluation_enabled = true. |
| current_version_id | string | | The current version of the rule. This is may be different from the rule_version.version if the rule has been updated since the rule_version was created. |
| folder_ids | string | repeated | Ids of the folders this rule belongs to. |
RuleAction
RuleActionConfiguration
RuleAssetConfiguration
RuleCondition
RuleConditionExpression
RuleVersion
SearchRulesRequest
SearchRulesResponse
SingleChannelComparisonExpression
Deprecated - use CalculatedChannelConfig.TimeRangeQuery
UnarchiveRuleRequest
UnarchiveRuleRequest is used to unarchive a rule by rule_id or client_key. If both are provided, only rule_id will be used.UnarchiveRuleResponse
This message has no fields.UndeleteRuleRequest
UndeleteRuleRequest is used to undelete a rule by rule_id or client_key. If both are provided, only rule_id will be used.UndeleteRuleResponse
This message has no fields.UpdateActionRequest
UpdateConditionRequest
UpdateHumanFriendlyRulesRequest
Deprecated - use UpdateJsonRulesRequest.UpdateHumanFriendlyRulesResponse
Deprecated - use UpdateJsonRulesResponse.UpdateJsonRulesRequest
UpdateJsonRulesResponse
UpdateRuleRequest
UpdateRuleRequest is used to create or update a rule. If the rule_id or client_key is provided, the rule will be updated. If not, a new rule will be created.
This is a request, not a guarantee. When combined with
BatchUpdateRulesRequest.override_expression_validation = true, a true value here can be silently overridden to false if UDF inlining fails (the rule is still persisted, just with live evaluation disabled). Re-send this request with the underlying issue resolved — e.g. the referenced channels populated, or the expression simplified — to flip it back on. |