Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: [google-cloud-securitycenter] Modify documentation of SimulateSecurityHealthAnalyticsCustomModuleRequest #12042

Merged
merged 2 commits into from
Nov 21, 2023
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.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -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}
Original file line number Diff line number Diff line change
Expand Up @@ -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}
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.

"""

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.
"""
Expand Down Expand Up @@ -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):
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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}
Original file line number Diff line number Diff line change
Expand Up @@ -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}
3 changes: 3 additions & 0 deletions packages/google-cloud-securitycenter/noxfile.py
Original file line number Diff line number Diff line change
Expand Up @@ -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"]
Expand Down Expand Up @@ -89,6 +91,7 @@ def lint(session):
"--check",
*LINT_PATHS,
)

session.run("flake8", "google", "tests")


Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
],
"language": "PYTHON",
"name": "google-cloud-securitycenter",
"version": "1.24.0"
"version": "0.1.0"
},
"snippets": [
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
],
"language": "PYTHON",
"name": "google-cloud-securitycenter",
"version": "1.24.0"
"version": "0.1.0"
},
"snippets": [
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
],
"language": "PYTHON",
"name": "google-cloud-securitycenter",
"version": "1.24.0"
"version": "0.1.0"
},
"snippets": [
{
Expand Down