Skip to content
This repository has been archived by the owner on Sep 5, 2023. It is now read-only.

docs: standardize new tag with existing tags from other languages #104

Merged
merged 6 commits into from Feb 18, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
28 changes: 14 additions & 14 deletions samples/snippets/snippets_findings.py
Expand Up @@ -97,7 +97,7 @@ def update_source(source_name):
def add_user_to_source(source_name):
"""Gives a user findingsEditor permission to the source."""
user_email = "csccclienttest@gmail.com"
# [START securitycenter_update_source_iam]
# [START securitycenter_set_source_iam]
# [START update_source_iam]
from google.cloud import securitycenter
from google.iam.v1 import policy_pb2
Expand Down Expand Up @@ -132,7 +132,7 @@ def add_user_to_source(source_name):
print("Updated Policy: {}".format(updated))

# [END update_source_iam]
# [END securitycenter_update_source_iam]
# [END securitycenter_set_source_iam]
return binding, updated


Expand Down Expand Up @@ -210,7 +210,7 @@ def create_finding(source_name):

def create_finding_with_source_properties(source_name):
"""Demonstrate creating a new finding with source properties. """
# [START securitycenter_create_finding_with_properties]
# [START securitycenter_create_finding_with_source_properties]
# [START create_finding_with_properties]
import datetime

Expand Down Expand Up @@ -262,11 +262,11 @@ def create_finding_with_source_properties(source_name):
)
print(created_finding)
# [END create_finding_with_properties]
# [END securitycenter_create_finding_with_properties]
# [END securitycenter_create_finding_with_source_properties]


def update_finding(source_name):
# [START securitycenter_update_finding]
# [START securitycenter_update_finding_source_properties]
# [START update_finding]
import datetime

Expand Down Expand Up @@ -310,7 +310,7 @@ def update_finding(source_name):
)
)
# [END update_finding]
# [END securitycenter_update_finding]
# [END securitycenter_update_finding_source_properties]


def update_finding_state(source_name):
Expand Down Expand Up @@ -347,7 +347,7 @@ def update_finding_state(source_name):
def trouble_shoot(source_name):
"""Demonstrate calling test_iam_permissions to determine if the
service account has the correct permisions."""
# [START securitycenter_test_iam_permissions]
# [START securitycenter_test_iam]
# [START test_iam_permissions]
from google.cloud import securitycenter

Expand All @@ -374,9 +374,9 @@ def trouble_shoot(source_name):
)
)
# [END test_iam_permissions]
# [END securitycenter_test_iam_permissions]
# [END securitycenter_test_iam]
assert len(permission_response.permissions) > 0
# [START securitycenter_test_iam_permissions]
# [START securitycenter_test_iam]
# [START test_iam_permissions]
# Check for permissions necessary to call set_finding_state.
permission_response = client.test_iam_permissions(
Expand All @@ -389,7 +389,7 @@ def trouble_shoot(source_name):
"Permision to update state? {}".format(len(permission_response.permissions) > 0)
)
# [END test_iam_permissions]
# [END securitycenter_test_iam_permissions]
# [END securitycenter_test_iam]
return permission_response
assert len(permission_response.permissions) > 0

Expand Down Expand Up @@ -453,7 +453,7 @@ def list_filtered_findings(source_name):


def list_findings_at_time(source_name):
# [START securitycenter_list_findings_at_a_time]
# [START securitycenter_list_findings_at_time]
# [START list_findings_at_a_time]
from google.cloud import securitycenter
from datetime import timedelta, datetime
Expand All @@ -471,9 +471,9 @@ def list_findings_at_time(source_name):
# 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_a_time]
# [END securitycenter_list_findings_at_time]
i = -1
# [START securitycenter_list_findings_at_a_time]
# [START securitycenter_list_findings_at_time]
# [START list_findings_at_a_time]

finding_result_iterator = client.list_findings(
Expand All @@ -486,7 +486,7 @@ def list_findings_at_time(source_name):
)
)
# [END list_findings_at_a_time]
# [END securitycenter_list_findings_at_a_time]
# [END securitycenter_list_findings_at_time]
return i


Expand Down
16 changes: 8 additions & 8 deletions samples/snippets/snippets_list_assets.py
Expand Up @@ -20,7 +20,7 @@
def list_all_assets(organization_id):
"""Demonstrate listing and printing all assets."""
i = 0
# [START securitycenter_demo_list_all_assets]
# [START securitycenter_list_all_assets]
# [START demo_list_all_assets]
from google.cloud import securitycenter

Expand All @@ -34,14 +34,14 @@ def list_all_assets(organization_id):
for i, asset_result in enumerate(asset_iterator):
print(i, asset_result)
# [END demo_list_all_assets]
# [END securitycenter_demo_list_all_assets]
# [END securitycenter_list_all_assets]
return i


def list_assets_with_filters(organization_id):
"""Demonstrate listing assets with a filter."""
i = 0
# [START securitycenter_demo_list_assets_with_filter]
# [START securitycenter_list_assets_with_filter]
# [START demo_list_assets_with_filter]
from google.cloud import securitycenter

Expand All @@ -62,14 +62,14 @@ 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_demo_list_assets_with_filter]
# [END securitycenter_list_assets_with_filter]
return i


def list_assets_with_filters_and_read_time(organization_id):
"""Demonstrate listing assets with a filter."""
i = 0
# [START securitycenter_demo_list_assets_with_filter_and_time]
# [START securitycenter_list_assets_at_time]
# [START demo_list_assets_with_filter_and_time]
from datetime import datetime, timedelta

Expand Down Expand Up @@ -100,14 +100,14 @@ 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_demo_list_assets_with_filter_and_time]
# [END securitycenter_list_assets_at_time]
return i


def list_point_in_time_changes(organization_id):
"""Demonstrate listing assets along with their state changes."""
i = 0
# [START securitycenter_demo_list_assets_changes]
# [START securitycenter_list_assets_and_changes]
# [START demo_list_assets_changes]
from datetime import timedelta

Expand Down Expand Up @@ -138,7 +138,7 @@ def list_point_in_time_changes(organization_id):
print(i, asset)

# [END demo_list_assets_changes]
# [END securitycenter_demo_list_assets_changes]
# [END securitycenter_list_assets_and_changes]
return i


Expand Down
4 changes: 2 additions & 2 deletions samples/snippets/snippets_orgs.py
Expand Up @@ -37,7 +37,7 @@ def get_settings(organization_id):
def update_asset_discovery_org_settings(organization_id):
"""Example showing how to update the asset discovery configuration
for an organization."""
# [START securitycenter_update_org_settings]
# [START securitycenter_enable_asset_discovery]
# [START update_org_settings]
from google.cloud import securitycenter
from google.protobuf import field_mask_pb2
Expand All @@ -63,5 +63,5 @@ def update_asset_discovery_org_settings(organization_id):
)
print("Asset Discovery Enabled? {}".format(updated.enable_asset_discovery))
# [END update_org_settings]
# [END securitycenter_update_org_settings]
# [END securitycenter_enable_asset_discovery]
return updated
24 changes: 12 additions & 12 deletions samples/snippets/snippets_security_marks.py
Expand Up @@ -18,7 +18,7 @@

def add_to_asset(asset_name):
"""Add new security marks to an asset."""
# [START securitycenter_add_marks_to_asset]
# [START securitycenter_add_security_marks]
# [START add_marks_to_asset]
from google.cloud import securitycenter
from google.protobuf import field_mask_pb2
Expand All @@ -45,15 +45,15 @@ def add_to_asset(asset_name):
)
print(updated_marks)
# [END add_marks_to_asset]
# [END securitycenter_add_marks_to_asset]
# [END securitycenter_add_security_marks]
return updated_marks, marks


def clear_from_asset(asset_name):
"""Removes security marks from an asset."""
# Make sure they are there first
add_to_asset(asset_name)
# [START securitycenter_clear_marks_asset]
# [START securitycenter_delete_security_marks]
# [START clear_marks_asset]
from google.cloud import securitycenter
from google.protobuf import field_mask_pb2
Expand Down Expand Up @@ -81,15 +81,15 @@ def clear_from_asset(asset_name):
)
print(updated_marks)
# [END clear_marks_asset]
# [END securitycenter_clear_marks_asset]
# [END securitycenter_delete_security_marks]
return updated_marks


def delete_and_update_marks(asset_name):
"""Updates and deletes security marks from an asset in the same call."""
# Make sure they are there first
add_to_asset(asset_name)
# [START securitycenter_delete_and_update_marks]
# [START securitycenter_add_delete_security_marks]
# [START delete_and_update_marks]
from google.cloud import securitycenter
from google.protobuf import field_mask_pb2
Expand All @@ -112,13 +112,13 @@ def delete_and_update_marks(asset_name):
)
print(updated_marks)
# [END delete_and_update_marks]
# [END securitycenter_delete_and_update_marks]
# [END securitycenter_add_delete_security_marks]
return updated_marks


def add_to_finding(finding_name):
"""Adds security marks to a finding. """
# [START securitycenter_add_marks_to_finding]
# [START securitycenter_add_security_marks]
# [START add_marks_to_finding]
from google.cloud import securitycenter
from google.protobuf import field_mask_pb2
Expand All @@ -145,15 +145,15 @@ def add_to_finding(finding_name):
}
)
# [END add_marks_to_finding]
# [END securitycenter_add_marks_to_finding]
# [END securitycenter_add_security_marks]
return updated_marks, marks


def list_assets_with_query_marks(organization_id, asset_name):
"""Lists assets with a filter on security marks. """
add_to_asset(asset_name)
i = -1
# [START securitycenter_demo_list_assets_with_security_marks]
# [START securitycenter_list_assets_with_security_marks]
# [START demo_list_assets_with_security_marks]
from google.cloud import securitycenter

Expand All @@ -176,7 +176,7 @@ def list_assets_with_query_marks(organization_id, asset_name):
for i, asset_result in enumerate(asset_iterator):
print(i, asset_result)
# [END demo_list_assets_with_security_marks]
# [END securitycenter_demo_list_assets_with_security_marks]
# [END securitycenter_list_assets_with_security_marks]
return i


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

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