Skip to content

Commit 44424cc

Browse files
Anthonydandhlee
Anthony
authored andcommitted
docs: standardize new tag with existing tags from other languages (#104)
Updates the tags to be identical to the tag most-used in other language-repos. This is the final step in wrangling all the cats into logical groupings of identical tags. Cleans up and finalizes work started in PR #85.
1 parent b00f4b5 commit 44424cc

File tree

4 files changed

+36
-36
lines changed

4 files changed

+36
-36
lines changed

securitycenter/snippets/snippets_findings.py

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,7 @@ def update_source(source_name):
9797
def add_user_to_source(source_name):
9898
"""Gives a user findingsEditor permission to the source."""
9999
user_email = "[email protected]"
100-
# [START securitycenter_update_source_iam]
100+
# [START securitycenter_set_source_iam]
101101
# [START update_source_iam]
102102
from google.cloud import securitycenter
103103
from google.iam.v1 import policy_pb2
@@ -132,7 +132,7 @@ def add_user_to_source(source_name):
132132
print("Updated Policy: {}".format(updated))
133133

134134
# [END update_source_iam]
135-
# [END securitycenter_update_source_iam]
135+
# [END securitycenter_set_source_iam]
136136
return binding, updated
137137

138138

@@ -210,7 +210,7 @@ def create_finding(source_name):
210210

211211
def create_finding_with_source_properties(source_name):
212212
"""Demonstrate creating a new finding with source properties. """
213-
# [START securitycenter_create_finding_with_properties]
213+
# [START securitycenter_create_finding_with_source_properties]
214214
# [START create_finding_with_properties]
215215
import datetime
216216

@@ -262,11 +262,11 @@ def create_finding_with_source_properties(source_name):
262262
)
263263
print(created_finding)
264264
# [END create_finding_with_properties]
265-
# [END securitycenter_create_finding_with_properties]
265+
# [END securitycenter_create_finding_with_source_properties]
266266

267267

268268
def update_finding(source_name):
269-
# [START securitycenter_update_finding]
269+
# [START securitycenter_update_finding_source_properties]
270270
# [START update_finding]
271271
import datetime
272272

@@ -310,7 +310,7 @@ def update_finding(source_name):
310310
)
311311
)
312312
# [END update_finding]
313-
# [END securitycenter_update_finding]
313+
# [END securitycenter_update_finding_source_properties]
314314

315315

316316
def update_finding_state(source_name):
@@ -347,7 +347,7 @@ def update_finding_state(source_name):
347347
def trouble_shoot(source_name):
348348
"""Demonstrate calling test_iam_permissions to determine if the
349349
service account has the correct permisions."""
350-
# [START securitycenter_test_iam_permissions]
350+
# [START securitycenter_test_iam]
351351
# [START test_iam_permissions]
352352
from google.cloud import securitycenter
353353

@@ -374,9 +374,9 @@ def trouble_shoot(source_name):
374374
)
375375
)
376376
# [END test_iam_permissions]
377-
# [END securitycenter_test_iam_permissions]
377+
# [END securitycenter_test_iam]
378378
assert len(permission_response.permissions) > 0
379-
# [START securitycenter_test_iam_permissions]
379+
# [START securitycenter_test_iam]
380380
# [START test_iam_permissions]
381381
# Check for permissions necessary to call set_finding_state.
382382
permission_response = client.test_iam_permissions(
@@ -389,7 +389,7 @@ def trouble_shoot(source_name):
389389
"Permision to update state? {}".format(len(permission_response.permissions) > 0)
390390
)
391391
# [END test_iam_permissions]
392-
# [END securitycenter_test_iam_permissions]
392+
# [END securitycenter_test_iam]
393393
return permission_response
394394
assert len(permission_response.permissions) > 0
395395

@@ -453,7 +453,7 @@ def list_filtered_findings(source_name):
453453

454454

455455
def list_findings_at_time(source_name):
456-
# [START securitycenter_list_findings_at_a_time]
456+
# [START securitycenter_list_findings_at_time]
457457
# [START list_findings_at_a_time]
458458
from google.cloud import securitycenter
459459
from datetime import timedelta, datetime
@@ -471,9 +471,9 @@ def list_findings_at_time(source_name):
471471
# source_name = "organizations/111122222444/sources/-"
472472
five_days_ago = str(datetime.now() - timedelta(days=5))
473473
# [END list_findings_at_a_time]
474-
# [END securitycenter_list_findings_at_a_time]
474+
# [END securitycenter_list_findings_at_time]
475475
i = -1
476-
# [START securitycenter_list_findings_at_a_time]
476+
# [START securitycenter_list_findings_at_time]
477477
# [START list_findings_at_a_time]
478478

479479
finding_result_iterator = client.list_findings(
@@ -486,7 +486,7 @@ def list_findings_at_time(source_name):
486486
)
487487
)
488488
# [END list_findings_at_a_time]
489-
# [END securitycenter_list_findings_at_a_time]
489+
# [END securitycenter_list_findings_at_time]
490490
return i
491491

492492

securitycenter/snippets/snippets_list_assets.py

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@
2020
def list_all_assets(organization_id):
2121
"""Demonstrate listing and printing all assets."""
2222
i = 0
23-
# [START securitycenter_demo_list_all_assets]
23+
# [START securitycenter_list_all_assets]
2424
# [START demo_list_all_assets]
2525
from google.cloud import securitycenter
2626

@@ -34,14 +34,14 @@ def list_all_assets(organization_id):
3434
for i, asset_result in enumerate(asset_iterator):
3535
print(i, asset_result)
3636
# [END demo_list_all_assets]
37-
# [END securitycenter_demo_list_all_assets]
37+
# [END securitycenter_list_all_assets]
3838
return i
3939

4040

4141
def list_assets_with_filters(organization_id):
4242
"""Demonstrate listing assets with a filter."""
4343
i = 0
44-
# [START securitycenter_demo_list_assets_with_filter]
44+
# [START securitycenter_list_assets_with_filter]
4545
# [START demo_list_assets_with_filter]
4646
from google.cloud import securitycenter
4747

@@ -62,14 +62,14 @@ def list_assets_with_filters(organization_id):
6262
for i, asset_result in enumerate(asset_iterator):
6363
print(i, asset_result)
6464
# [END demo_list_assets_with_filter]
65-
# [END securitycenter_demo_list_assets_with_filter]
65+
# [END securitycenter_list_assets_with_filter]
6666
return i
6767

6868

6969
def list_assets_with_filters_and_read_time(organization_id):
7070
"""Demonstrate listing assets with a filter."""
7171
i = 0
72-
# [START securitycenter_demo_list_assets_with_filter_and_time]
72+
# [START securitycenter_list_assets_at_time]
7373
# [START demo_list_assets_with_filter_and_time]
7474
from datetime import datetime, timedelta
7575

@@ -100,14 +100,14 @@ def list_assets_with_filters_and_read_time(organization_id):
100100
for i, asset_result in enumerate(asset_iterator):
101101
print(i, asset_result)
102102
# [END demo_list_assets_with_filter_and_time]
103-
# [END securitycenter_demo_list_assets_with_filter_and_time]
103+
# [END securitycenter_list_assets_at_time]
104104
return i
105105

106106

107107
def list_point_in_time_changes(organization_id):
108108
"""Demonstrate listing assets along with their state changes."""
109109
i = 0
110-
# [START securitycenter_demo_list_assets_changes]
110+
# [START securitycenter_list_assets_and_changes]
111111
# [START demo_list_assets_changes]
112112
from datetime import timedelta
113113

@@ -138,7 +138,7 @@ def list_point_in_time_changes(organization_id):
138138
print(i, asset)
139139

140140
# [END demo_list_assets_changes]
141-
# [END securitycenter_demo_list_assets_changes]
141+
# [END securitycenter_list_assets_and_changes]
142142
return i
143143

144144

securitycenter/snippets/snippets_orgs.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ def get_settings(organization_id):
3737
def update_asset_discovery_org_settings(organization_id):
3838
"""Example showing how to update the asset discovery configuration
3939
for an organization."""
40-
# [START securitycenter_update_org_settings]
40+
# [START securitycenter_enable_asset_discovery]
4141
# [START update_org_settings]
4242
from google.cloud import securitycenter
4343
from google.protobuf import field_mask_pb2
@@ -63,5 +63,5 @@ def update_asset_discovery_org_settings(organization_id):
6363
)
6464
print("Asset Discovery Enabled? {}".format(updated.enable_asset_discovery))
6565
# [END update_org_settings]
66-
# [END securitycenter_update_org_settings]
66+
# [END securitycenter_enable_asset_discovery]
6767
return updated

securitycenter/snippets/snippets_security_marks.py

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818

1919
def add_to_asset(asset_name):
2020
"""Add new security marks to an asset."""
21-
# [START securitycenter_add_marks_to_asset]
21+
# [START securitycenter_add_security_marks]
2222
# [START add_marks_to_asset]
2323
from google.cloud import securitycenter
2424
from google.protobuf import field_mask_pb2
@@ -45,15 +45,15 @@ def add_to_asset(asset_name):
4545
)
4646
print(updated_marks)
4747
# [END add_marks_to_asset]
48-
# [END securitycenter_add_marks_to_asset]
48+
# [END securitycenter_add_security_marks]
4949
return updated_marks, marks
5050

5151

5252
def clear_from_asset(asset_name):
5353
"""Removes security marks from an asset."""
5454
# Make sure they are there first
5555
add_to_asset(asset_name)
56-
# [START securitycenter_clear_marks_asset]
56+
# [START securitycenter_delete_security_marks]
5757
# [START clear_marks_asset]
5858
from google.cloud import securitycenter
5959
from google.protobuf import field_mask_pb2
@@ -81,15 +81,15 @@ def clear_from_asset(asset_name):
8181
)
8282
print(updated_marks)
8383
# [END clear_marks_asset]
84-
# [END securitycenter_clear_marks_asset]
84+
# [END securitycenter_delete_security_marks]
8585
return updated_marks
8686

8787

8888
def delete_and_update_marks(asset_name):
8989
"""Updates and deletes security marks from an asset in the same call."""
9090
# Make sure they are there first
9191
add_to_asset(asset_name)
92-
# [START securitycenter_delete_and_update_marks]
92+
# [START securitycenter_add_delete_security_marks]
9393
# [START delete_and_update_marks]
9494
from google.cloud import securitycenter
9595
from google.protobuf import field_mask_pb2
@@ -112,13 +112,13 @@ def delete_and_update_marks(asset_name):
112112
)
113113
print(updated_marks)
114114
# [END delete_and_update_marks]
115-
# [END securitycenter_delete_and_update_marks]
115+
# [END securitycenter_add_delete_security_marks]
116116
return updated_marks
117117

118118

119119
def add_to_finding(finding_name):
120120
"""Adds security marks to a finding. """
121-
# [START securitycenter_add_marks_to_finding]
121+
# [START securitycenter_add_security_marks]
122122
# [START add_marks_to_finding]
123123
from google.cloud import securitycenter
124124
from google.protobuf import field_mask_pb2
@@ -145,15 +145,15 @@ def add_to_finding(finding_name):
145145
}
146146
)
147147
# [END add_marks_to_finding]
148-
# [END securitycenter_add_marks_to_finding]
148+
# [END securitycenter_add_security_marks]
149149
return updated_marks, marks
150150

151151

152152
def list_assets_with_query_marks(organization_id, asset_name):
153153
"""Lists assets with a filter on security marks. """
154154
add_to_asset(asset_name)
155155
i = -1
156-
# [START securitycenter_demo_list_assets_with_security_marks]
156+
# [START securitycenter_list_assets_with_security_marks]
157157
# [START demo_list_assets_with_security_marks]
158158
from google.cloud import securitycenter
159159

@@ -176,7 +176,7 @@ def list_assets_with_query_marks(organization_id, asset_name):
176176
for i, asset_result in enumerate(asset_iterator):
177177
print(i, asset_result)
178178
# [END demo_list_assets_with_security_marks]
179-
# [END securitycenter_demo_list_assets_with_security_marks]
179+
# [END securitycenter_list_assets_with_security_marks]
180180
return i
181181

182182

@@ -185,7 +185,7 @@ def list_findings_with_query_marks(source_name, finding_name):
185185
# ensure marks are set on finding.
186186
add_to_finding(finding_name)
187187
i = -1
188-
# [START securitycenter_demo_list_findings_with_security_marks]
188+
# [START securitycenter_list_findings_with_security_marks]
189189
# [START demo_list_findings_with_security_marks]
190190
from google.cloud import securitycenter
191191

@@ -206,7 +206,7 @@ def list_findings_with_query_marks(source_name, finding_name):
206206
for i, finding_result in enumerate(finding_iterator):
207207
print(i, finding_result)
208208
# [END demo_list_findings_with_security_marks]
209-
# [END securitycenter_demo_list_findings_with_security_marks]
209+
# [END securitycenter_list_findings_with_security_marks]
210210
# one finding should have been updated with keys, and one should be
211211
# untouched.
212212
return i

0 commit comments

Comments
 (0)