docs: update documentation on severity (#72)

googleapis · Oct 9, 2020 · 4ba96b2 · 4ba96b2
1 parent 316d224
commit 4ba96b2
Show file tree

Hide file tree

Showing 4 changed files with 210 additions and 24 deletions.
diff --git a/google/cloud/securitycenter_v1beta1/services/security_center/async_client.py b/google/cloud/securitycenter_v1beta1/services/security_center/async_client.py
@@ -451,7 +451,7 @@ async def get_iam_policy(
                 maximum=60.0,
                 multiplier=1.3,
                 predicate=retries.if_exception_type(
-                    exceptions.ServiceUnavailable, exceptions.DeadlineExceeded,
+                    exceptions.DeadlineExceeded, exceptions.ServiceUnavailable,
                 ),
             ),
             default_timeout=60.0,
@@ -532,7 +532,7 @@ async def get_organization_settings(
                 maximum=60.0,
                 multiplier=1.3,
                 predicate=retries.if_exception_type(
-                    exceptions.ServiceUnavailable, exceptions.DeadlineExceeded,
+                    exceptions.DeadlineExceeded, exceptions.ServiceUnavailable,
                 ),
             ),
             default_timeout=60.0,
@@ -616,7 +616,7 @@ async def get_source(
                 maximum=60.0,
                 multiplier=1.3,
                 predicate=retries.if_exception_type(
-                    exceptions.ServiceUnavailable, exceptions.DeadlineExceeded,
+                    exceptions.DeadlineExceeded, exceptions.ServiceUnavailable,
                 ),
             ),
             default_timeout=60.0,
@@ -679,7 +679,7 @@ async def group_assets(
                 maximum=60.0,
                 multiplier=1.3,
                 predicate=retries.if_exception_type(
-                    exceptions.ServiceUnavailable, exceptions.DeadlineExceeded,
+                    exceptions.DeadlineExceeded, exceptions.ServiceUnavailable,
                 ),
             ),
             default_timeout=480.0,
@@ -794,7 +794,7 @@ async def group_findings(
                 maximum=60.0,
                 multiplier=1.3,
                 predicate=retries.if_exception_type(
-                    exceptions.ServiceUnavailable, exceptions.DeadlineExceeded,
+                    exceptions.DeadlineExceeded, exceptions.ServiceUnavailable,
                 ),
             ),
             default_timeout=480.0,
@@ -860,7 +860,7 @@ async def list_assets(
                 maximum=60.0,
                 multiplier=1.3,
                 predicate=retries.if_exception_type(
-                    exceptions.ServiceUnavailable, exceptions.DeadlineExceeded,
+                    exceptions.DeadlineExceeded, exceptions.ServiceUnavailable,
                 ),
             ),
             default_timeout=480.0,
@@ -932,7 +932,7 @@ async def list_findings(
                 maximum=60.0,
                 multiplier=1.3,
                 predicate=retries.if_exception_type(
-                    exceptions.ServiceUnavailable, exceptions.DeadlineExceeded,
+                    exceptions.DeadlineExceeded, exceptions.ServiceUnavailable,
                 ),
             ),
             default_timeout=480.0,
@@ -1019,7 +1019,7 @@ async def list_sources(
                 maximum=60.0,
                 multiplier=1.3,
                 predicate=retries.if_exception_type(
-                    exceptions.ServiceUnavailable, exceptions.DeadlineExceeded,
+                    exceptions.DeadlineExceeded, exceptions.ServiceUnavailable,
                 ),
             ),
             default_timeout=60.0,
@@ -1465,7 +1465,7 @@ async def test_iam_permissions(
                 maximum=60.0,
                 multiplier=1.3,
                 predicate=retries.if_exception_type(
-                    exceptions.ServiceUnavailable, exceptions.DeadlineExceeded,
+                    exceptions.DeadlineExceeded, exceptions.ServiceUnavailable,
                 ),
             ),
             default_timeout=60.0,

diff --git a/google/cloud/securitycenter_v1beta1/services/security_center/transports/base.py b/google/cloud/securitycenter_v1beta1/services/security_center/transports/base.py
@@ -135,7 +135,7 @@ def _prep_wrapped_messages(self, client_info):
                     maximum=60.0,
                     multiplier=1.3,
                     predicate=retries.if_exception_type(
-                        exceptions.ServiceUnavailable, exceptions.DeadlineExceeded,
+                        exceptions.DeadlineExceeded, exceptions.ServiceUnavailable,
                     ),
                 ),
                 default_timeout=60.0,
@@ -148,7 +148,7 @@ def _prep_wrapped_messages(self, client_info):
                     maximum=60.0,
                     multiplier=1.3,
                     predicate=retries.if_exception_type(
-                        exceptions.ServiceUnavailable, exceptions.DeadlineExceeded,
+                        exceptions.DeadlineExceeded, exceptions.ServiceUnavailable,
                     ),
                 ),
                 default_timeout=60.0,
@@ -161,7 +161,7 @@ def _prep_wrapped_messages(self, client_info):
                     maximum=60.0,
                     multiplier=1.3,
                     predicate=retries.if_exception_type(
-                        exceptions.ServiceUnavailable, exceptions.DeadlineExceeded,
+                        exceptions.DeadlineExceeded, exceptions.ServiceUnavailable,
                     ),
                 ),
                 default_timeout=60.0,
@@ -174,7 +174,7 @@ def _prep_wrapped_messages(self, client_info):
                     maximum=60.0,
                     multiplier=1.3,
                     predicate=retries.if_exception_type(
-                        exceptions.ServiceUnavailable, exceptions.DeadlineExceeded,
+                        exceptions.DeadlineExceeded, exceptions.ServiceUnavailable,
                     ),
                 ),
                 default_timeout=480.0,
@@ -187,7 +187,7 @@ def _prep_wrapped_messages(self, client_info):
                     maximum=60.0,
                     multiplier=1.3,
                     predicate=retries.if_exception_type(
-                        exceptions.ServiceUnavailable, exceptions.DeadlineExceeded,
+                        exceptions.DeadlineExceeded, exceptions.ServiceUnavailable,
                     ),
                 ),
                 default_timeout=480.0,
@@ -200,7 +200,7 @@ def _prep_wrapped_messages(self, client_info):
                     maximum=60.0,
                     multiplier=1.3,
                     predicate=retries.if_exception_type(
-                        exceptions.ServiceUnavailable, exceptions.DeadlineExceeded,
+                        exceptions.DeadlineExceeded, exceptions.ServiceUnavailable,
                     ),
                 ),
                 default_timeout=480.0,
@@ -213,7 +213,7 @@ def _prep_wrapped_messages(self, client_info):
                     maximum=60.0,
                     multiplier=1.3,
                     predicate=retries.if_exception_type(
-                        exceptions.ServiceUnavailable, exceptions.DeadlineExceeded,
+                        exceptions.DeadlineExceeded, exceptions.ServiceUnavailable,
                     ),
                 ),
                 default_timeout=480.0,
@@ -226,7 +226,7 @@ def _prep_wrapped_messages(self, client_info):
                     maximum=60.0,
                     multiplier=1.3,
                     predicate=retries.if_exception_type(
-                        exceptions.ServiceUnavailable, exceptions.DeadlineExceeded,
+                        exceptions.DeadlineExceeded, exceptions.ServiceUnavailable,
                     ),
                 ),
                 default_timeout=60.0,
@@ -248,7 +248,7 @@ def _prep_wrapped_messages(self, client_info):
                     maximum=60.0,
                     multiplier=1.3,
                     predicate=retries.if_exception_type(
-                        exceptions.ServiceUnavailable, exceptions.DeadlineExceeded,
+                        exceptions.DeadlineExceeded, exceptions.ServiceUnavailable,
                     ),
                 ),
                 default_timeout=60.0,

diff --git a/google/cloud/securitycenter_v1p1beta1/proto/finding.proto b/google/cloud/securitycenter_v1p1beta1/proto/finding.proto
@@ -55,7 +55,8 @@ message Finding {
     INACTIVE = 2;
   }
 
-  // The severity of the finding.
+  // The severity of the finding. This field is managed by the source that
+  // writes the finding.
   enum Severity {
     // No severity specified. The default value.
     SEVERITY_UNSPECIFIED = 0;
@@ -128,6 +129,7 @@ message Finding {
   // The time at which the finding was created in Security Command Center.
   google.protobuf.Timestamp create_time = 10;
 
-  // The severity of the finding.
+  // The severity of the finding. This field is managed by the source that
+  // writes the finding.
   Severity severity = 13;
 }
diff --git a/synth.metadata b/synth.metadata
@@ -3,22 +3,30 @@
     {
       "git": {
         "name": ".",
-        "remote": "git@github.com:googleapis/python-securitycenter.git",
-        "sha": "1cc4d1ffb5d64301d891d4ee95e429e4be1e4cf4"
+        "remote": "https://github.com/googleapis/python-securitycenter.git",
+        "sha": "316d224077ecb786e19444965e0e6cdc0195efc3"
+      }
+    },
+    {
+      "git": {
+        "name": "googleapis",
+        "remote": "https://github.com/googleapis/googleapis.git",
+        "sha": "bda7ce951def5ae6e5c4258d0e569188dd4ae02b",
+        "internalRef": "336180475"
       }
     },
     {
       "git": {
         "name": "synthtool",
         "remote": "https://github.com/googleapis/synthtool.git",
-        "sha": "ffcee7952b74f647cbb3ef021d95422f10816fca"
+        "sha": "9b0da5204ab90bcc36f8cd4e5689eff1a54cc3e4"
       }
     },
     {
       "git": {
         "name": "synthtool",
         "remote": "https://github.com/googleapis/synthtool.git",
-        "sha": "ffcee7952b74f647cbb3ef021d95422f10816fca"
+        "sha": "9b0da5204ab90bcc36f8cd4e5689eff1a54cc3e4"
       }
     }
   ],
@@ -50,5 +58,181 @@
         "generator": "bazel"
       }
     }
+  ],
+  "generatedFiles": [
+    ".flake8",
+    ".github/CONTRIBUTING.md",
+    ".github/ISSUE_TEMPLATE/bug_report.md",
+    ".github/ISSUE_TEMPLATE/feature_request.md",
+    ".github/ISSUE_TEMPLATE/support_request.md",
+    ".github/PULL_REQUEST_TEMPLATE.md",
+    ".github/release-please.yml",
+    ".github/snippet-bot.yml",
+    ".gitignore",
+    ".kokoro/build.sh",
+    ".kokoro/continuous/common.cfg",
+    ".kokoro/continuous/continuous.cfg",
+    ".kokoro/docker/docs/Dockerfile",
+    ".kokoro/docker/docs/fetch_gpg_keys.sh",
+    ".kokoro/docs/common.cfg",
+    ".kokoro/docs/docs-presubmit.cfg",
+    ".kokoro/docs/docs.cfg",
+    ".kokoro/populate-secrets.sh",
+    ".kokoro/presubmit/common.cfg",
+    ".kokoro/presubmit/presubmit.cfg",
+    ".kokoro/publish-docs.sh",
+    ".kokoro/release.sh",
+    ".kokoro/release/common.cfg",
+    ".kokoro/release/release.cfg",
+    ".kokoro/samples/lint/common.cfg",
+    ".kokoro/samples/lint/continuous.cfg",
+    ".kokoro/samples/lint/periodic.cfg",
+    ".kokoro/samples/lint/presubmit.cfg",
+    ".kokoro/samples/python3.6/common.cfg",
+    ".kokoro/samples/python3.6/continuous.cfg",
+    ".kokoro/samples/python3.6/periodic.cfg",
+    ".kokoro/samples/python3.6/presubmit.cfg",
+    ".kokoro/samples/python3.7/common.cfg",
+    ".kokoro/samples/python3.7/continuous.cfg",
+    ".kokoro/samples/python3.7/periodic.cfg",
+    ".kokoro/samples/python3.7/presubmit.cfg",
+    ".kokoro/samples/python3.8/common.cfg",
+    ".kokoro/samples/python3.8/continuous.cfg",
+    ".kokoro/samples/python3.8/periodic.cfg",
+    ".kokoro/samples/python3.8/presubmit.cfg",
+    ".kokoro/test-samples.sh",
+    ".kokoro/trampoline.sh",
+    ".kokoro/trampoline_v2.sh",
+    ".trampolinerc",
+    "CODE_OF_CONDUCT.md",
+    "CONTRIBUTING.rst",
+    "LICENSE",
+    "MANIFEST.in",
+    "docs/_static/custom.css",
+    "docs/_templates/layout.html",
+    "docs/conf.py",
+    "docs/multiprocessing.rst",
+    "docs/securitycenter_v1/services.rst",
+    "docs/securitycenter_v1/types.rst",
+    "docs/securitycenter_v1beta1/services.rst",
+    "docs/securitycenter_v1beta1/types.rst",
+    "docs/securitycenter_v1p1beta1/services.rst",
+    "docs/securitycenter_v1p1beta1/types.rst",
+    "google/cloud/securitycenter/__init__.py",
+    "google/cloud/securitycenter/py.typed",
+    "google/cloud/securitycenter_v1/__init__.py",
+    "google/cloud/securitycenter_v1/proto/asset.proto",
+    "google/cloud/securitycenter_v1/proto/finding.proto",
+    "google/cloud/securitycenter_v1/proto/notification_config.proto",
+    "google/cloud/securitycenter_v1/proto/notification_message.proto",
+    "google/cloud/securitycenter_v1/proto/organization_settings.proto",
+    "google/cloud/securitycenter_v1/proto/resource.proto",
+    "google/cloud/securitycenter_v1/proto/run_asset_discovery_response.proto",
+    "google/cloud/securitycenter_v1/proto/security_marks.proto",
+    "google/cloud/securitycenter_v1/proto/securitycenter_service.proto",
+    "google/cloud/securitycenter_v1/proto/source.proto",
+    "google/cloud/securitycenter_v1/py.typed",
+    "google/cloud/securitycenter_v1/services/__init__.py",
+    "google/cloud/securitycenter_v1/services/security_center/__init__.py",
+    "google/cloud/securitycenter_v1/services/security_center/async_client.py",
+    "google/cloud/securitycenter_v1/services/security_center/client.py",
+    "google/cloud/securitycenter_v1/services/security_center/pagers.py",
+    "google/cloud/securitycenter_v1/services/security_center/transports/__init__.py",
+    "google/cloud/securitycenter_v1/services/security_center/transports/base.py",
+    "google/cloud/securitycenter_v1/services/security_center/transports/grpc.py",
+    "google/cloud/securitycenter_v1/services/security_center/transports/grpc_asyncio.py",
+    "google/cloud/securitycenter_v1/types/__init__.py",
+    "google/cloud/securitycenter_v1/types/asset.py",
+    "google/cloud/securitycenter_v1/types/finding.py",
+    "google/cloud/securitycenter_v1/types/notification_config.py",
+    "google/cloud/securitycenter_v1/types/notification_message.py",
+    "google/cloud/securitycenter_v1/types/organization_settings.py",
+    "google/cloud/securitycenter_v1/types/resource.py",
+    "google/cloud/securitycenter_v1/types/run_asset_discovery_response.py",
+    "google/cloud/securitycenter_v1/types/security_marks.py",
+    "google/cloud/securitycenter_v1/types/securitycenter_service.py",
+    "google/cloud/securitycenter_v1/types/source.py",
+    "google/cloud/securitycenter_v1beta1/__init__.py",
+    "google/cloud/securitycenter_v1beta1/proto/asset.proto",
+    "google/cloud/securitycenter_v1beta1/proto/finding.proto",
+    "google/cloud/securitycenter_v1beta1/proto/organization_settings.proto",
+    "google/cloud/securitycenter_v1beta1/proto/run_asset_discovery_response.proto",
+    "google/cloud/securitycenter_v1beta1/proto/security_marks.proto",
+    "google/cloud/securitycenter_v1beta1/proto/securitycenter_service.proto",
+    "google/cloud/securitycenter_v1beta1/proto/source.proto",
+    "google/cloud/securitycenter_v1beta1/py.typed",
+    "google/cloud/securitycenter_v1beta1/services/__init__.py",
+    "google/cloud/securitycenter_v1beta1/services/security_center/__init__.py",
+    "google/cloud/securitycenter_v1beta1/services/security_center/async_client.py",
+    "google/cloud/securitycenter_v1beta1/services/security_center/client.py",
+    "google/cloud/securitycenter_v1beta1/services/security_center/pagers.py",
+    "google/cloud/securitycenter_v1beta1/services/security_center/transports/__init__.py",
+    "google/cloud/securitycenter_v1beta1/services/security_center/transports/base.py",
+    "google/cloud/securitycenter_v1beta1/services/security_center/transports/grpc.py",
+    "google/cloud/securitycenter_v1beta1/services/security_center/transports/grpc_asyncio.py",
+    "google/cloud/securitycenter_v1beta1/types/__init__.py",
+    "google/cloud/securitycenter_v1beta1/types/asset.py",
+    "google/cloud/securitycenter_v1beta1/types/finding.py",
+    "google/cloud/securitycenter_v1beta1/types/organization_settings.py",
+    "google/cloud/securitycenter_v1beta1/types/run_asset_discovery_response.py",
+    "google/cloud/securitycenter_v1beta1/types/security_marks.py",
+    "google/cloud/securitycenter_v1beta1/types/securitycenter_service.py",
+    "google/cloud/securitycenter_v1beta1/types/source.py",
+    "google/cloud/securitycenter_v1p1beta1/__init__.py",
+    "google/cloud/securitycenter_v1p1beta1/proto/asset.proto",
+    "google/cloud/securitycenter_v1p1beta1/proto/finding.proto",
+    "google/cloud/securitycenter_v1p1beta1/proto/notification_config.proto",
+    "google/cloud/securitycenter_v1p1beta1/proto/notification_message.proto",
+    "google/cloud/securitycenter_v1p1beta1/proto/organization_settings.proto",
+    "google/cloud/securitycenter_v1p1beta1/proto/resource.proto",
+    "google/cloud/securitycenter_v1p1beta1/proto/run_asset_discovery_response.proto",
+    "google/cloud/securitycenter_v1p1beta1/proto/security_marks.proto",
+    "google/cloud/securitycenter_v1p1beta1/proto/securitycenter_service.proto",
+    "google/cloud/securitycenter_v1p1beta1/proto/source.proto",
+    "google/cloud/securitycenter_v1p1beta1/py.typed",
+    "google/cloud/securitycenter_v1p1beta1/services/__init__.py",
+    "google/cloud/securitycenter_v1p1beta1/services/security_center/__init__.py",
+    "google/cloud/securitycenter_v1p1beta1/services/security_center/async_client.py",
+    "google/cloud/securitycenter_v1p1beta1/services/security_center/client.py",
+    "google/cloud/securitycenter_v1p1beta1/services/security_center/pagers.py",
+    "google/cloud/securitycenter_v1p1beta1/services/security_center/transports/__init__.py",
+    "google/cloud/securitycenter_v1p1beta1/services/security_center/transports/base.py",
+    "google/cloud/securitycenter_v1p1beta1/services/security_center/transports/grpc.py",
+    "google/cloud/securitycenter_v1p1beta1/services/security_center/transports/grpc_asyncio.py",
+    "google/cloud/securitycenter_v1p1beta1/types/__init__.py",
+    "google/cloud/securitycenter_v1p1beta1/types/asset.py",
+    "google/cloud/securitycenter_v1p1beta1/types/finding.py",
+    "google/cloud/securitycenter_v1p1beta1/types/notification_config.py",
+    "google/cloud/securitycenter_v1p1beta1/types/notification_message.py",
+    "google/cloud/securitycenter_v1p1beta1/types/organization_settings.py",
+    "google/cloud/securitycenter_v1p1beta1/types/resource.py",
+    "google/cloud/securitycenter_v1p1beta1/types/run_asset_discovery_response.py",
+    "google/cloud/securitycenter_v1p1beta1/types/security_marks.py",
+    "google/cloud/securitycenter_v1p1beta1/types/securitycenter_service.py",
+    "google/cloud/securitycenter_v1p1beta1/types/source.py",
+    "mypy.ini",
+    "noxfile.py",
+    "renovate.json",
+    "samples/AUTHORING_GUIDE.md",
+    "samples/CONTRIBUTING.md",
+    "samples/snippets/noxfile.py",
+    "scripts/decrypt-secrets.sh",
+    "scripts/fixup_securitycenter_v1_keywords.py",
+    "scripts/fixup_securitycenter_v1beta1_keywords.py",
+    "scripts/fixup_securitycenter_v1p1beta1_keywords.py",
+    "scripts/readme-gen/readme_gen.py",
+    "scripts/readme-gen/templates/README.tmpl.rst",
+    "scripts/readme-gen/templates/auth.tmpl.rst",
+    "scripts/readme-gen/templates/auth_api_key.tmpl.rst",
+    "scripts/readme-gen/templates/install_deps.tmpl.rst",
+    "scripts/readme-gen/templates/install_portaudio.tmpl.rst",
+    "setup.cfg",
+    "testing/.gitignore",
+    "tests/unit/gapic/securitycenter_v1/__init__.py",
+    "tests/unit/gapic/securitycenter_v1/test_security_center.py",
+    "tests/unit/gapic/securitycenter_v1beta1/__init__.py",
+    "tests/unit/gapic/securitycenter_v1beta1/test_security_center.py",
+    "tests/unit/gapic/securitycenter_v1p1beta1/__init__.py",
+    "tests/unit/gapic/securitycenter_v1p1beta1/test_security_center.py"
   ]
 }