protos(feature): new boolean field to toggle live rules

protos/sift/rules/v1/rules.proto

@@ -351,7 +351,12 @@ message Rule {
 
   // is_archived is inferred from when archived_date is not null
   bool is_archived = 21 [(google.api.field_behavior) = REQUIRED];
+
+  // If set to `true` then this rule will be evaluated on live data, otherwise live rule evaluation
+  // will be disabled. This rule can still be used, however, in report generation.
+  bool is_live_evaluation_enabled = 22 [(google.api.field_behavior) = OPTIONAL];
 }
+
 message RuleCondition {
   // 4 is reserved from old "status" column that lived directly on rule condition
   reserved 4;
@@ -475,7 +480,13 @@ message UpdateRuleRequest {
   bool is_external = 12;
   repeated sift.metadata.v1.MetadataValue metadata = 13 [(google.api.field_behavior) = REQUIRED];
   bool is_archived = 14 [(google.api.field_behavior) = OPTIONAL];
+
+  // If set to `true` then this rule will be evaluated on live data, otherwise live rule evaluation
+  // will be disabled. This rule can still be used, however, in report generation. If this value
+  // is null then the original value is preserved
+  optional bool is_live_evaluation_enabled = 15 [(google.api.field_behavior) = OPTIONAL];
 }
+
 message UpdateConditionRequest {
   // 2 is reserved from old status update support on rule condition directly
   reserved 2;
@@ -685,7 +696,7 @@ message ListRulesRequest {
 
   // A [Common Expression Language (CEL)](https://github.com/google/cel-spec) filter string.
   // Available fields to filter by are `rule_id`, `client_key`, `name`, `description`, `is_external`, `asset_id`, `tag_id`,
-  // `created_date`, `created_by_user_id`, `metadata`, `modified_date`, `modified_by_user_id`, `deleted_date`, `is_archived`, and `archived_date`.
+  // `created_date`, `created_by_user_id`, `metadata`, `modified_date`, `modified_by_user_id`, `deleted_date`, `is_archived`, `archived_date`, and `is_live_evaluation_enabled`.
   // For further information about how to use CELs, please refer to [this guide](https://github.com/google/cel-spec/blob/master/doc/langdef.md#standard-definitions).
   // Optional.
   string filter = 3 [(google.api.field_behavior) = OPTIONAL];
@@ -815,7 +826,6 @@ message NotificationActionConfiguration {
   repeated string recipient_user_ids = 1 [(google.api.field_behavior) = REQUIRED];
 }
 
-
 message AnnotationActionConfiguration {
   repeated string tag_ids = 1 [(google.api.field_behavior) = REQUIRED];
   sift.annotations.v1.AnnotationType annotation_type = 2;

python/lib/sift/rules/v1/rules_pb2.pyi

@@ -116,6 +116,7 @@ class Rule(google.protobuf.message.Message):
     METADATA_FIELD_NUMBER: builtins.int
     ARCHIVED_DATE_FIELD_NUMBER: builtins.int
     IS_ARCHIVED_FIELD_NUMBER: builtins.int
+    IS_LIVE_EVALUATION_ENABLED_FIELD_NUMBER: builtins.int
     rule_id: builtins.str
     asset_id: builtins.str
     name: builtins.str
@@ -129,6 +130,10 @@ class Rule(google.protobuf.message.Message):
     is_external: builtins.bool
     is_archived: builtins.bool
     """is_archived is inferred from when archived_date is not null"""
+    is_live_evaluation_enabled: builtins.bool
+    """If set to `true` then this rule will be evaluated on live data, otherwise live rule evaluation
+    will be disabled. This rule can still be used, however, in report generation.
+    """
     @property
     def created_date(self) -> google.protobuf.timestamp_pb2.Timestamp: ...
     @property
@@ -172,9 +177,10 @@ class Rule(google.protobuf.message.Message):
         metadata: collections.abc.Iterable[sift.metadata.v1.metadata_pb2.MetadataValue] | None = ...,
         archived_date: google.protobuf.timestamp_pb2.Timestamp | None = ...,
         is_archived: builtins.bool = ...,
+        is_live_evaluation_enabled: builtins.bool = ...,
     ) -> None: ...
     def HasField(self, field_name: typing.Literal["archived_date", b"archived_date", "asset_configuration", b"asset_configuration", "contextual_channels", b"contextual_channels", "created_date", b"created_date", "deleted_date", b"deleted_date", "modified_date", b"modified_date", "rule_version", b"rule_version"]) -> builtins.bool: ...
-    def ClearField(self, field_name: typing.Literal["archived_date", b"archived_date", "asset_configuration", b"asset_configuration", "asset_id", b"asset_id", "client_key", b"client_key", "conditions", b"conditions", "contextual_channels", b"contextual_channels", "created_by_user_id", b"created_by_user_id", "created_date", b"created_date", "deleted_date", b"deleted_date", "description", b"description", "is_archived", b"is_archived", "is_enabled", b"is_enabled", "is_external", b"is_external", "metadata", b"metadata", "modified_by_user_id", b"modified_by_user_id", "modified_date", b"modified_date", "name", b"name", "organization_id", b"organization_id", "rule_id", b"rule_id", "rule_version", b"rule_version"]) -> None: ...
+    def ClearField(self, field_name: typing.Literal["archived_date", b"archived_date", "asset_configuration", b"asset_configuration", "asset_id", b"asset_id", "client_key", b"client_key", "conditions", b"conditions", "contextual_channels", b"contextual_channels", "created_by_user_id", b"created_by_user_id", "created_date", b"created_date", "deleted_date", b"deleted_date", "description", b"description", "is_archived", b"is_archived", "is_enabled", b"is_enabled", "is_external", b"is_external", "is_live_evaluation_enabled", b"is_live_evaluation_enabled", "metadata", b"metadata", "modified_by_user_id", b"modified_by_user_id", "modified_date", b"modified_date", "name", b"name", "organization_id", b"organization_id", "rule_id", b"rule_id", "rule_version", b"rule_version"]) -> None: ...
 
 global___Rule = Rule
 
@@ -540,6 +546,7 @@ class UpdateRuleRequest(google.protobuf.message.Message):
     IS_EXTERNAL_FIELD_NUMBER: builtins.int
     METADATA_FIELD_NUMBER: builtins.int
     IS_ARCHIVED_FIELD_NUMBER: builtins.int
+    IS_LIVE_EVALUATION_ENABLED_FIELD_NUMBER: builtins.int
     rule_id: builtins.str
     name: builtins.str
     description: builtins.str
@@ -553,6 +560,11 @@ class UpdateRuleRequest(google.protobuf.message.Message):
     """client_key is a client provided identifier for the rule. It is immutable after being set"""
     is_external: builtins.bool
     is_archived: builtins.bool
+    is_live_evaluation_enabled: builtins.bool
+    """If set to `true` then this rule will be evaluated on live data, otherwise live rule evaluation
+    will be disabled. This rule can still be used, however, in report generation. If this value
+    is null then the original value is preserved
+    """
     @property
     def conditions(self) -> google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___UpdateConditionRequest]: ...
     @property
@@ -578,12 +590,15 @@ class UpdateRuleRequest(google.protobuf.message.Message):
         is_external: builtins.bool = ...,
         metadata: collections.abc.Iterable[sift.metadata.v1.metadata_pb2.MetadataValue] | None = ...,
         is_archived: builtins.bool = ...,
+        is_live_evaluation_enabled: builtins.bool | None = ...,
     ) -> None: ...
-    def HasField(self, field_name: typing.Literal["_client_key", b"_client_key", "_rule_id", b"_rule_id", "asset_configuration", b"asset_configuration", "client_key", b"client_key", "contextual_channels", b"contextual_channels", "rule_id", b"rule_id"]) -> builtins.bool: ...
-    def ClearField(self, field_name: typing.Literal["_client_key", b"_client_key", "_rule_id", b"_rule_id", "asset_configuration", b"asset_configuration", "asset_id", b"asset_id", "client_key", b"client_key", "conditions", b"conditions", "contextual_channels", b"contextual_channels", "description", b"description", "is_archived", b"is_archived", "is_enabled", b"is_enabled", "is_external", b"is_external", "metadata", b"metadata", "name", b"name", "organization_id", b"organization_id", "rule_id", b"rule_id", "version_notes", b"version_notes"]) -> None: ...
+    def HasField(self, field_name: typing.Literal["_client_key", b"_client_key", "_is_live_evaluation_enabled", b"_is_live_evaluation_enabled", "_rule_id", b"_rule_id", "asset_configuration", b"asset_configuration", "client_key", b"client_key", "contextual_channels", b"contextual_channels", "is_live_evaluation_enabled", b"is_live_evaluation_enabled", "rule_id", b"rule_id"]) -> builtins.bool: ...
+    def ClearField(self, field_name: typing.Literal["_client_key", b"_client_key", "_is_live_evaluation_enabled", b"_is_live_evaluation_enabled", "_rule_id", b"_rule_id", "asset_configuration", b"asset_configuration", "asset_id", b"asset_id", "client_key", b"client_key", "conditions", b"conditions", "contextual_channels", b"contextual_channels", "description", b"description", "is_archived", b"is_archived", "is_enabled", b"is_enabled", "is_external", b"is_external", "is_live_evaluation_enabled", b"is_live_evaluation_enabled", "metadata", b"metadata", "name", b"name", "organization_id", b"organization_id", "rule_id", b"rule_id", "version_notes", b"version_notes"]) -> None: ...
     @typing.overload
     def WhichOneof(self, oneof_group: typing.Literal["_client_key", b"_client_key"]) -> typing.Literal["client_key"] | None: ...
     @typing.overload
+    def WhichOneof(self, oneof_group: typing.Literal["_is_live_evaluation_enabled", b"_is_live_evaluation_enabled"]) -> typing.Literal["is_live_evaluation_enabled"] | None: ...
+    @typing.overload
     def WhichOneof(self, oneof_group: typing.Literal["_rule_id", b"_rule_id"]) -> typing.Literal["rule_id"] | None: ...
 
 global___UpdateRuleRequest = UpdateRuleRequest
@@ -1276,7 +1291,7 @@ class ListRulesRequest(google.protobuf.message.Message):
     filter: builtins.str
     """A [Common Expression Language (CEL)](https://github.com/google/cel-spec) filter string.
     Available fields to filter by are `rule_id`, `client_key`, `name`, `description`, `is_external`, `asset_id`, `tag_id`,
-    `created_date`, `created_by_user_id`, `metadata`, `modified_date`, `modified_by_user_id`, `deleted_date`, `is_archived`, and `archived_date`.
+    `created_date`, `created_by_user_id`, `metadata`, `modified_date`, `modified_by_user_id`, `deleted_date`, `is_archived`, `archived_date`, and `is_live_evaluation_enabled`.
     For further information about how to use CELs, please refer to [this guide](https://github.com/google/cel-spec/blob/master/doc/langdef.md#standard-definitions).
     Optional.
     """

python/lib/sift_client/resources/rules.py

@@ -82,6 +82,7 @@ async def list_(
         filter_query: str | None = None,
         order_by: str | None = None,
         limit: int | None = None,
+        is_live_evaluation_enabled: bool | None = None,
     ) -> list[Rule]:
         """List rules with optional filtering.
 
@@ -103,6 +104,7 @@ async def list_(
             asset_tags: Filter rules associated with any Assets that have these Tag IDs.
             description_contains: Partial description of the rule.
             include_archived: If True, include archived rules in results.
+            is_live_evaluation_enabled: If True, only include live rules. If False, only include rules that are not live. None for both.
             filter_query: Explicit CEL query to filter rules.
             order_by: Field and direction to order results by.
             limit: Maximum number of rules to return. If None, returns all matches.
@@ -136,9 +138,12 @@ async def list_(
             filter_parts.append(cel.in_("rule_id", rule_ids))
         if client_keys:
             filter_parts.append(cel.in_("client_key", client_keys))
+        if is_live_evaluation_enabled:
+            filter_parts.append(cel.equals("is_live_evaluation_enabled", is_live_evaluation_enabled))
         if assets:
             ids = [a._id_or_error if isinstance(a, Asset) else a or "" for a in assets]
             filter_parts.append(cel.in_("asset_id", ids))
+
         query_filter = cel.and_(*filter_parts)
         rules = await self._low_level_client.list_all_rules(
             filter_query=query_filter,