Skip to content

Commit 27239dd

Browse files
gcf-owl-bot[bot]gcf-owl-bot[bot]
authored
docs: [google-cloud-securitycenter] Modify documentation of SimulateSecurityHealthAnalyticsCustomModuleRequest (googleapis#12042)
- [ ] Regenerate this pull request now. PiperOrigin-RevId: 584348542 Source-Link: googleapis/googleapis@d2efcaa Source-Link: https://github.com/googleapis/googleapis-gen/commit/6fb846a100194eada9f667417dd142da12e784b7 Copy-Tag: eyJwIjoicGFja2FnZXMvZ29vZ2xlLWNsb3VkLXNlY3VyaXR5Y2VudGVyLy5Pd2xCb3QueWFtbCIsImgiOiI2ZmI4NDZhMTAwMTk0ZWFkYTlmNjY3NDE3ZGQxNDJkYTEyZTc4NGI3In0= --------- Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com>
1 parent 728ae05 commit 27239dd

12 files changed

Lines changed: 43 additions & 38 deletions

File tree

‎packages/google-cloud-securitycenter/google/cloud/securitycenter/gapic_version.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,4 +13,4 @@
1313
# See the License for the specific language governing permissions and
1414
# limitations under the License.
1515
#
16-
__version__ = "1.24.0" # {x-release-please-version}
16+
__version__ = "0.0.0" # {x-release-please-version}

‎packages/google-cloud-securitycenter/google/cloud/securitycenter_v1/gapic_version.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,4 +13,4 @@
1313
# See the License for the specific language governing permissions and
1414
# limitations under the License.
1515
#
16-
__version__ = "1.24.0" # {x-release-please-version}
16+
__version__ = "0.0.0" # {x-release-please-version}

‎packages/google-cloud-securitycenter/google/cloud/securitycenter_v1/services/security_center/async_client.py‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -4416,16 +4416,17 @@ async def sample_simulate_security_health_analytics_custom_module():
44164416
4 MB by default.
44174417
parent (:class:`str`):
44184418
Required. The relative resource name of the
4419-
organization, project, or folder. See:
4420-
https://cloud.google.com/apis/design/resource_names#relative_resource_name
4421-
An example is: "organizations/{organization_id}".
4419+
organization, project, or folder. For more information
4420+
about relative resource names, see `Relative Resource
4421+
Name <https://cloud.google.com/apis/design/resource_names#relative_resource_name>`__
4422+
Example: ``organizations/{organization_id}``
44224423
44234424
This corresponds to the ``parent`` field
44244425
on the ``request`` instance; if ``request`` is provided, this
44254426
should not be set.
44264427
custom_config (:class:`google.cloud.securitycenter_v1.types.CustomConfig`):
4427-
Required. The user specified custom
4428-
configuration to test.
4428+
Required. The custom configuration
4429+
that you need to test.
44294430
44304431
This corresponds to the ``custom_config`` field
44314432
on the ``request`` instance; if ``request`` is provided, this
@@ -4445,9 +4446,8 @@ async def sample_simulate_security_health_analytics_custom_module():
44454446
44464447
Returns:
44474448
google.cloud.securitycenter_v1.types.SimulateSecurityHealthAnalyticsCustomModuleResponse:
4448-
Response message for simulating a
4449-
SecurityHealthAnalyticsCustomModule
4450-
against a given resource.
4449+
Response message for simulating a SecurityHealthAnalyticsCustomModule
4450+
against a given resource.
44514451
44524452
"""
44534453
# Create or coerce a protobuf request object.

‎packages/google-cloud-securitycenter/google/cloud/securitycenter_v1/services/security_center/client.py‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -4742,16 +4742,17 @@ def sample_simulate_security_health_analytics_custom_module():
47424742
4 MB by default.
47434743
parent (str):
47444744
Required. The relative resource name of the
4745-
organization, project, or folder. See:
4746-
https://cloud.google.com/apis/design/resource_names#relative_resource_name
4747-
An example is: "organizations/{organization_id}".
4745+
organization, project, or folder. For more information
4746+
about relative resource names, see `Relative Resource
4747+
Name <https://cloud.google.com/apis/design/resource_names#relative_resource_name>`__
4748+
Example: ``organizations/{organization_id}``
47484749
47494750
This corresponds to the ``parent`` field
47504751
on the ``request`` instance; if ``request`` is provided, this
47514752
should not be set.
47524753
custom_config (google.cloud.securitycenter_v1.types.CustomConfig):
4753-
Required. The user specified custom
4754-
configuration to test.
4754+
Required. The custom configuration
4755+
that you need to test.
47554756
47564757
This corresponds to the ``custom_config`` field
47574758
on the ``request`` instance; if ``request`` is provided, this
@@ -4771,9 +4772,8 @@ def sample_simulate_security_health_analytics_custom_module():
47714772
47724773
Returns:
47734774
google.cloud.securitycenter_v1.types.SimulateSecurityHealthAnalyticsCustomModuleResponse:
4774-
Response message for simulating a
4775-
SecurityHealthAnalyticsCustomModule
4776-
against a given resource.
4775+
Response message for simulating a SecurityHealthAnalyticsCustomModule
4776+
against a given resource.
47774777
47784778
"""
47794779
# Create or coerce a protobuf request object.

‎packages/google-cloud-securitycenter/google/cloud/securitycenter_v1/services/security_center/transports/rest.py‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5494,8 +5494,8 @@ def __call__(
54945494
Returns:
54955495
~.securitycenter_service.SimulateSecurityHealthAnalyticsCustomModuleResponse:
54965496
Response message for simulating a
5497-
SecurityHealthAnalyticsCustomModule
5498-
against a given resource.
5497+
``SecurityHealthAnalyticsCustomModule`` against a given
5498+
resource.
54995499
55005500
"""
55015501

‎packages/google-cloud-securitycenter/google/cloud/securitycenter_v1/types/securitycenter_service.py‎

Lines changed: 15 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -2129,30 +2129,32 @@ class SimulateSecurityHealthAnalyticsCustomModuleRequest(proto.Message):
21292129
Attributes:
21302130
parent (str):
21312131
Required. The relative resource name of the organization,
2132-
project, or folder. See:
2133-
https://cloud.google.com/apis/design/resource_names#relative_resource_name
2134-
An example is: "organizations/{organization_id}".
2132+
project, or folder. For more information about relative
2133+
resource names, see `Relative Resource
2134+
Name <https://cloud.google.com/apis/design/resource_names#relative_resource_name>`__
2135+
Example: ``organizations/{organization_id}``
21352136
custom_config (google.cloud.securitycenter_v1.types.CustomConfig):
2136-
Required. The user specified custom
2137-
configuration to test.
2137+
Required. The custom configuration that you
2138+
need to test.
21382139
resource (google.cloud.securitycenter_v1.types.SimulateSecurityHealthAnalyticsCustomModuleRequest.SimulatedResource):
21392140
Required. Resource data to simulate custom
21402141
module against.
21412142
"""
21422143

21432144
class SimulatedResource(proto.Message):
2144-
r"""Manually constructed resource. If the custom module only evaluates
2145-
against the resource data, the iam_policy_data field can be omitted,
2146-
and vice versa.
2145+
r"""Manually constructed resource name. If the custom module evaluates
2146+
against only the resource data, you can omit the ``iam_policy_data``
2147+
field. If it evaluates only the ``iam_policy_data`` field, you can
2148+
omit the resource data.
21472149
21482150
Attributes:
21492151
resource_type (str):
2150-
Required. The type of the resource, e.g.
2152+
Required. The type of the resource, for example,
21512153
``compute.googleapis.com/Disk``.
21522154
resource_data (google.protobuf.struct_pb2.Struct):
2153-
Optional. A representation of the GCP
2154-
resource. Should match the GCP resource JSON
2155-
format.
2155+
Optional. A representation of the Google
2156+
Cloud resource. Should match the Google Cloud
2157+
resource JSON format.
21562158
iam_policy_data (google.iam.v1.policy_pb2.Policy):
21572159
Optional. A representation of the IAM policy.
21582160
"""
@@ -2190,7 +2192,7 @@ class SimulatedResource(proto.Message):
21902192

21912193
class SimulateSecurityHealthAnalyticsCustomModuleResponse(proto.Message):
21922194
r"""Response message for simulating a
2193-
SecurityHealthAnalyticsCustomModule against a given resource.
2195+
``SecurityHealthAnalyticsCustomModule`` against a given resource.
21942196
21952197
Attributes:
21962198
result (google.cloud.securitycenter_v1.types.SimulateSecurityHealthAnalyticsCustomModuleResponse.SimulatedResult):

‎packages/google-cloud-securitycenter/google/cloud/securitycenter_v1beta1/gapic_version.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,4 +13,4 @@
1313
# See the License for the specific language governing permissions and
1414
# limitations under the License.
1515
#
16-
__version__ = "1.24.0" # {x-release-please-version}
16+
__version__ = "0.0.0" # {x-release-please-version}

‎packages/google-cloud-securitycenter/google/cloud/securitycenter_v1p1beta1/gapic_version.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,4 +13,4 @@
1313
# See the License for the specific language governing permissions and
1414
# limitations under the License.
1515
#
16-
__version__ = "1.24.0" # {x-release-please-version}
16+
__version__ = "0.0.0" # {x-release-please-version}

‎packages/google-cloud-securitycenter/noxfile.py‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,8 +29,10 @@
2929

3030
BLACK_VERSION = "black[jupyter]==23.7.0"
3131
ISORT_VERSION = "isort==5.11.0"
32+
3233
LINT_PATHS = ["docs", "google", "tests", "noxfile.py", "setup.py"]
3334

35+
3436
DEFAULT_PYTHON_VERSION = "3.10"
3537

3638
UNIT_TEST_PYTHON_VERSIONS: List[str] = ["3.7", "3.8", "3.9", "3.10", "3.11"]
@@ -89,6 +91,7 @@ def lint(session):
8991
"--check",
9092
*LINT_PATHS,
9193
)
94+
9295
session.run("flake8", "google", "tests")
9396

9497

‎packages/google-cloud-securitycenter/samples/generated_samples/snippet_metadata_google.cloud.securitycenter.v1.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
],
99
"language": "PYTHON",
1010
"name": "google-cloud-securitycenter",
11-
"version": "1.24.0"
11+
"version": "0.1.0"
1212
},
1313
"snippets": [
1414
{

0 commit comments

Comments
 (0)