docs: remove unused region tags (#108)

* add securitycenter prefix to samples, wrap published samples and replace unpublished entirely.

* Fix unmatched region tags

* Fix more unmatched region tags

* fix lint issue with function antipattern

* docs: standardize new tags with most-used tag from other languages

* fix conflicting tag by making more explicit to the contained function

* remove obviated region tags

* more

Co-authored-by: gcf-merge-on-green[bot] <60162190+gcf-merge-on-green[bot]@users.noreply.github.com>

Author: 2 people

securitycenter/snippets/snippets_findings.py

@@ -20,7 +20,6 @@
 def create_source(organization_id):
     """Create a new findings source. """
     # [START securitycenter_create_source]
-    # [START create_source]
     from google.cloud import securitycenter
 
     client = securitycenter.SecurityCenterClient()
@@ -38,14 +37,12 @@ def create_source(organization_id):
         }
     )
     print("Created Source: {}".format(created.name))
-    # [END create_source]
     # [END securitycenter_create_source]
 
 
 def get_source(source_name):
     """Gets an existing source."""
     # [START securitycenter_get_source]
-    # [START get_source]
     from google.cloud import securitycenter
 
     client = securitycenter.SecurityCenterClient()
@@ -59,15 +56,13 @@ def get_source(source_name):
     source = client.get_source(request={"name": source_name})
 
     print("Source: {}".format(source))
-    # [END get_source]
     # [END securitycenter_get_source]
     return source
 
 
 def update_source(source_name):
     """Updates a source's display name."""
     # [START securitycenter_update_source]
-    # [START update_source]
     from google.cloud import securitycenter
     from google.protobuf import field_mask_pb2
 
@@ -89,7 +84,6 @@ def update_source(source_name):
         }
     )
     print("Updated Source: {}".format(updated))
-    # [END update_source]
     # [END securitycenter_update_source]
     return updated
 
@@ -98,7 +92,6 @@ def add_user_to_source(source_name):
     """Gives a user findingsEditor permission to the source."""
     user_email = "csccclienttest@gmail.com"
     # [START securitycenter_set_source_iam]
-    # [START update_source_iam]
     from google.cloud import securitycenter
     from google.iam.v1 import policy_pb2
 
@@ -131,7 +124,6 @@ def add_user_to_source(source_name):
 
     print("Updated Policy: {}".format(updated))
 
-    # [END update_source_iam]
     # [END securitycenter_set_source_iam]
     return binding, updated
 
@@ -140,7 +132,6 @@ def list_source(organization_id):
     """Lists finding sources."""
     i = -1
     # [START securitycenter_list_sources]
-    # [START list_sources]
     from google.cloud import securitycenter
 
     # Create a new client.
@@ -152,15 +143,13 @@ def list_source(organization_id):
     # Call the API and print out each existing source.
     for i, source in enumerate(client.list_sources(request={"parent": org_name})):
         print(i, source)
-    # [END list_sources]
     # [END securitycenter_list_sources]
     return i
 
 
 def create_finding(source_name):
     """Creates a new finding."""
     # [START securitycenter_create_finding]
-    # [START create_finding]
     from google.cloud import securitycenter
     from google.cloud.securitycenter_v1 import CreateFindingRequest, Finding
     import datetime
@@ -203,15 +192,13 @@ def create_finding(source_name):
         request=request
     )
     print(created_finding)
-    # [END create_finding]
     # [END securitycenter_create_finding]
     return created_finding
 
 
 def create_finding_with_source_properties(source_name):
     """Demonstrate creating a new finding with source properties. """
     # [START securitycenter_create_finding_with_source_properties]
-    # [START create_finding_with_properties]
     import datetime
 
     from google.cloud import securitycenter
@@ -261,13 +248,11 @@ def create_finding_with_source_properties(source_name):
         }
     )
     print(created_finding)
-    # [END create_finding_with_properties]
     # [END securitycenter_create_finding_with_source_properties]
 
 
 def update_finding(source_name):
     # [START securitycenter_update_finding_source_properties]
-    # [START update_finding]
     import datetime
 
     from google.cloud import securitycenter
@@ -309,14 +294,12 @@ def update_finding(source_name):
             updated_finding.source_properties, updated_finding.event_time
         )
     )
-    # [END update_finding]
     # [END securitycenter_update_finding_source_properties]
 
 
 def update_finding_state(source_name):
     """Demonstrate updating only a finding state."""
     # [START securitycenter_update_finding_state]
-    # [START update_finding_state]
     import datetime
 
     from google.cloud import securitycenter
@@ -340,15 +323,13 @@ def update_finding_state(source_name):
         }
     )
     print(f"New state: {new_finding.state}")
-    # [END update_finding_state]
     # [END securitycenter_update_finding_state]
 
 
 def trouble_shoot(source_name):
     """Demonstrate calling test_iam_permissions to determine if the
     service account has the correct permisions."""
     # [START securitycenter_test_iam]
-    # [START test_iam_permissions]
     from google.cloud import securitycenter
 
     # Create a client.
@@ -373,11 +354,9 @@ def trouble_shoot(source_name):
             len(permission_response.permissions) > 0
         )
     )
-    # [END test_iam_permissions]
     # [END securitycenter_test_iam]
     assert len(permission_response.permissions) > 0
     # [START securitycenter_test_iam]
-    # [START test_iam_permissions]
     # Check for permissions necessary to call set_finding_state.
     permission_response = client.test_iam_permissions(
         request={
@@ -388,15 +367,13 @@ def trouble_shoot(source_name):
     print(
         "Permision to update state? {}".format(len(permission_response.permissions) > 0)
     )
-    # [END test_iam_permissions]
     # [END securitycenter_test_iam]
     return permission_response
     assert len(permission_response.permissions) > 0
 
 
 def list_all_findings(organization_id):
     # [START securitycenter_list_all_findings]
-    # [START list_all_findings]
     from google.cloud import securitycenter
 
     # Create a client.
@@ -415,14 +392,12 @@ def list_all_findings(organization_id):
                 i, finding_result.finding.name, finding_result.finding.resource_name
             )
         )
-    # [END list_all_findings]
     # [END securitycenter_list_all_findings]
     return i
 
 
 def list_filtered_findings(source_name):
     # [START securitycenter_list_filtered_findings]
-    # [START list_filtered_findings]
     from google.cloud import securitycenter
 
     # Create a new client.
@@ -447,14 +422,12 @@ def list_filtered_findings(source_name):
                 i, finding_result.finding.name, finding_result.finding.resource_name
             )
         )
-    # [END list_filtered_findings]
     # [END securitycenter_list_filtered_findings]
     return i
 
 
 def list_findings_at_time(source_name):
     # [START securitycenter_list_findings_at_time]
-    # [START list_findings_at_a_time]
     from google.cloud import securitycenter
     from datetime import timedelta, datetime
 
@@ -470,11 +443,9 @@ def list_findings_at_time(source_name):
     # You an also use a wild-card "-" for all sources:
     #   source_name = "organizations/111122222444/sources/-"
     five_days_ago = str(datetime.now() - timedelta(days=5))
-    # [END list_findings_at_a_time]
     # [END securitycenter_list_findings_at_time]
     i = -1
     # [START securitycenter_list_findings_at_time]
-    # [START list_findings_at_a_time]
 
     finding_result_iterator = client.list_findings(
         request={"parent": source_name, "filter": five_days_ago}
@@ -485,15 +456,13 @@ def list_findings_at_time(source_name):
                 i, finding_result.finding.name, finding_result.finding.resource_name
             )
         )
-    # [END list_findings_at_a_time]
     # [END securitycenter_list_findings_at_time]
     return i
 
 
 def get_iam_policy(source_name):
     """Gives a user findingsEditor permission to the source."""
     # [START securitycenter_get_source_iam]
-    # [START get_source_iam]
     from google.cloud import securitycenter
 
     client = securitycenter.SecurityCenterClient()
@@ -507,15 +476,13 @@ def get_iam_policy(source_name):
     # Get the old policy so we can do an incremental update.
     policy = client.get_iam_policy(request={"resource": source_name})
     print("Policy: {}".format(policy))
-    # [END get_source_iam]
     # [END securitycenter_get_source_iam]
 
 
 def group_all_findings(organization_id):
     """Demonstrates grouping all findings across an organization."""
     i = 0
     # [START securitycenter_group_all_findings]
-    # [START group_all_findings]
     from google.cloud import securitycenter
 
     # Create a client.
@@ -532,7 +499,6 @@ def group_all_findings(organization_id):
     )
     for i, group_result in enumerate(group_result_iterator):
         print((i + 1), group_result)
-    # [END group_all_findings]
     # [END securitycenter_group_all_findings]
     return i
 

securitycenter/snippets/snippets_list_assets.py

@@ -21,7 +21,6 @@ def list_all_assets(organization_id):
     """Demonstrate listing and printing all assets."""
     i = 0
     # [START securitycenter_list_all_assets]
-    # [START demo_list_all_assets]
     from google.cloud import securitycenter
 
     client = securitycenter.SecurityCenterClient()
@@ -33,7 +32,6 @@ def list_all_assets(organization_id):
     asset_iterator = client.list_assets(request={"parent": org_name})
     for i, asset_result in enumerate(asset_iterator):
         print(i, asset_result)
-    # [END demo_list_all_assets]
     # [END securitycenter_list_all_assets]
     return i
 
@@ -42,7 +40,6 @@ def list_assets_with_filters(organization_id):
     """Demonstrate listing assets with a filter."""
     i = 0
     # [START securitycenter_list_assets_with_filter]
-    # [START demo_list_assets_with_filter]
     from google.cloud import securitycenter
 
     client = securitycenter.SecurityCenterClient()
@@ -61,7 +58,6 @@ def list_assets_with_filters(organization_id):
     )
     for i, asset_result in enumerate(asset_iterator):
         print(i, asset_result)
-    # [END demo_list_assets_with_filter]
     # [END securitycenter_list_assets_with_filter]
     return i
 
@@ -70,7 +66,6 @@ def list_assets_with_filters_and_read_time(organization_id):
     """Demonstrate listing assets with a filter."""
     i = 0
     # [START securitycenter_list_assets_at_time]
-    # [START demo_list_assets_with_filter_and_time]
     from datetime import datetime, timedelta
 
     from google.cloud import securitycenter
@@ -99,7 +94,6 @@ def list_assets_with_filters_and_read_time(organization_id):
     )
     for i, asset_result in enumerate(asset_iterator):
         print(i, asset_result)
-    # [END demo_list_assets_with_filter_and_time]
     # [END securitycenter_list_assets_at_time]
     return i
 
@@ -108,7 +102,6 @@ def list_point_in_time_changes(organization_id):
     """Demonstrate listing assets along with their state changes."""
     i = 0
     # [START securitycenter_list_assets_and_changes]
-    # [START demo_list_assets_changes]
     from datetime import timedelta
 
     from google.cloud import securitycenter
@@ -137,7 +130,6 @@ def list_point_in_time_changes(organization_id):
     for i, asset in enumerate(asset_iterator):
         print(i, asset)
 
-    # [END demo_list_assets_changes]
     # [END securitycenter_list_assets_and_changes]
     return i
 

securitycenter/snippets/snippets_notification_configs.py

@@ -19,7 +19,6 @@
 def create_notification_config(organization_id, notification_config_id, pubsub_topic):
 
     # [START securitycenter_create_notification_config]
-    # [START scc_create_notification_config]
     from google.cloud import securitycenter as securitycenter
 
     client = securitycenter.SecurityCenterClient()
@@ -44,15 +43,13 @@ def create_notification_config(organization_id, notification_config_id, pubsub_t
     )
 
     print(created_notification_config)
-    # [END scc_create_notification_config]
     # [END securitycenter_create_notification_config]
     return created_notification_config
 
 
 def delete_notification_config(organization_id, notification_config_id):
 
     # [START securitycenter_delete_notification_config]
-    # [START scc_delete_notification_config]
     from google.cloud import securitycenter as securitycenter
 
     client = securitycenter.SecurityCenterClient()
@@ -66,15 +63,13 @@ def delete_notification_config(organization_id, notification_config_id):
 
     client.delete_notification_config(request={"name": notification_config_name})
     print("Deleted notification config: {}".format(notification_config_name))
-    # [END scc_delete_notification_config]
     # [END securitycenter_delete_notification_config]
     return True
 
 
 def get_notification_config(organization_id, notification_config_id):
 
     # [START securitycenter_get_notification_config]
-    # [START scc_get_notification_config]
     from google.cloud import securitycenter as securitycenter
 
     client = securitycenter.SecurityCenterClient()
@@ -90,15 +85,13 @@ def get_notification_config(organization_id, notification_config_id):
         request={"name": notification_config_name}
     )
     print("Got notification config: {}".format(notification_config))
-    # [END scc_get_notification_config]
     # [END securitycenter_get_notification_config]
     return notification_config
 
 
 def list_notification_configs(organization_id):
 
     # [START securitycenter_list_notification_configs]
-    # [START scc_list_notification_configs]
     from google.cloud import securitycenter as securitycenter
 
     client = securitycenter.SecurityCenterClient()
@@ -111,14 +104,12 @@ def list_notification_configs(organization_id):
     )
     for i, config in enumerate(notification_configs_iterator):
         print("{}: notification_config: {}".format(i, config))
-    # [END scc_list_notification_configs]
     # [END securitycenter_list_notification_configs]]
     return notification_configs_iterator
 
 
 def update_notification_config(organization_id, notification_config_id, pubsub_topic):
     # [START securitycenter_update_notification_config]
-    # [START scc_update_notification_config]
     from google.cloud import securitycenter as securitycenter
     from google.protobuf import field_mask_pb2
 
@@ -155,6 +146,5 @@ def update_notification_config(organization_id, notification_config_id, pubsub_t
     )
 
     print(updated_notification_config)
-    # [END scc_update_notification_config]
     # [END securitycenter_update_notification_config]
     return updated_notification_config