docs: [google-cloud-securitycenter] Modify documentation of SimulateS…

…ecurityHealthAnalyticsCustomModuleRequest (#12042) - [ ] Regenerate this pull request now. PiperOrigin-RevId: 584348542 Source-Link: googleapis/googleapis@d2efcaa Source-Link: googleapis/googleapis-gen@6fb846a Copy-Tag: eyJwIjoicGFja2FnZXMvZ29vZ2xlLWNsb3VkLXNlY3VyaXR5Y2VudGVyLy5Pd2xCb3QueWFtbCIsImgiOiI2ZmI4NDZhMTAwMTk0ZWFkYTlmNjY3NDE3ZGQxNDJkYTEyZTc4NGI3In0= --------- Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com>
googleapis · Nov 21, 2023 · 27239dd · 27239dd
1 parent 728ae05
commit 27239dd
Show file tree

Hide file tree

Showing 12 changed files with 43 additions and 38 deletions.
diff --git a/packages/google-cloud-securitycenter/google/cloud/securitycenter/gapic_version.py b/packages/google-cloud-securitycenter/google/cloud/securitycenter/gapic_version.py
@@ -13,4 +13,4 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
-__version__ = "1.24.0"  # {x-release-please-version}
+__version__ = "0.0.0"  # {x-release-please-version}
diff --git a/packages/google-cloud-securitycenter/google/cloud/securitycenter_v1/gapic_version.py b/packages/google-cloud-securitycenter/google/cloud/securitycenter_v1/gapic_version.py
@@ -13,4 +13,4 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
-__version__ = "1.24.0"  # {x-release-please-version}
+__version__ = "0.0.0"  # {x-release-please-version}
diff --git a/...ud-securitycenter/google/cloud/securitycenter_v1/services/security_center/async_client.py b/...ud-securitycenter/google/cloud/securitycenter_v1/services/security_center/async_client.py
@@ -4416,16 +4416,17 @@ async def sample_simulate_security_health_analytics_custom_module():
                 4 MB by default.
             parent (:class:`str`):
                 Required. The relative resource name of the
-                organization, project, or folder. See:
-                https://cloud.google.com/apis/design/resource_names#relative_resource_name
-                An example is: "organizations/{organization_id}".
+                organization, project, or folder. For more information
+                about relative resource names, see `Relative Resource
+                Name <https://cloud.google.com/apis/design/resource_names#relative_resource_name>`__
+                Example: ``organizations/{organization_id}``
 
                 This corresponds to the ``parent`` field
                 on the ``request`` instance; if ``request`` is provided, this
                 should not be set.
             custom_config (:class:`google.cloud.securitycenter_v1.types.CustomConfig`):
-                Required. The user specified custom
-                configuration to test.
+                Required. The custom configuration
+                that you need to test.
 
                 This corresponds to the ``custom_config`` field
                 on the ``request`` instance; if ``request`` is provided, this
@@ -4445,9 +4446,8 @@ async def sample_simulate_security_health_analytics_custom_module():
 
         Returns:
             google.cloud.securitycenter_v1.types.SimulateSecurityHealthAnalyticsCustomModuleResponse:
-                Response message for simulating a
-                SecurityHealthAnalyticsCustomModule
-                against a given resource.
+                Response message for simulating a SecurityHealthAnalyticsCustomModule
+                   against a given resource.
 
         """
         # Create or coerce a protobuf request object.

diff --git a/...le-cloud-securitycenter/google/cloud/securitycenter_v1/services/security_center/client.py b/...le-cloud-securitycenter/google/cloud/securitycenter_v1/services/security_center/client.py
@@ -4742,16 +4742,17 @@ def sample_simulate_security_health_analytics_custom_module():
                 4 MB by default.
             parent (str):
                 Required. The relative resource name of the
-                organization, project, or folder. See:
-                https://cloud.google.com/apis/design/resource_names#relative_resource_name
-                An example is: "organizations/{organization_id}".
+                organization, project, or folder. For more information
+                about relative resource names, see `Relative Resource
+                Name <https://cloud.google.com/apis/design/resource_names#relative_resource_name>`__
+                Example: ``organizations/{organization_id}``
 
                 This corresponds to the ``parent`` field
                 on the ``request`` instance; if ``request`` is provided, this
                 should not be set.
             custom_config (google.cloud.securitycenter_v1.types.CustomConfig):
-                Required. The user specified custom
-                configuration to test.
+                Required. The custom configuration
+                that you need to test.
 
                 This corresponds to the ``custom_config`` field
                 on the ``request`` instance; if ``request`` is provided, this
@@ -4771,9 +4772,8 @@ def sample_simulate_security_health_analytics_custom_module():
 
         Returns:
             google.cloud.securitycenter_v1.types.SimulateSecurityHealthAnalyticsCustomModuleResponse:
-                Response message for simulating a
-                SecurityHealthAnalyticsCustomModule
-                against a given resource.
+                Response message for simulating a SecurityHealthAnalyticsCustomModule
+                   against a given resource.
 
         """
         # Create or coerce a protobuf request object.

diff --git a/...securitycenter/google/cloud/securitycenter_v1/services/security_center/transports/rest.py b/...securitycenter/google/cloud/securitycenter_v1/services/security_center/transports/rest.py
@@ -5494,8 +5494,8 @@ def __call__(
                 Returns:
                     ~.securitycenter_service.SimulateSecurityHealthAnalyticsCustomModuleResponse:
                         Response message for simulating a
-                    SecurityHealthAnalyticsCustomModule
-                    against a given resource.
+                    ``SecurityHealthAnalyticsCustomModule`` against a given
+                    resource.
 
             """
 

diff --git a/...oogle-cloud-securitycenter/google/cloud/securitycenter_v1/types/securitycenter_service.py b/...oogle-cloud-securitycenter/google/cloud/securitycenter_v1/types/securitycenter_service.py
@@ -2129,30 +2129,32 @@ class SimulateSecurityHealthAnalyticsCustomModuleRequest(proto.Message):
     Attributes:
         parent (str):
             Required. The relative resource name of the organization,
-            project, or folder. See:
-            https://cloud.google.com/apis/design/resource_names#relative_resource_name
-            An example is: "organizations/{organization_id}".
+            project, or folder. For more information about relative
+            resource names, see `Relative Resource
+            Name <https://cloud.google.com/apis/design/resource_names#relative_resource_name>`__
+            Example: ``organizations/{organization_id}``
         custom_config (google.cloud.securitycenter_v1.types.CustomConfig):
-            Required. The user specified custom
-            configuration to test.
+            Required. The custom configuration that you
+            need to test.
         resource (google.cloud.securitycenter_v1.types.SimulateSecurityHealthAnalyticsCustomModuleRequest.SimulatedResource):
             Required. Resource data to simulate custom
             module against.
     """
 
     class SimulatedResource(proto.Message):
-        r"""Manually constructed resource. If the custom module only evaluates
-        against the resource data, the iam_policy_data field can be omitted,
-        and vice versa.
+        r"""Manually constructed resource name. If the custom module evaluates
+        against only the resource data, you can omit the ``iam_policy_data``
+        field. If it evaluates only the ``iam_policy_data`` field, you can
+        omit the resource data.
 
         Attributes:
             resource_type (str):
-                Required. The type of the resource, e.g.
+                Required. The type of the resource, for example,
                 ``compute.googleapis.com/Disk``.
             resource_data (google.protobuf.struct_pb2.Struct):
-                Optional. A representation of the GCP
-                resource. Should match the GCP resource JSON
-                format.
+                Optional. A representation of the Google
+                Cloud resource. Should match the Google Cloud
+                resource JSON format.
             iam_policy_data (google.iam.v1.policy_pb2.Policy):
                 Optional. A representation of the IAM policy.
         """
@@ -2190,7 +2192,7 @@ class SimulatedResource(proto.Message):
 
 class SimulateSecurityHealthAnalyticsCustomModuleResponse(proto.Message):
     r"""Response message for simulating a
-    SecurityHealthAnalyticsCustomModule against a given resource.
+    ``SecurityHealthAnalyticsCustomModule`` against a given resource.
 
     Attributes:
         result (google.cloud.securitycenter_v1.types.SimulateSecurityHealthAnalyticsCustomModuleResponse.SimulatedResult):

diff --git a/packages/google-cloud-securitycenter/google/cloud/securitycenter_v1beta1/gapic_version.py b/packages/google-cloud-securitycenter/google/cloud/securitycenter_v1beta1/gapic_version.py
@@ -13,4 +13,4 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
-__version__ = "1.24.0"  # {x-release-please-version}
+__version__ = "0.0.0"  # {x-release-please-version}
diff --git a/packages/google-cloud-securitycenter/google/cloud/securitycenter_v1p1beta1/gapic_version.py b/packages/google-cloud-securitycenter/google/cloud/securitycenter_v1p1beta1/gapic_version.py
@@ -13,4 +13,4 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
-__version__ = "1.24.0"  # {x-release-please-version}
+__version__ = "0.0.0"  # {x-release-please-version}
diff --git a/packages/google-cloud-securitycenter/noxfile.py b/packages/google-cloud-securitycenter/noxfile.py
@@ -29,8 +29,10 @@
 
 BLACK_VERSION = "black[jupyter]==23.7.0"
 ISORT_VERSION = "isort==5.11.0"
+
 LINT_PATHS = ["docs", "google", "tests", "noxfile.py", "setup.py"]
 
+
 DEFAULT_PYTHON_VERSION = "3.10"
 
 UNIT_TEST_PYTHON_VERSIONS: List[str] = ["3.7", "3.8", "3.9", "3.10", "3.11"]
@@ -89,6 +91,7 @@ def lint(session):
         "--check",
         *LINT_PATHS,
     )
+
     session.run("flake8", "google", "tests")
 
 

diff --git a/...ritycenter/samples/generated_samples/snippet_metadata_google.cloud.securitycenter.v1.json b/...ritycenter/samples/generated_samples/snippet_metadata_google.cloud.securitycenter.v1.json
@@ -8,7 +8,7 @@
     ],
     "language": "PYTHON",
     "name": "google-cloud-securitycenter",
-    "version": "1.24.0"
+    "version": "0.1.0"
   },
   "snippets": [
     {

diff --git a/...enter/samples/generated_samples/snippet_metadata_google.cloud.securitycenter.v1beta1.json b/...enter/samples/generated_samples/snippet_metadata_google.cloud.securitycenter.v1beta1.json
@@ -8,7 +8,7 @@
     ],
     "language": "PYTHON",
     "name": "google-cloud-securitycenter",
-    "version": "1.24.0"
+    "version": "0.1.0"
   },
   "snippets": [
     {

diff --git a/...ter/samples/generated_samples/snippet_metadata_google.cloud.securitycenter.v1p1beta1.json b/...ter/samples/generated_samples/snippet_metadata_google.cloud.securitycenter.v1p1beta1.json
@@ -8,7 +8,7 @@
     ],
     "language": "PYTHON",
     "name": "google-cloud-securitycenter",
-    "version": "1.24.0"
+    "version": "0.1.0"
   },
   "snippets": [
     {