This repository has been archived by the owner on Sep 5, 2023. It is now read-only.
/
securitycenter_service.py
1365 lines (1101 loc) · 53.6 KB
/
securitycenter_service.py
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
# -*- coding: utf-8 -*-
# Copyright 2020 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
import proto # type: ignore
from google.cloud.securitycenter_v1.types import asset as gcs_asset
from google.cloud.securitycenter_v1.types import finding as gcs_finding
from google.cloud.securitycenter_v1.types import folder
from google.cloud.securitycenter_v1.types import (
notification_config as gcs_notification_config,
)
from google.cloud.securitycenter_v1.types import (
organization_settings as gcs_organization_settings,
)
from google.cloud.securitycenter_v1.types import security_marks as gcs_security_marks
from google.cloud.securitycenter_v1.types import source as gcs_source
from google.protobuf import duration_pb2 # type: ignore
from google.protobuf import field_mask_pb2 # type: ignore
from google.protobuf import struct_pb2 # type: ignore
from google.protobuf import timestamp_pb2 # type: ignore
__protobuf__ = proto.module(
package="google.cloud.securitycenter.v1",
manifest={
"CreateFindingRequest",
"CreateNotificationConfigRequest",
"CreateSourceRequest",
"DeleteNotificationConfigRequest",
"GetNotificationConfigRequest",
"GetOrganizationSettingsRequest",
"GetSourceRequest",
"GroupAssetsRequest",
"GroupAssetsResponse",
"GroupFindingsRequest",
"GroupFindingsResponse",
"GroupResult",
"ListNotificationConfigsRequest",
"ListNotificationConfigsResponse",
"ListSourcesRequest",
"ListSourcesResponse",
"ListAssetsRequest",
"ListAssetsResponse",
"ListFindingsRequest",
"ListFindingsResponse",
"SetFindingStateRequest",
"RunAssetDiscoveryRequest",
"UpdateFindingRequest",
"UpdateNotificationConfigRequest",
"UpdateOrganizationSettingsRequest",
"UpdateSourceRequest",
"UpdateSecurityMarksRequest",
},
)
class CreateFindingRequest(proto.Message):
r"""Request message for creating a finding.
Attributes:
parent (str):
Required. Resource name of the new finding's parent. Its
format should be
"organizations/[organization_id]/sources/[source_id]".
finding_id (str):
Required. Unique identifier provided by the
client within the parent scope. It must be
alphanumeric and less than or equal to 32
characters and greater than 0 characters in
length.
finding (google.cloud.securitycenter_v1.types.Finding):
Required. The Finding being created. The name and
security_marks will be ignored as they are both output only
fields on this resource.
"""
parent = proto.Field(proto.STRING, number=1,)
finding_id = proto.Field(proto.STRING, number=2,)
finding = proto.Field(proto.MESSAGE, number=3, message=gcs_finding.Finding,)
class CreateNotificationConfigRequest(proto.Message):
r"""Request message for creating a notification config.
Attributes:
parent (str):
Required. Resource name of the new notification config's
parent. Its format is "organizations/[organization_id]".
config_id (str):
Required.
Unique identifier provided by the client within
the parent scope. It must be between 1 and 128
characters, and contains alphanumeric
characters, underscores or hyphens only.
notification_config (google.cloud.securitycenter_v1.types.NotificationConfig):
Required. The notification config being
created. The name and the service account will
be ignored as they are both output only fields
on this resource.
"""
parent = proto.Field(proto.STRING, number=1,)
config_id = proto.Field(proto.STRING, number=2,)
notification_config = proto.Field(
proto.MESSAGE, number=3, message=gcs_notification_config.NotificationConfig,
)
class CreateSourceRequest(proto.Message):
r"""Request message for creating a source.
Attributes:
parent (str):
Required. Resource name of the new source's parent. Its
format should be "organizations/[organization_id]".
source (google.cloud.securitycenter_v1.types.Source):
Required. The Source being created, only the display_name
and description will be used. All other fields will be
ignored.
"""
parent = proto.Field(proto.STRING, number=1,)
source = proto.Field(proto.MESSAGE, number=2, message=gcs_source.Source,)
class DeleteNotificationConfigRequest(proto.Message):
r"""Request message for deleting a notification config.
Attributes:
name (str):
Required. Name of the notification config to delete. Its
format is
"organizations/[organization_id]/notificationConfigs/[config_id]".
"""
name = proto.Field(proto.STRING, number=1,)
class GetNotificationConfigRequest(proto.Message):
r"""Request message for getting a notification config.
Attributes:
name (str):
Required. Name of the notification config to get. Its format
is
"organizations/[organization_id]/notificationConfigs/[config_id]".
"""
name = proto.Field(proto.STRING, number=1,)
class GetOrganizationSettingsRequest(proto.Message):
r"""Request message for getting organization settings.
Attributes:
name (str):
Required. Name of the organization to get organization
settings for. Its format is
"organizations/[organization_id]/organizationSettings".
"""
name = proto.Field(proto.STRING, number=1,)
class GetSourceRequest(proto.Message):
r"""Request message for getting a source.
Attributes:
name (str):
Required. Relative resource name of the source. Its format
is "organizations/[organization_id]/source/[source_id]".
"""
name = proto.Field(proto.STRING, number=1,)
class GroupAssetsRequest(proto.Message):
r"""Request message for grouping by assets.
Attributes:
parent (str):
Required. Name of the organization to groupBy. Its format is
"organizations/[organization_id], folders/[folder_id], or
projects/[project_id]".
filter (str):
Expression that defines the filter to apply across assets.
The expression is a list of zero or more restrictions
combined via logical operators ``AND`` and ``OR``.
Parentheses are supported, and ``OR`` has higher precedence
than ``AND``.
Restrictions have the form ``<field> <operator> <value>``
and may have a ``-`` character in front of them to indicate
negation. The fields map to those defined in the Asset
resource. Examples include:
- name
- security_center_properties.resource_name
- resource_properties.a_property
- security_marks.marks.marka
The supported operators are:
- ``=`` for all value types.
- ``>``, ``<``, ``>=``, ``<=`` for integer values.
- ``:``, meaning substring matching, for strings.
The supported value types are:
- string literals in quotes.
- integer literals without quotes.
- boolean literals ``true`` and ``false`` without quotes.
The following field and operator combinations are supported:
- name: ``=``
- update_time: ``=``, ``>``, ``<``, ``>=``, ``<=``
Usage: This should be milliseconds since epoch or an
RFC3339 string. Examples:
``update_time = "2019-06-10T16:07:18-07:00"``
``update_time = 1560208038000``
- create_time: ``=``, ``>``, ``<``, ``>=``, ``<=``
Usage: This should be milliseconds since epoch or an
RFC3339 string. Examples:
``create_time = "2019-06-10T16:07:18-07:00"``
``create_time = 1560208038000``
- iam_policy.policy_blob: ``=``, ``:``
- resource_properties: ``=``, ``:``, ``>``, ``<``, ``>=``,
``<=``
- security_marks.marks: ``=``, ``:``
- security_center_properties.resource_name: ``=``, ``:``
- security_center_properties.resource_display_name: ``=``,
``:``
- security_center_properties.resource_type: ``=``, ``:``
- security_center_properties.resource_parent: ``=``, ``:``
- security_center_properties.resource_parent_display_name:
``=``, ``:``
- security_center_properties.resource_project: ``=``, ``:``
- security_center_properties.resource_project_display_name:
``=``, ``:``
- security_center_properties.resource_owners: ``=``, ``:``
For example, ``resource_properties.size = 100`` is a valid
filter string.
Use a partial match on the empty string to filter based on a
property existing: ``resource_properties.my_property : ""``
Use a negated partial match on the empty string to filter
based on a property not existing:
``-resource_properties.my_property : ""``
group_by (str):
Required. Expression that defines what assets fields to use
for grouping. The string value should follow SQL syntax:
comma separated list of fields. For example:
"security_center_properties.resource_project,security_center_properties.project".
The following fields are supported when compare_duration is
not set:
- security_center_properties.resource_project
- security_center_properties.resource_project_display_name
- security_center_properties.resource_type
- security_center_properties.resource_parent
- security_center_properties.resource_parent_display_name
The following fields are supported when compare_duration is
set:
- security_center_properties.resource_type
- security_center_properties.resource_project_display_name
- security_center_properties.resource_parent_display_name
compare_duration (google.protobuf.duration_pb2.Duration):
When compare_duration is set, the GroupResult's
"state_change" property is updated to indicate whether the
asset was added, removed, or remained present during the
compare_duration period of time that precedes the read_time.
This is the time between (read_time - compare_duration) and
read_time.
The state change value is derived based on the presence of
the asset at the two points in time. Intermediate state
changes between the two times don't affect the result. For
example, the results aren't affected if the asset is removed
and re-created again.
Possible "state_change" values when compare_duration is
specified:
- "ADDED": indicates that the asset was not present at the
start of compare_duration, but present at reference_time.
- "REMOVED": indicates that the asset was present at the
start of compare_duration, but not present at
reference_time.
- "ACTIVE": indicates that the asset was present at both
the start and the end of the time period defined by
compare_duration and reference_time.
If compare_duration is not specified, then the only possible
state_change is "UNUSED", which will be the state_change set
for all assets present at read_time.
If this field is set then ``state_change`` must be a
specified field in ``group_by``.
read_time (google.protobuf.timestamp_pb2.Timestamp):
Time used as a reference point when filtering
assets. The filter is limited to assets existing
at the supplied time and their values are those
at that specific time. Absence of this field
will default to the API's version of NOW.
page_token (str):
The value returned by the last ``GroupAssetsResponse``;
indicates that this is a continuation of a prior
``GroupAssets`` call, and that the system should return the
next page of data.
page_size (int):
The maximum number of results to return in a
single response. Default is 10, minimum is 1,
maximum is 1000.
"""
parent = proto.Field(proto.STRING, number=1,)
filter = proto.Field(proto.STRING, number=2,)
group_by = proto.Field(proto.STRING, number=3,)
compare_duration = proto.Field(
proto.MESSAGE, number=4, message=duration_pb2.Duration,
)
read_time = proto.Field(proto.MESSAGE, number=5, message=timestamp_pb2.Timestamp,)
page_token = proto.Field(proto.STRING, number=7,)
page_size = proto.Field(proto.INT32, number=8,)
class GroupAssetsResponse(proto.Message):
r"""Response message for grouping by assets.
Attributes:
group_by_results (Sequence[google.cloud.securitycenter_v1.types.GroupResult]):
Group results. There exists an element for
each existing unique combination of
property/values. The element contains a count
for the number of times those specific
property/values appear.
read_time (google.protobuf.timestamp_pb2.Timestamp):
Time used for executing the groupBy request.
next_page_token (str):
Token to retrieve the next page of results,
or empty if there are no more results.
total_size (int):
The total number of results matching the
query.
"""
@property
def raw_page(self):
return self
group_by_results = proto.RepeatedField(
proto.MESSAGE, number=1, message="GroupResult",
)
read_time = proto.Field(proto.MESSAGE, number=2, message=timestamp_pb2.Timestamp,)
next_page_token = proto.Field(proto.STRING, number=3,)
total_size = proto.Field(proto.INT32, number=4,)
class GroupFindingsRequest(proto.Message):
r"""Request message for grouping by findings.
Attributes:
parent (str):
Required. Name of the source to groupBy. Its format is
"organizations/[organization_id]/sources/[source_id]",
folders/[folder_id]/sources/[source_id], or
projects/[project_id]/sources/[source_id]. To groupBy across
all sources provide a source_id of ``-``. For example:
organizations/{organization_id}/sources/-,
folders/{folder_id}/sources/-, or
projects/{project_id}/sources/-
filter (str):
Expression that defines the filter to apply across findings.
The expression is a list of one or more restrictions
combined via logical operators ``AND`` and ``OR``.
Parentheses are supported, and ``OR`` has higher precedence
than ``AND``.
Restrictions have the form ``<field> <operator> <value>``
and may have a ``-`` character in front of them to indicate
negation. Examples include:
- name
- source_properties.a_property
- security_marks.marks.marka
The supported operators are:
- ``=`` for all value types.
- ``>``, ``<``, ``>=``, ``<=`` for integer values.
- ``:``, meaning substring matching, for strings.
The supported value types are:
- string literals in quotes.
- integer literals without quotes.
- boolean literals ``true`` and ``false`` without quotes.
The following field and operator combinations are supported:
- name: ``=``
- parent: ``=``, ``:``
- resource_name: ``=``, ``:``
- state: ``=``, ``:``
- category: ``=``, ``:``
- external_uri: ``=``, ``:``
- event_time: ``=``, ``>``, ``<``, ``>=``, ``<=``
Usage: This should be milliseconds since epoch or an
RFC3339 string. Examples:
``event_time = "2019-06-10T16:07:18-07:00"``
``event_time = 1560208038000``
- severity: ``=``, ``:``
- workflow_state: ``=``, ``:``
- security_marks.marks: ``=``, ``:``
- source_properties: ``=``, ``:``, ``>``, ``<``, ``>=``,
``<=``
For example, ``source_properties.size = 100`` is a valid
filter string.
Use a partial match on the empty string to filter based
on a property existing:
``source_properties.my_property : ""``
Use a negated partial match on the empty string to filter
based on a property not existing:
``-source_properties.my_property : ""``
- resource:
- resource.name: ``=``, ``:``
- resource.parent_name: ``=``, ``:``
- resource.parent_display_name: ``=``, ``:``
- resource.project_name: ``=``, ``:``
- resource.project_display_name: ``=``, ``:``
- resource.type: ``=``, ``:``
group_by (str):
Required. Expression that defines what assets fields to use
for grouping (including ``state_change``). The string value
should follow SQL syntax: comma separated list of fields.
For example: "parent,resource_name".
The following fields are supported:
- resource_name
- category
- state
- parent
- severity
The following fields are supported when compare_duration is
set:
- state_change
read_time (google.protobuf.timestamp_pb2.Timestamp):
Time used as a reference point when filtering
findings. The filter is limited to findings
existing at the supplied time and their values
are those at that specific time. Absence of this
field will default to the API's version of NOW.
compare_duration (google.protobuf.duration_pb2.Duration):
When compare_duration is set, the GroupResult's
"state_change" attribute is updated to indicate whether the
finding had its state changed, the finding's state remained
unchanged, or if the finding was added during the
compare_duration period of time that precedes the read_time.
This is the time between (read_time - compare_duration) and
read_time.
The state_change value is derived based on the presence and
state of the finding at the two points in time. Intermediate
state changes between the two times don't affect the result.
For example, the results aren't affected if the finding is
made inactive and then active again.
Possible "state_change" values when compare_duration is
specified:
- "CHANGED": indicates that the finding was present and
matched the given filter at the start of
compare_duration, but changed its state at read_time.
- "UNCHANGED": indicates that the finding was present and
matched the given filter at the start of compare_duration
and did not change state at read_time.
- "ADDED": indicates that the finding did not match the
given filter or was not present at the start of
compare_duration, but was present at read_time.
- "REMOVED": indicates that the finding was present and
matched the filter at the start of compare_duration, but
did not match the filter at read_time.
If compare_duration is not specified, then the only possible
state_change is "UNUSED", which will be the state_change set
for all findings present at read_time.
If this field is set then ``state_change`` must be a
specified field in ``group_by``.
page_token (str):
The value returned by the last ``GroupFindingsResponse``;
indicates that this is a continuation of a prior
``GroupFindings`` call, and that the system should return
the next page of data.
page_size (int):
The maximum number of results to return in a
single response. Default is 10, minimum is 1,
maximum is 1000.
"""
parent = proto.Field(proto.STRING, number=1,)
filter = proto.Field(proto.STRING, number=2,)
group_by = proto.Field(proto.STRING, number=3,)
read_time = proto.Field(proto.MESSAGE, number=4, message=timestamp_pb2.Timestamp,)
compare_duration = proto.Field(
proto.MESSAGE, number=5, message=duration_pb2.Duration,
)
page_token = proto.Field(proto.STRING, number=7,)
page_size = proto.Field(proto.INT32, number=8,)
class GroupFindingsResponse(proto.Message):
r"""Response message for group by findings.
Attributes:
group_by_results (Sequence[google.cloud.securitycenter_v1.types.GroupResult]):
Group results. There exists an element for
each existing unique combination of
property/values. The element contains a count
for the number of times those specific
property/values appear.
read_time (google.protobuf.timestamp_pb2.Timestamp):
Time used for executing the groupBy request.
next_page_token (str):
Token to retrieve the next page of results,
or empty if there are no more results.
total_size (int):
The total number of results matching the
query.
"""
@property
def raw_page(self):
return self
group_by_results = proto.RepeatedField(
proto.MESSAGE, number=1, message="GroupResult",
)
read_time = proto.Field(proto.MESSAGE, number=2, message=timestamp_pb2.Timestamp,)
next_page_token = proto.Field(proto.STRING, number=3,)
total_size = proto.Field(proto.INT32, number=4,)
class GroupResult(proto.Message):
r"""Result containing the properties and count of a groupBy
request.
Attributes:
properties (Sequence[google.cloud.securitycenter_v1.types.GroupResult.PropertiesEntry]):
Properties matching the groupBy fields in the
request.
count (int):
Total count of resources for the given
properties.
"""
properties = proto.MapField(
proto.STRING, proto.MESSAGE, number=1, message=struct_pb2.Value,
)
count = proto.Field(proto.INT64, number=2,)
class ListNotificationConfigsRequest(proto.Message):
r"""Request message for listing notification configs.
Attributes:
parent (str):
Required. Name of the organization to list notification
configs. Its format is "organizations/[organization_id]".
page_token (str):
The value returned by the last
``ListNotificationConfigsResponse``; indicates that this is
a continuation of a prior ``ListNotificationConfigs`` call,
and that the system should return the next page of data.
page_size (int):
The maximum number of results to return in a
single response. Default is 10, minimum is 1,
maximum is 1000.
"""
parent = proto.Field(proto.STRING, number=1,)
page_token = proto.Field(proto.STRING, number=2,)
page_size = proto.Field(proto.INT32, number=3,)
class ListNotificationConfigsResponse(proto.Message):
r"""Response message for listing notification configs.
Attributes:
notification_configs (Sequence[google.cloud.securitycenter_v1.types.NotificationConfig]):
Notification configs belonging to the
requested parent.
next_page_token (str):
Token to retrieve the next page of results,
or empty if there are no more results.
"""
@property
def raw_page(self):
return self
notification_configs = proto.RepeatedField(
proto.MESSAGE, number=1, message=gcs_notification_config.NotificationConfig,
)
next_page_token = proto.Field(proto.STRING, number=2,)
class ListSourcesRequest(proto.Message):
r"""Request message for listing sources.
Attributes:
parent (str):
Required. Resource name of the parent of sources to list.
Its format should be "organizations/[organization_id],
folders/[folder_id], or projects/[project_id]".
page_token (str):
The value returned by the last ``ListSourcesResponse``;
indicates that this is a continuation of a prior
``ListSources`` call, and that the system should return the
next page of data.
page_size (int):
The maximum number of results to return in a
single response. Default is 10, minimum is 1,
maximum is 1000.
"""
parent = proto.Field(proto.STRING, number=1,)
page_token = proto.Field(proto.STRING, number=2,)
page_size = proto.Field(proto.INT32, number=7,)
class ListSourcesResponse(proto.Message):
r"""Response message for listing sources.
Attributes:
sources (Sequence[google.cloud.securitycenter_v1.types.Source]):
Sources belonging to the requested parent.
next_page_token (str):
Token to retrieve the next page of results,
or empty if there are no more results.
"""
@property
def raw_page(self):
return self
sources = proto.RepeatedField(proto.MESSAGE, number=1, message=gcs_source.Source,)
next_page_token = proto.Field(proto.STRING, number=2,)
class ListAssetsRequest(proto.Message):
r"""Request message for listing assets.
Attributes:
parent (str):
Required. Name of the organization assets should belong to.
Its format is "organizations/[organization_id],
folders/[folder_id], or projects/[project_id]".
filter (str):
Expression that defines the filter to apply across assets.
The expression is a list of zero or more restrictions
combined via logical operators ``AND`` and ``OR``.
Parentheses are supported, and ``OR`` has higher precedence
than ``AND``.
Restrictions have the form ``<field> <operator> <value>``
and may have a ``-`` character in front of them to indicate
negation. The fields map to those defined in the Asset
resource. Examples include:
- name
- security_center_properties.resource_name
- resource_properties.a_property
- security_marks.marks.marka
The supported operators are:
- ``=`` for all value types.
- ``>``, ``<``, ``>=``, ``<=`` for integer values.
- ``:``, meaning substring matching, for strings.
The supported value types are:
- string literals in quotes.
- integer literals without quotes.
- boolean literals ``true`` and ``false`` without quotes.
The following are the allowed field and operator
combinations:
- name: ``=``
- update_time: ``=``, ``>``, ``<``, ``>=``, ``<=``
Usage: This should be milliseconds since epoch or an
RFC3339 string. Examples:
``update_time = "2019-06-10T16:07:18-07:00"``
``update_time = 1560208038000``
- create_time: ``=``, ``>``, ``<``, ``>=``, ``<=``
Usage: This should be milliseconds since epoch or an
RFC3339 string. Examples:
``create_time = "2019-06-10T16:07:18-07:00"``
``create_time = 1560208038000``
- iam_policy.policy_blob: ``=``, ``:``
- resource_properties: ``=``, ``:``, ``>``, ``<``, ``>=``,
``<=``
- security_marks.marks: ``=``, ``:``
- security_center_properties.resource_name: ``=``, ``:``
- security_center_properties.resource_display_name: ``=``,
``:``
- security_center_properties.resource_type: ``=``, ``:``
- security_center_properties.resource_parent: ``=``, ``:``
- security_center_properties.resource_parent_display_name:
``=``, ``:``
- security_center_properties.resource_project: ``=``, ``:``
- security_center_properties.resource_project_display_name:
``=``, ``:``
- security_center_properties.resource_owners: ``=``, ``:``
For example, ``resource_properties.size = 100`` is a valid
filter string.
Use a partial match on the empty string to filter based on a
property existing: ``resource_properties.my_property : ""``
Use a negated partial match on the empty string to filter
based on a property not existing:
``-resource_properties.my_property : ""``
order_by (str):
Expression that defines what fields and order to use for
sorting. The string value should follow SQL syntax: comma
separated list of fields. For example:
"name,resource_properties.a_property". The default sorting
order is ascending. To specify descending order for a field,
a suffix " desc" should be appended to the field name. For
example: "name desc,resource_properties.a_property".
Redundant space characters in the syntax are insignificant.
"name desc,resource_properties.a_property" and " name desc ,
resource_properties.a_property " are equivalent.
The following fields are supported: name update_time
resource_properties security_marks.marks
security_center_properties.resource_name
security_center_properties.resource_display_name
security_center_properties.resource_parent
security_center_properties.resource_parent_display_name
security_center_properties.resource_project
security_center_properties.resource_project_display_name
security_center_properties.resource_type
read_time (google.protobuf.timestamp_pb2.Timestamp):
Time used as a reference point when filtering
assets. The filter is limited to assets existing
at the supplied time and their values are those
at that specific time. Absence of this field
will default to the API's version of NOW.
compare_duration (google.protobuf.duration_pb2.Duration):
When compare_duration is set, the ListAssetsResult's
"state_change" attribute is updated to indicate whether the
asset was added, removed, or remained present during the
compare_duration period of time that precedes the read_time.
This is the time between (read_time - compare_duration) and
read_time.
The state_change value is derived based on the presence of
the asset at the two points in time. Intermediate state
changes between the two times don't affect the result. For
example, the results aren't affected if the asset is removed
and re-created again.
Possible "state_change" values when compare_duration is
specified:
- "ADDED": indicates that the asset was not present at the
start of compare_duration, but present at read_time.
- "REMOVED": indicates that the asset was present at the
start of compare_duration, but not present at read_time.
- "ACTIVE": indicates that the asset was present at both
the start and the end of the time period defined by
compare_duration and read_time.
If compare_duration is not specified, then the only possible
state_change is "UNUSED", which will be the state_change set
for all assets present at read_time.
field_mask (google.protobuf.field_mask_pb2.FieldMask):
A field mask to specify the ListAssetsResult
fields to be listed in the response.
An empty field mask will list all fields.
page_token (str):
The value returned by the last ``ListAssetsResponse``;
indicates that this is a continuation of a prior
``ListAssets`` call, and that the system should return the
next page of data.
page_size (int):
The maximum number of results to return in a
single response. Default is 10, minimum is 1,
maximum is 1000.
"""
parent = proto.Field(proto.STRING, number=1,)
filter = proto.Field(proto.STRING, number=2,)
order_by = proto.Field(proto.STRING, number=3,)
read_time = proto.Field(proto.MESSAGE, number=4, message=timestamp_pb2.Timestamp,)
compare_duration = proto.Field(
proto.MESSAGE, number=5, message=duration_pb2.Duration,
)
field_mask = proto.Field(proto.MESSAGE, number=7, message=field_mask_pb2.FieldMask,)
page_token = proto.Field(proto.STRING, number=8,)
page_size = proto.Field(proto.INT32, number=9,)
class ListAssetsResponse(proto.Message):
r"""Response message for listing assets.
Attributes:
list_assets_results (Sequence[google.cloud.securitycenter_v1.types.ListAssetsResponse.ListAssetsResult]):
Assets matching the list request.
read_time (google.protobuf.timestamp_pb2.Timestamp):
Time used for executing the list request.
next_page_token (str):
Token to retrieve the next page of results,
or empty if there are no more results.
total_size (int):
The total number of assets matching the
query.
"""
class ListAssetsResult(proto.Message):
r"""Result containing the Asset and its State.
Attributes:
asset (google.cloud.securitycenter_v1.types.Asset):
Asset matching the search request.
state_change (google.cloud.securitycenter_v1.types.ListAssetsResponse.ListAssetsResult.StateChange):
State change of the asset between the points
in time.
"""
class StateChange(proto.Enum):
r"""The change in state of the asset.
When querying across two points in time this describes the change
between the two points: ADDED, REMOVED, or ACTIVE. If there was no
compare_duration supplied in the request the state change will be:
UNUSED
"""
UNUSED = 0
ADDED = 1
REMOVED = 2
ACTIVE = 3
asset = proto.Field(proto.MESSAGE, number=1, message=gcs_asset.Asset,)
state_change = proto.Field(
proto.ENUM,
number=2,
enum="ListAssetsResponse.ListAssetsResult.StateChange",
)
@property
def raw_page(self):
return self
list_assets_results = proto.RepeatedField(
proto.MESSAGE, number=1, message=ListAssetsResult,
)
read_time = proto.Field(proto.MESSAGE, number=2, message=timestamp_pb2.Timestamp,)
next_page_token = proto.Field(proto.STRING, number=3,)
total_size = proto.Field(proto.INT32, number=4,)
class ListFindingsRequest(proto.Message):
r"""Request message for listing findings.
Attributes:
parent (str):
Required. Name of the source the findings belong to. Its
format is
"organizations/[organization_id]/sources/[source_id],
folders/[folder_id]/sources/[source_id], or
projects/[project_id]/sources/[source_id]". To list across
all sources provide a source_id of ``-``. For example:
organizations/{organization_id}/sources/-,
folders/{folder_id}/sources/- or
projects/{projects_id}/sources/-
filter (str):
Expression that defines the filter to apply across findings.
The expression is a list of one or more restrictions
combined via logical operators ``AND`` and ``OR``.
Parentheses are supported, and ``OR`` has higher precedence
than ``AND``.
Restrictions have the form ``<field> <operator> <value>``
and may have a ``-`` character in front of them to indicate
negation. Examples include:
- name
- source_properties.a_property
- security_marks.marks.marka
The supported operators are:
- ``=`` for all value types.
- ``>``, ``<``, ``>=``, ``<=`` for integer values.
- ``:``, meaning substring matching, for strings.
The supported value types are:
- string literals in quotes.
- integer literals without quotes.
- boolean literals ``true`` and ``false`` without quotes.
The following field and operator combinations are supported:
- name: ``=``
- parent: ``=``, ``:``
- resource_name: ``=``, ``:``
- state: ``=``, ``:``
- category: ``=``, ``:``
- external_uri: ``=``, ``:``
- event_time: ``=``, ``>``, ``<``, ``>=``, ``<=``
Usage: This should be milliseconds since epoch or an
RFC3339 string. Examples:
``event_time = "2019-06-10T16:07:18-07:00"``
``event_time = 1560208038000``
- severity: ``=``, ``:``
- workflow_state: ``=``, ``:``