-
Notifications
You must be signed in to change notification settings - Fork 8
Expand file tree
/
Copy pathrules_pb2.pyi
More file actions
1834 lines (1571 loc) · 79.9 KB
/
rules_pb2.pyi
File metadata and controls
1834 lines (1571 loc) · 79.9 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
"""
@generated by mypy-protobuf. Do not edit manually!
isort:skip_file
INTERNAL NOTES FOR MAINTAINERS:
This protobuf package serves proxying layer for underlying services which still depend on
protobufs from the `azimuth.rules.v1` package. Any updates to this file need to be ported
in copy-paste fashion to `azimuth.rules.v1`.
Also, be sure to update the following Go package to convert between the new and legacy types.:
- azimuth.services.repo.rule.v1.pbmapper
"""
import builtins
import collections.abc
import google.protobuf.descriptor
import google.protobuf.internal.containers
import google.protobuf.internal.enum_type_wrapper
import google.protobuf.message
import google.protobuf.timestamp_pb2
import sift.annotations.v1.annotations_pb2
import sift.common.type.v1.resource_identifier_pb2
import sift.common.type.v1.user_defined_functions_pb2
import sift.metadata.v1.metadata_pb2
import sys
import typing
if sys.version_info >= (3, 10):
import typing as typing_extensions
else:
import typing_extensions
DESCRIPTOR: google.protobuf.descriptor.FileDescriptor
class _SearchOrder:
ValueType = typing.NewType("ValueType", builtins.int)
V: typing_extensions.TypeAlias = ValueType
class _SearchOrderEnumTypeWrapper(google.protobuf.internal.enum_type_wrapper._EnumTypeWrapper[_SearchOrder.ValueType], builtins.type):
DESCRIPTOR: google.protobuf.descriptor.EnumDescriptor
SEARCH_ORDER_UNSPECIFIED: _SearchOrder.ValueType # 0
SEARCH_ORDER_ASC: _SearchOrder.ValueType # 1
SEARCH_ORDER_DESC: _SearchOrder.ValueType # 2
class SearchOrder(_SearchOrder, metaclass=_SearchOrderEnumTypeWrapper): ...
SEARCH_ORDER_UNSPECIFIED: SearchOrder.ValueType # 0
SEARCH_ORDER_ASC: SearchOrder.ValueType # 1
SEARCH_ORDER_DESC: SearchOrder.ValueType # 2
global___SearchOrder = SearchOrder
class _ActionKind:
ValueType = typing.NewType("ValueType", builtins.int)
V: typing_extensions.TypeAlias = ValueType
class _ActionKindEnumTypeWrapper(google.protobuf.internal.enum_type_wrapper._EnumTypeWrapper[_ActionKind.ValueType], builtins.type):
DESCRIPTOR: google.protobuf.descriptor.EnumDescriptor
ACTION_KIND_UNSPECIFIED: _ActionKind.ValueType # 0
NOTIFICATION: _ActionKind.ValueType # 1
ANNOTATION: _ActionKind.ValueType # 2
WEBHOOK: _ActionKind.ValueType # 3
class ActionKind(_ActionKind, metaclass=_ActionKindEnumTypeWrapper): ...
ACTION_KIND_UNSPECIFIED: ActionKind.ValueType # 0
NOTIFICATION: ActionKind.ValueType # 1
ANNOTATION: ActionKind.ValueType # 2
WEBHOOK: ActionKind.ValueType # 3
global___ActionKind = ActionKind
class _ConditionComparator:
ValueType = typing.NewType("ValueType", builtins.int)
V: typing_extensions.TypeAlias = ValueType
class _ConditionComparatorEnumTypeWrapper(google.protobuf.internal.enum_type_wrapper._EnumTypeWrapper[_ConditionComparator.ValueType], builtins.type):
DESCRIPTOR: google.protobuf.descriptor.EnumDescriptor
CONDITION_COMPARATOR_UNSPECIFIED: _ConditionComparator.ValueType # 0
LESS_THAN: _ConditionComparator.ValueType # 1
LESS_THAN_OR_EQUAL: _ConditionComparator.ValueType # 2
GREATER_THAN: _ConditionComparator.ValueType # 3
GREATER_THAN_OR_EQUAL: _ConditionComparator.ValueType # 4
EQUAL: _ConditionComparator.ValueType # 5
NOT_EQUAL: _ConditionComparator.ValueType # 6
class ConditionComparator(_ConditionComparator, metaclass=_ConditionComparatorEnumTypeWrapper): ...
CONDITION_COMPARATOR_UNSPECIFIED: ConditionComparator.ValueType # 0
LESS_THAN: ConditionComparator.ValueType # 1
LESS_THAN_OR_EQUAL: ConditionComparator.ValueType # 2
GREATER_THAN: ConditionComparator.ValueType # 3
GREATER_THAN_OR_EQUAL: ConditionComparator.ValueType # 4
EQUAL: ConditionComparator.ValueType # 5
NOT_EQUAL: ConditionComparator.ValueType # 6
global___ConditionComparator = ConditionComparator
@typing.final
class Rule(google.protobuf.message.Message):
DESCRIPTOR: google.protobuf.descriptor.Descriptor
RULE_ID_FIELD_NUMBER: builtins.int
ASSET_ID_FIELD_NUMBER: builtins.int
NAME_FIELD_NUMBER: builtins.int
DESCRIPTION_FIELD_NUMBER: builtins.int
IS_ENABLED_FIELD_NUMBER: builtins.int
CREATED_DATE_FIELD_NUMBER: builtins.int
MODIFIED_DATE_FIELD_NUMBER: builtins.int
CREATED_BY_USER_ID_FIELD_NUMBER: builtins.int
MODIFIED_BY_USER_ID_FIELD_NUMBER: builtins.int
ORGANIZATION_ID_FIELD_NUMBER: builtins.int
CONDITIONS_FIELD_NUMBER: builtins.int
RULE_VERSION_FIELD_NUMBER: builtins.int
CLIENT_KEY_FIELD_NUMBER: builtins.int
ASSET_CONFIGURATION_FIELD_NUMBER: builtins.int
CONTEXTUAL_CHANNELS_FIELD_NUMBER: builtins.int
DELETED_DATE_FIELD_NUMBER: builtins.int
IS_EXTERNAL_FIELD_NUMBER: builtins.int
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
description: builtins.str
is_enabled: builtins.bool
created_by_user_id: builtins.str
modified_by_user_id: builtins.str
organization_id: builtins.str
client_key: builtins.str
"""client_key is a client provided identifier for the rule. It is immutable after rule creation."""
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
def modified_date(self) -> google.protobuf.timestamp_pb2.Timestamp: ...
@property
def conditions(self) -> google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___RuleCondition]: ...
@property
def rule_version(self) -> global___RuleVersion: ...
@property
def asset_configuration(self) -> global___RuleAssetConfiguration: ...
@property
def contextual_channels(self) -> global___ContextualChannels: ...
@property
def deleted_date(self) -> google.protobuf.timestamp_pb2.Timestamp: ...
@property
def metadata(self) -> google.protobuf.internal.containers.RepeatedCompositeFieldContainer[sift.metadata.v1.metadata_pb2.MetadataValue]: ...
@property
def archived_date(self) -> google.protobuf.timestamp_pb2.Timestamp:
"""archived_date indicates when the rule was archived"""
def __init__(
self,
*,
rule_id: builtins.str = ...,
asset_id: builtins.str = ...,
name: builtins.str = ...,
description: builtins.str = ...,
is_enabled: builtins.bool = ...,
created_date: google.protobuf.timestamp_pb2.Timestamp | None = ...,
modified_date: google.protobuf.timestamp_pb2.Timestamp | None = ...,
created_by_user_id: builtins.str = ...,
modified_by_user_id: builtins.str = ...,
organization_id: builtins.str = ...,
conditions: collections.abc.Iterable[global___RuleCondition] | None = ...,
rule_version: global___RuleVersion | None = ...,
client_key: builtins.str = ...,
asset_configuration: global___RuleAssetConfiguration | None = ...,
contextual_channels: global___ContextualChannels | None = ...,
deleted_date: google.protobuf.timestamp_pb2.Timestamp | None = ...,
is_external: builtins.bool = ...,
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", "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
@typing.final
class RuleCondition(google.protobuf.message.Message):
DESCRIPTOR: google.protobuf.descriptor.Descriptor
RULE_CONDITION_ID_FIELD_NUMBER: builtins.int
RULE_ID_FIELD_NUMBER: builtins.int
EXPRESSION_FIELD_NUMBER: builtins.int
CREATED_DATE_FIELD_NUMBER: builtins.int
MODIFIED_DATE_FIELD_NUMBER: builtins.int
CREATED_BY_USER_ID_FIELD_NUMBER: builtins.int
MODIFIED_BY_USER_ID_FIELD_NUMBER: builtins.int
ACTIONS_FIELD_NUMBER: builtins.int
RULE_CONDITION_VERSION_ID_FIELD_NUMBER: builtins.int
rule_condition_id: builtins.str
rule_id: builtins.str
created_by_user_id: builtins.str
modified_by_user_id: builtins.str
rule_condition_version_id: builtins.str
@property
def expression(self) -> global___RuleConditionExpression: ...
@property
def created_date(self) -> google.protobuf.timestamp_pb2.Timestamp: ...
@property
def modified_date(self) -> google.protobuf.timestamp_pb2.Timestamp: ...
@property
def actions(self) -> google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___RuleAction]: ...
def __init__(
self,
*,
rule_condition_id: builtins.str = ...,
rule_id: builtins.str = ...,
expression: global___RuleConditionExpression | None = ...,
created_date: google.protobuf.timestamp_pb2.Timestamp | None = ...,
modified_date: google.protobuf.timestamp_pb2.Timestamp | None = ...,
created_by_user_id: builtins.str = ...,
modified_by_user_id: builtins.str = ...,
actions: collections.abc.Iterable[global___RuleAction] | None = ...,
rule_condition_version_id: builtins.str = ...,
) -> None: ...
def HasField(self, field_name: typing.Literal["created_date", b"created_date", "expression", b"expression", "modified_date", b"modified_date"]) -> builtins.bool: ...
def ClearField(self, field_name: typing.Literal["actions", b"actions", "created_by_user_id", b"created_by_user_id", "created_date", b"created_date", "expression", b"expression", "modified_by_user_id", b"modified_by_user_id", "modified_date", b"modified_date", "rule_condition_id", b"rule_condition_id", "rule_condition_version_id", b"rule_condition_version_id", "rule_id", b"rule_id"]) -> None: ...
global___RuleCondition = RuleCondition
@typing.final
class RuleAction(google.protobuf.message.Message):
DESCRIPTOR: google.protobuf.descriptor.Descriptor
RULE_ACTION_ID_FIELD_NUMBER: builtins.int
RULE_CONDITION_ID_FIELD_NUMBER: builtins.int
ACTION_TYPE_FIELD_NUMBER: builtins.int
CONFIGURATION_FIELD_NUMBER: builtins.int
CREATED_DATE_FIELD_NUMBER: builtins.int
MODIFIED_DATE_FIELD_NUMBER: builtins.int
CREATED_BY_USER_ID_FIELD_NUMBER: builtins.int
MODIFIED_BY_USER_ID_FIELD_NUMBER: builtins.int
RULE_ACTION_VERSION_ID_FIELD_NUMBER: builtins.int
rule_action_id: builtins.str
rule_condition_id: builtins.str
action_type: global___ActionKind.ValueType
created_by_user_id: builtins.str
modified_by_user_id: builtins.str
rule_action_version_id: builtins.str
@property
def configuration(self) -> global___RuleActionConfiguration: ...
@property
def created_date(self) -> google.protobuf.timestamp_pb2.Timestamp: ...
@property
def modified_date(self) -> google.protobuf.timestamp_pb2.Timestamp: ...
def __init__(
self,
*,
rule_action_id: builtins.str = ...,
rule_condition_id: builtins.str = ...,
action_type: global___ActionKind.ValueType = ...,
configuration: global___RuleActionConfiguration | None = ...,
created_date: google.protobuf.timestamp_pb2.Timestamp | None = ...,
modified_date: google.protobuf.timestamp_pb2.Timestamp | None = ...,
created_by_user_id: builtins.str = ...,
modified_by_user_id: builtins.str = ...,
rule_action_version_id: builtins.str = ...,
) -> None: ...
def HasField(self, field_name: typing.Literal["configuration", b"configuration", "created_date", b"created_date", "modified_date", b"modified_date"]) -> builtins.bool: ...
def ClearField(self, field_name: typing.Literal["action_type", b"action_type", "configuration", b"configuration", "created_by_user_id", b"created_by_user_id", "created_date", b"created_date", "modified_by_user_id", b"modified_by_user_id", "modified_date", b"modified_date", "rule_action_id", b"rule_action_id", "rule_action_version_id", b"rule_action_version_id", "rule_condition_id", b"rule_condition_id"]) -> None: ...
global___RuleAction = RuleAction
@typing.final
class RuleAssetConfiguration(google.protobuf.message.Message):
DESCRIPTOR: google.protobuf.descriptor.Descriptor
ASSET_IDS_FIELD_NUMBER: builtins.int
TAG_IDS_FIELD_NUMBER: builtins.int
@property
def asset_ids(self) -> google.protobuf.internal.containers.RepeatedScalarFieldContainer[builtins.str]: ...
@property
def tag_ids(self) -> google.protobuf.internal.containers.RepeatedScalarFieldContainer[builtins.str]: ...
def __init__(
self,
*,
asset_ids: collections.abc.Iterable[builtins.str] | None = ...,
tag_ids: collections.abc.Iterable[builtins.str] | None = ...,
) -> None: ...
def ClearField(self, field_name: typing.Literal["asset_ids", b"asset_ids", "tag_ids", b"tag_ids"]) -> None: ...
global___RuleAssetConfiguration = RuleAssetConfiguration
@typing.final
class ContextualChannels(google.protobuf.message.Message):
DESCRIPTOR: google.protobuf.descriptor.Descriptor
CHANNELS_FIELD_NUMBER: builtins.int
@property
def channels(self) -> google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___ChannelReference]: ...
def __init__(
self,
*,
channels: collections.abc.Iterable[global___ChannelReference] | None = ...,
) -> None: ...
def ClearField(self, field_name: typing.Literal["channels", b"channels"]) -> None: ...
global___ContextualChannels = ContextualChannels
@typing.final
class AssetExpressionValidationResult(google.protobuf.message.Message):
DESCRIPTOR: google.protobuf.descriptor.Descriptor
ASSET_ID_FIELD_NUMBER: builtins.int
ASSET_NAME_FIELD_NUMBER: builtins.int
ASSET_TAG_ID_FIELD_NUMBER: builtins.int
ERROR_FIELD_NUMBER: builtins.int
asset_id: builtins.str
asset_name: builtins.str
asset_tag_id: builtins.str
"""asset_tag_id is the tag_id that caused this asset to be included in the rule"""
error: builtins.str
def __init__(
self,
*,
asset_id: builtins.str = ...,
asset_name: builtins.str = ...,
asset_tag_id: builtins.str = ...,
error: builtins.str | None = ...,
) -> None: ...
def HasField(self, field_name: typing.Literal["_error", b"_error", "error", b"error"]) -> builtins.bool: ...
def ClearField(self, field_name: typing.Literal["_error", b"_error", "asset_id", b"asset_id", "asset_name", b"asset_name", "asset_tag_id", b"asset_tag_id", "error", b"error"]) -> None: ...
def WhichOneof(self, oneof_group: typing.Literal["_error", b"_error"]) -> typing.Literal["error"] | None: ...
global___AssetExpressionValidationResult = AssetExpressionValidationResult
@typing.final
class SearchRulesRequest(google.protobuf.message.Message):
DESCRIPTOR: google.protobuf.descriptor.Descriptor
LIMIT_FIELD_NUMBER: builtins.int
OFFSET_FIELD_NUMBER: builtins.int
ORDER_FIELD_NUMBER: builtins.int
NAME_MATCHES_FIELD_NUMBER: builtins.int
CASE_SENSITIVE_FIELD_NUMBER: builtins.int
REGEXP_FIELD_NUMBER: builtins.int
ORDER_BY_FIELD_NUMBER: builtins.int
RULE_IDS_FIELD_NUMBER: builtins.int
ASSET_IDS_FIELD_NUMBER: builtins.int
INCLUDE_DELETED_FIELD_NUMBER: builtins.int
ASSET_TAGS_FIELD_NUMBER: builtins.int
limit: builtins.int
"""Max number of rules to return (returns all if omitted)."""
offset: builtins.int
"""Only applies if limit provided."""
order: global___SearchOrder.ValueType
"""Order to sort results by (defaults to ascending)."""
name_matches: builtins.str
case_sensitive: builtins.bool
regexp: builtins.bool
order_by: builtins.str
include_deleted: builtins.bool
@property
def rule_ids(self) -> google.protobuf.internal.containers.RepeatedScalarFieldContainer[builtins.str]:
"""If provided, only returns rules with the given ids"""
@property
def asset_ids(self) -> google.protobuf.internal.containers.RepeatedScalarFieldContainer[builtins.str]:
"""If provided, only returns rules that apply to the given asset ids"""
@property
def asset_tags(self) -> sift.common.type.v1.resource_identifier_pb2.NamedResources:
"""If provided, returns rules with assets that have the given tags"""
def __init__(
self,
*,
limit: builtins.int | None = ...,
offset: builtins.int = ...,
order: global___SearchOrder.ValueType | None = ...,
name_matches: builtins.str = ...,
case_sensitive: builtins.bool = ...,
regexp: builtins.bool = ...,
order_by: builtins.str | None = ...,
rule_ids: collections.abc.Iterable[builtins.str] | None = ...,
asset_ids: collections.abc.Iterable[builtins.str] | None = ...,
include_deleted: builtins.bool = ...,
asset_tags: sift.common.type.v1.resource_identifier_pb2.NamedResources | None = ...,
) -> None: ...
def HasField(self, field_name: typing.Literal["_limit", b"_limit", "_order", b"_order", "_order_by", b"_order_by", "asset_tags", b"asset_tags", "limit", b"limit", "order", b"order", "order_by", b"order_by"]) -> builtins.bool: ...
def ClearField(self, field_name: typing.Literal["_limit", b"_limit", "_order", b"_order", "_order_by", b"_order_by", "asset_ids", b"asset_ids", "asset_tags", b"asset_tags", "case_sensitive", b"case_sensitive", "include_deleted", b"include_deleted", "limit", b"limit", "name_matches", b"name_matches", "offset", b"offset", "order", b"order", "order_by", b"order_by", "regexp", b"regexp", "rule_ids", b"rule_ids"]) -> None: ...
@typing.overload
def WhichOneof(self, oneof_group: typing.Literal["_limit", b"_limit"]) -> typing.Literal["limit"] | None: ...
@typing.overload
def WhichOneof(self, oneof_group: typing.Literal["_order", b"_order"]) -> typing.Literal["order"] | None: ...
@typing.overload
def WhichOneof(self, oneof_group: typing.Literal["_order_by", b"_order_by"]) -> typing.Literal["order_by"] | None: ...
global___SearchRulesRequest = SearchRulesRequest
@typing.final
class SearchRulesResponse(google.protobuf.message.Message):
DESCRIPTOR: google.protobuf.descriptor.Descriptor
COUNT_FIELD_NUMBER: builtins.int
RULES_FIELD_NUMBER: builtins.int
count: builtins.int
@property
def rules(self) -> google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___Rule]:
"""Conditions are not included in the search response. The latest version of the rule is returned."""
def __init__(
self,
*,
count: builtins.int = ...,
rules: collections.abc.Iterable[global___Rule] | None = ...,
) -> None: ...
def ClearField(self, field_name: typing.Literal["count", b"count", "rules", b"rules"]) -> None: ...
global___SearchRulesResponse = SearchRulesResponse
@typing.final
class GetRuleRequest(google.protobuf.message.Message):
"""GetRuleRequest is used to retrieve a rule by rule_id or client_key. If both are provided, only rule_id will be used."""
DESCRIPTOR: google.protobuf.descriptor.Descriptor
RULE_ID_FIELD_NUMBER: builtins.int
CLIENT_KEY_FIELD_NUMBER: builtins.int
rule_id: builtins.str
client_key: builtins.str
def __init__(
self,
*,
rule_id: builtins.str = ...,
client_key: builtins.str = ...,
) -> None: ...
def ClearField(self, field_name: typing.Literal["client_key", b"client_key", "rule_id", b"rule_id"]) -> None: ...
global___GetRuleRequest = GetRuleRequest
@typing.final
class GetRuleResponse(google.protobuf.message.Message):
DESCRIPTOR: google.protobuf.descriptor.Descriptor
RULE_FIELD_NUMBER: builtins.int
@property
def rule(self) -> global___Rule: ...
def __init__(
self,
*,
rule: global___Rule | None = ...,
) -> None: ...
def HasField(self, field_name: typing.Literal["rule", b"rule"]) -> builtins.bool: ...
def ClearField(self, field_name: typing.Literal["rule", b"rule"]) -> None: ...
global___GetRuleResponse = GetRuleResponse
@typing.final
class BatchGetRulesRequest(google.protobuf.message.Message):
"""BatchGetRulesRequest is used to retrieve rules by rule_ids or client_keys. If both are provided, both will be used to retrieve rules."""
DESCRIPTOR: google.protobuf.descriptor.Descriptor
RULE_IDS_FIELD_NUMBER: builtins.int
CLIENT_KEYS_FIELD_NUMBER: builtins.int
@property
def rule_ids(self) -> google.protobuf.internal.containers.RepeatedScalarFieldContainer[builtins.str]: ...
@property
def client_keys(self) -> google.protobuf.internal.containers.RepeatedScalarFieldContainer[builtins.str]: ...
def __init__(
self,
*,
rule_ids: collections.abc.Iterable[builtins.str] | None = ...,
client_keys: collections.abc.Iterable[builtins.str] | None = ...,
) -> None: ...
def ClearField(self, field_name: typing.Literal["client_keys", b"client_keys", "rule_ids", b"rule_ids"]) -> None: ...
global___BatchGetRulesRequest = BatchGetRulesRequest
@typing.final
class BatchGetRulesResponse(google.protobuf.message.Message):
DESCRIPTOR: google.protobuf.descriptor.Descriptor
RULES_FIELD_NUMBER: builtins.int
@property
def rules(self) -> google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___Rule]: ...
def __init__(
self,
*,
rules: collections.abc.Iterable[global___Rule] | None = ...,
) -> None: ...
def ClearField(self, field_name: typing.Literal["rules", b"rules"]) -> None: ...
global___BatchGetRulesResponse = BatchGetRulesResponse
@typing.final
class CreateRuleRequest(google.protobuf.message.Message):
DESCRIPTOR: google.protobuf.descriptor.Descriptor
UPDATE_FIELD_NUMBER: builtins.int
@property
def update(self) -> global___UpdateRuleRequest: ...
def __init__(
self,
*,
update: global___UpdateRuleRequest | None = ...,
) -> None: ...
def HasField(self, field_name: typing.Literal["update", b"update"]) -> builtins.bool: ...
def ClearField(self, field_name: typing.Literal["update", b"update"]) -> None: ...
global___CreateRuleRequest = CreateRuleRequest
@typing.final
class CreateRuleResponse(google.protobuf.message.Message):
DESCRIPTOR: google.protobuf.descriptor.Descriptor
RULE_ID_FIELD_NUMBER: builtins.int
rule_id: builtins.str
def __init__(
self,
*,
rule_id: builtins.str = ...,
) -> None: ...
def ClearField(self, field_name: typing.Literal["rule_id", b"rule_id"]) -> None: ...
global___CreateRuleResponse = CreateRuleResponse
@typing.final
class UpdateRuleRequest(google.protobuf.message.Message):
"""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."""
DESCRIPTOR: google.protobuf.descriptor.Descriptor
RULE_ID_FIELD_NUMBER: builtins.int
NAME_FIELD_NUMBER: builtins.int
DESCRIPTION_FIELD_NUMBER: builtins.int
ASSET_ID_FIELD_NUMBER: builtins.int
IS_ENABLED_FIELD_NUMBER: builtins.int
CONDITIONS_FIELD_NUMBER: builtins.int
ORGANIZATION_ID_FIELD_NUMBER: builtins.int
VERSION_NOTES_FIELD_NUMBER: builtins.int
CLIENT_KEY_FIELD_NUMBER: builtins.int
ASSET_CONFIGURATION_FIELD_NUMBER: builtins.int
CONTEXTUAL_CHANNELS_FIELD_NUMBER: builtins.int
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
asset_id: builtins.str
"""Deprecated - use asset_configuration instead."""
is_enabled: builtins.bool
"""Deprecated - use DeleteRule instead."""
organization_id: builtins.str
version_notes: builtins.str
client_key: builtins.str
"""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
def asset_configuration(self) -> global___RuleAssetConfiguration: ...
@property
def contextual_channels(self) -> global___ContextualChannels: ...
@property
def metadata(self) -> google.protobuf.internal.containers.RepeatedCompositeFieldContainer[sift.metadata.v1.metadata_pb2.MetadataValue]: ...
def __init__(
self,
*,
rule_id: builtins.str | None = ...,
name: builtins.str = ...,
description: builtins.str = ...,
asset_id: builtins.str = ...,
is_enabled: builtins.bool = ...,
conditions: collections.abc.Iterable[global___UpdateConditionRequest] | None = ...,
organization_id: builtins.str = ...,
version_notes: builtins.str = ...,
client_key: builtins.str | None = ...,
asset_configuration: global___RuleAssetConfiguration | None = ...,
contextual_channels: global___ContextualChannels | None = ...,
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", "_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
@typing.final
class UpdateConditionRequest(google.protobuf.message.Message):
DESCRIPTOR: google.protobuf.descriptor.Descriptor
RULE_CONDITION_ID_FIELD_NUMBER: builtins.int
EXPRESSION_FIELD_NUMBER: builtins.int
ACTIONS_FIELD_NUMBER: builtins.int
rule_condition_id: builtins.str
@property
def expression(self) -> global___RuleConditionExpression: ...
@property
def actions(self) -> google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___UpdateActionRequest]: ...
def __init__(
self,
*,
rule_condition_id: builtins.str | None = ...,
expression: global___RuleConditionExpression | None = ...,
actions: collections.abc.Iterable[global___UpdateActionRequest] | None = ...,
) -> None: ...
def HasField(self, field_name: typing.Literal["_rule_condition_id", b"_rule_condition_id", "expression", b"expression", "rule_condition_id", b"rule_condition_id"]) -> builtins.bool: ...
def ClearField(self, field_name: typing.Literal["_rule_condition_id", b"_rule_condition_id", "actions", b"actions", "expression", b"expression", "rule_condition_id", b"rule_condition_id"]) -> None: ...
def WhichOneof(self, oneof_group: typing.Literal["_rule_condition_id", b"_rule_condition_id"]) -> typing.Literal["rule_condition_id"] | None: ...
global___UpdateConditionRequest = UpdateConditionRequest
@typing.final
class UpdateActionRequest(google.protobuf.message.Message):
DESCRIPTOR: google.protobuf.descriptor.Descriptor
RULE_ACTION_ID_FIELD_NUMBER: builtins.int
ACTION_TYPE_FIELD_NUMBER: builtins.int
CONFIGURATION_FIELD_NUMBER: builtins.int
rule_action_id: builtins.str
action_type: global___ActionKind.ValueType
@property
def configuration(self) -> global___RuleActionConfiguration: ...
def __init__(
self,
*,
rule_action_id: builtins.str | None = ...,
action_type: global___ActionKind.ValueType = ...,
configuration: global___RuleActionConfiguration | None = ...,
) -> None: ...
def HasField(self, field_name: typing.Literal["_rule_action_id", b"_rule_action_id", "configuration", b"configuration", "rule_action_id", b"rule_action_id"]) -> builtins.bool: ...
def ClearField(self, field_name: typing.Literal["_rule_action_id", b"_rule_action_id", "action_type", b"action_type", "configuration", b"configuration", "rule_action_id", b"rule_action_id"]) -> None: ...
def WhichOneof(self, oneof_group: typing.Literal["_rule_action_id", b"_rule_action_id"]) -> typing.Literal["rule_action_id"] | None: ...
global___UpdateActionRequest = UpdateActionRequest
@typing.final
class UpdateRuleResponse(google.protobuf.message.Message):
DESCRIPTOR: google.protobuf.descriptor.Descriptor
RULE_ID_FIELD_NUMBER: builtins.int
rule_id: builtins.str
def __init__(
self,
*,
rule_id: builtins.str = ...,
) -> None: ...
def ClearField(self, field_name: typing.Literal["rule_id", b"rule_id"]) -> None: ...
global___UpdateRuleResponse = UpdateRuleResponse
@typing.final
class ValidationResult(google.protobuf.message.Message):
DESCRIPTOR: google.protobuf.descriptor.Descriptor
RULE_ID_FIELD_NUMBER: builtins.int
CLIENT_KEY_FIELD_NUMBER: builtins.int
ASSET_EXPRESSION_VALIDATION_RESULTS_FIELD_NUMBER: builtins.int
ERROR_FIELD_NUMBER: builtins.int
rule_id: builtins.str
client_key: builtins.str
error: builtins.str
"""If the rule is invalid and unable to be saved, this will contain the error message. Expression errors will be returned in
the asset_expression_validation_results.
"""
@property
def asset_expression_validation_results(self) -> google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___AssetExpressionValidationResult]:
"""If the expression is invalid for an asset, one or more AssetExpressionValidationResult will be returned. This may block
saving if the override_expression_validation flag is not set.
"""
def __init__(
self,
*,
rule_id: builtins.str = ...,
client_key: builtins.str = ...,
asset_expression_validation_results: collections.abc.Iterable[global___AssetExpressionValidationResult] | None = ...,
error: builtins.str | None = ...,
) -> None: ...
def HasField(self, field_name: typing.Literal["_error", b"_error", "error", b"error"]) -> builtins.bool: ...
def ClearField(self, field_name: typing.Literal["_error", b"_error", "asset_expression_validation_results", b"asset_expression_validation_results", "client_key", b"client_key", "error", b"error", "rule_id", b"rule_id"]) -> None: ...
def WhichOneof(self, oneof_group: typing.Literal["_error", b"_error"]) -> typing.Literal["error"] | None: ...
global___ValidationResult = ValidationResult
@typing.final
class BatchUpdateRulesRequest(google.protobuf.message.Message):
DESCRIPTOR: google.protobuf.descriptor.Descriptor
RULES_FIELD_NUMBER: builtins.int
VALIDATE_ONLY_FIELD_NUMBER: builtins.int
OVERRIDE_EXPRESSION_VALIDATION_FIELD_NUMBER: builtins.int
validate_only: builtins.bool
"""If validate_only is true, the request will only validate the request and not save the rules."""
override_expression_validation: builtins.bool
"""If override_expression_validation is true, the request will save the rules even if the expressions are invalid. This
can be useful for multi-asset rules where an invalid expression for one asset should not prevent the rule from being saved.
"""
@property
def rules(self) -> google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___UpdateRuleRequest]:
"""rules are limited 1000 rules at a time"""
def __init__(
self,
*,
rules: collections.abc.Iterable[global___UpdateRuleRequest] | None = ...,
validate_only: builtins.bool = ...,
override_expression_validation: builtins.bool = ...,
) -> None: ...
def ClearField(self, field_name: typing.Literal["override_expression_validation", b"override_expression_validation", "rules", b"rules", "validate_only", b"validate_only"]) -> None: ...
global___BatchUpdateRulesRequest = BatchUpdateRulesRequest
@typing.final
class BatchUpdateRulesResponse(google.protobuf.message.Message):
DESCRIPTOR: google.protobuf.descriptor.Descriptor
@typing.final
class RuleIdentifiers(google.protobuf.message.Message):
DESCRIPTOR: google.protobuf.descriptor.Descriptor
RULE_ID_FIELD_NUMBER: builtins.int
NAME_FIELD_NUMBER: builtins.int
CLIENT_KEY_FIELD_NUMBER: builtins.int
rule_id: builtins.str
name: builtins.str
client_key: builtins.str
def __init__(
self,
*,
rule_id: builtins.str = ...,
name: builtins.str = ...,
client_key: builtins.str | None = ...,
) -> None: ...
def HasField(self, field_name: typing.Literal["_client_key", b"_client_key", "client_key", b"client_key"]) -> builtins.bool: ...
def ClearField(self, field_name: typing.Literal["_client_key", b"_client_key", "client_key", b"client_key", "name", b"name", "rule_id", b"rule_id"]) -> None: ...
def WhichOneof(self, oneof_group: typing.Literal["_client_key", b"_client_key"]) -> typing.Literal["client_key"] | None: ...
SUCCESS_FIELD_NUMBER: builtins.int
RULES_CREATED_COUNT_FIELD_NUMBER: builtins.int
RULES_UPDATED_COUNT_FIELD_NUMBER: builtins.int
VALIDATE_ONLY_FIELD_NUMBER: builtins.int
VALIDATION_RESULTS_FIELD_NUMBER: builtins.int
CREATED_RULE_IDENTIFIERS_FIELD_NUMBER: builtins.int
success: builtins.bool
rules_created_count: builtins.int
"""The total number of rules created in the request. If validate_only is true, this will indicate how many rules would have been created."""
rules_updated_count: builtins.int
"""The total number of rules updated in the request. If validate_only is true, this will indicate how many rules would have been updated."""
validate_only: builtins.bool
"""This will be true if the request only validated the request and did not save the rules."""
@property
def validation_results(self) -> google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___ValidationResult]:
"""One ValidationResult per rule in the request will be returned"""
@property
def created_rule_identifiers(self) -> google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___BatchUpdateRulesResponse.RuleIdentifiers]:
"""The created rule id, name, version, and client key."""
def __init__(
self,
*,
success: builtins.bool = ...,
rules_created_count: builtins.int = ...,
rules_updated_count: builtins.int = ...,
validate_only: builtins.bool = ...,
validation_results: collections.abc.Iterable[global___ValidationResult] | None = ...,
created_rule_identifiers: collections.abc.Iterable[global___BatchUpdateRulesResponse.RuleIdentifiers] | None = ...,
) -> None: ...
def ClearField(self, field_name: typing.Literal["created_rule_identifiers", b"created_rule_identifiers", "rules_created_count", b"rules_created_count", "rules_updated_count", b"rules_updated_count", "success", b"success", "validate_only", b"validate_only", "validation_results", b"validation_results"]) -> None: ...
global___BatchUpdateRulesResponse = BatchUpdateRulesResponse
@typing.final
class DeleteRuleRequest(google.protobuf.message.Message):
"""DeleteRuleRequest is used to delete a rule by rule_id or client_key. If both are provided, only rule_id will be used."""
DESCRIPTOR: google.protobuf.descriptor.Descriptor
RULE_ID_FIELD_NUMBER: builtins.int
CLIENT_KEY_FIELD_NUMBER: builtins.int
rule_id: builtins.str
client_key: builtins.str
def __init__(
self,
*,
rule_id: builtins.str = ...,
client_key: builtins.str = ...,
) -> None: ...
def ClearField(self, field_name: typing.Literal["client_key", b"client_key", "rule_id", b"rule_id"]) -> None: ...
global___DeleteRuleRequest = DeleteRuleRequest
@typing.final
class DeleteRuleResponse(google.protobuf.message.Message):
DESCRIPTOR: google.protobuf.descriptor.Descriptor
def __init__(
self,
) -> None: ...
global___DeleteRuleResponse = DeleteRuleResponse
@typing.final
class BatchDeleteRulesRequest(google.protobuf.message.Message):
"""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."""
DESCRIPTOR: google.protobuf.descriptor.Descriptor
RULE_IDS_FIELD_NUMBER: builtins.int
CLIENT_KEYS_FIELD_NUMBER: builtins.int
@property
def rule_ids(self) -> google.protobuf.internal.containers.RepeatedScalarFieldContainer[builtins.str]: ...
@property
def client_keys(self) -> google.protobuf.internal.containers.RepeatedScalarFieldContainer[builtins.str]: ...
def __init__(
self,
*,
rule_ids: collections.abc.Iterable[builtins.str] | None = ...,
client_keys: collections.abc.Iterable[builtins.str] | None = ...,
) -> None: ...
def ClearField(self, field_name: typing.Literal["client_keys", b"client_keys", "rule_ids", b"rule_ids"]) -> None: ...
global___BatchDeleteRulesRequest = BatchDeleteRulesRequest
@typing.final
class BatchDeleteRulesResponse(google.protobuf.message.Message):
DESCRIPTOR: google.protobuf.descriptor.Descriptor
def __init__(
self,
) -> None: ...
global___BatchDeleteRulesResponse = BatchDeleteRulesResponse
@typing.final
class ArchiveRuleRequest(google.protobuf.message.Message):
"""ArchiveRuleRequest is used to archive a rule by rule_id or client_key. If both are provided, only rule_id will be used."""
DESCRIPTOR: google.protobuf.descriptor.Descriptor
RULE_ID_FIELD_NUMBER: builtins.int
CLIENT_KEY_FIELD_NUMBER: builtins.int
rule_id: builtins.str
client_key: builtins.str
def __init__(
self,
*,
rule_id: builtins.str = ...,
client_key: builtins.str = ...,
) -> None: ...
def ClearField(self, field_name: typing.Literal["client_key", b"client_key", "rule_id", b"rule_id"]) -> None: ...
global___ArchiveRuleRequest = ArchiveRuleRequest
@typing.final
class ArchiveRuleResponse(google.protobuf.message.Message):
DESCRIPTOR: google.protobuf.descriptor.Descriptor
def __init__(
self,
) -> None: ...
global___ArchiveRuleResponse = ArchiveRuleResponse
@typing.final
class BatchArchiveRulesRequest(google.protobuf.message.Message):
"""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."""
DESCRIPTOR: google.protobuf.descriptor.Descriptor
RULE_IDS_FIELD_NUMBER: builtins.int
CLIENT_KEYS_FIELD_NUMBER: builtins.int
@property
def rule_ids(self) -> google.protobuf.internal.containers.RepeatedScalarFieldContainer[builtins.str]: ...
@property
def client_keys(self) -> google.protobuf.internal.containers.RepeatedScalarFieldContainer[builtins.str]: ...
def __init__(
self,
*,
rule_ids: collections.abc.Iterable[builtins.str] | None = ...,
client_keys: collections.abc.Iterable[builtins.str] | None = ...,
) -> None: ...
def ClearField(self, field_name: typing.Literal["client_keys", b"client_keys", "rule_ids", b"rule_ids"]) -> None: ...
global___BatchArchiveRulesRequest = BatchArchiveRulesRequest
@typing.final
class BatchArchiveRulesResponse(google.protobuf.message.Message):
DESCRIPTOR: google.protobuf.descriptor.Descriptor
def __init__(
self,
) -> None: ...
global___BatchArchiveRulesResponse = BatchArchiveRulesResponse
@typing.final
class UndeleteRuleRequest(google.protobuf.message.Message):
"""UndeleteRuleRequest is used to undelete a rule by rule_id or client_key. If both are provided, only rule_id will be used."""
DESCRIPTOR: google.protobuf.descriptor.Descriptor
RULE_ID_FIELD_NUMBER: builtins.int
CLIENT_KEY_FIELD_NUMBER: builtins.int
rule_id: builtins.str
client_key: builtins.str
def __init__(
self,
*,
rule_id: builtins.str = ...,
client_key: builtins.str = ...,
) -> None: ...
def ClearField(self, field_name: typing.Literal["client_key", b"client_key", "rule_id", b"rule_id"]) -> None: ...
global___UndeleteRuleRequest = UndeleteRuleRequest
@typing.final
class UndeleteRuleResponse(google.protobuf.message.Message):
DESCRIPTOR: google.protobuf.descriptor.Descriptor
def __init__(
self,
) -> None: ...
global___UndeleteRuleResponse = UndeleteRuleResponse
@typing.final
class BatchUndeleteRulesRequest(google.protobuf.message.Message):
"""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."""
DESCRIPTOR: google.protobuf.descriptor.Descriptor
RULE_IDS_FIELD_NUMBER: builtins.int
CLIENT_KEYS_FIELD_NUMBER: builtins.int
@property
def rule_ids(self) -> google.protobuf.internal.containers.RepeatedScalarFieldContainer[builtins.str]: ...
@property
def client_keys(self) -> google.protobuf.internal.containers.RepeatedScalarFieldContainer[builtins.str]: ...
def __init__(
self,
*,
rule_ids: collections.abc.Iterable[builtins.str] | None = ...,
client_keys: collections.abc.Iterable[builtins.str] | None = ...,
) -> None: ...
def ClearField(self, field_name: typing.Literal["client_keys", b"client_keys", "rule_ids", b"rule_ids"]) -> None: ...
global___BatchUndeleteRulesRequest = BatchUndeleteRulesRequest
@typing.final
class BatchUndeleteRulesResponse(google.protobuf.message.Message):
DESCRIPTOR: google.protobuf.descriptor.Descriptor
def __init__(
self,
) -> None: ...
global___BatchUndeleteRulesResponse = BatchUndeleteRulesResponse
@typing.final
class UnarchiveRuleRequest(google.protobuf.message.Message):
"""UnarchiveRuleRequest is used to unarchive a rule by rule_id or client_key. If both are provided, only rule_id will be used."""
DESCRIPTOR: google.protobuf.descriptor.Descriptor
RULE_ID_FIELD_NUMBER: builtins.int
CLIENT_KEY_FIELD_NUMBER: builtins.int
rule_id: builtins.str
client_key: builtins.str
def __init__(
self,
*,
rule_id: builtins.str = ...,
client_key: builtins.str = ...,
) -> None: ...
def ClearField(self, field_name: typing.Literal["client_key", b"client_key", "rule_id", b"rule_id"]) -> None: ...
global___UnarchiveRuleRequest = UnarchiveRuleRequest
@typing.final
class UnarchiveRuleResponse(google.protobuf.message.Message):
DESCRIPTOR: google.protobuf.descriptor.Descriptor