Skip to content

docs: [google-cloud-securitycentermanagement] clarify several RPC descriptions #12146

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.

Sign up for GitHub

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

Merged
parthea merged 4 commits into from
Jan 4, 2024
Merged

docs: [google-cloud-securitycentermanagement] clarify several RPC descriptions #12146

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
330a5d6
docs: clarify several RPC descriptions
gcf-owl-bot[bot] Jan 2, 2024
9850811
🦉 Updates from OwlBot post-processor
gcf-owl-bot[bot] Jan 2, 2024
b01aac1
revert
parthea Jan 4, 2024
59bd89b
Merge branch 'main' into owl-bot-copy-packages-google-cloud-securityc…
parthea Jan 4, 2024
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
2 changes: 1 addition & 1 deletion ...gle-cloud-securitycentermanagement/google/cloud/securitycentermanagement/gapic_version.py
View file
Open in desktop
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__ = "0.1.0" # {x-release-please-version}
__version__ = "0.0.0" # {x-release-please-version}
2 changes: 1 addition & 1 deletion ...-cloud-securitycentermanagement/google/cloud/securitycentermanagement_v1/gapic_version.py
View file
Open in desktop
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__ = "0.1.0" # {x-release-please-version}
__version__ = "0.0.0" # {x-release-please-version}
67 changes: 38 additions & 29 deletions ...gle/cloud/securitycentermanagement_v1/services/security_center_management/async_client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1502,10 +1502,16 @@ async def list_effective_event_threat_detection_custom_modules(
timeout: Union[float, object] = gapic_v1.method.DEFAULT,
metadata: Sequence[Tuple[str, str]] = (),
) -> pagers.ListEffectiveEventThreatDetectionCustomModulesAsyncPager:
r"""Lists all effective Event Threat Detection custom
modules for the given parent. This includes resident
modules defined at the scope of the parent along with
modules inherited from its ancestors.
r"""Returns a list of all EffectiveEventThreatDetectionCustomModules
for the given parent. This includes resident modules defined at
the scope of the parent, and inherited modules, inherited from
CRM ancestors (no descendants). The difference between an
EffectiveCustomModule and a CustomModule is that the fields for
an EffectiveCustomModule are computed from ancestors if needed.
For example, the enablement_state for a CustomModule can be
either ENABLED, DISABLED, or INHERITED. Where as the
enablement_state for an EffectiveCustomModule is always computed
to ENABLED or DISABLED (the effective enablement_state).

.. code-block:: python

Expand Down Expand Up @@ -1783,10 +1789,11 @@ async def list_event_threat_detection_custom_modules(
timeout: Union[float, object] = gapic_v1.method.DEFAULT,
metadata: Sequence[Tuple[str, str]] = (),
) -> pagers.ListEventThreatDetectionCustomModulesAsyncPager:
r"""Lists all Event Threat Detection custom modules for
the given Resource Manager parent. This includes
resident modules defined at the scope of the parent
along with modules inherited from ancestors.
r"""Returns a list of all
EventThreatDetectionCustomModules for the given parent.
This includes resident modules defined at the scope of
the parent, and inherited modules, inherited from CRM
ancestors (no descendants).

.. code-block:: python

Expand Down Expand Up @@ -1924,9 +1931,9 @@ async def list_descendant_event_threat_detection_custom_modules(
timeout: Union[float, object] = gapic_v1.method.DEFAULT,
metadata: Sequence[Tuple[str, str]] = (),
) -> pagers.ListDescendantEventThreatDetectionCustomModulesAsyncPager:
r"""Lists all resident Event Threat Detection custom
modules under the given Resource Manager parent and its
descendants.
r"""Returns a list of all resident
EventThreatDetectionCustomModules under the given CRM
parent and all of the parent’s CRM descendants.

.. code-block:: python

Expand Down Expand Up @@ -2065,7 +2072,14 @@ async def get_event_threat_detection_custom_module(
timeout: Union[float, object] = gapic_v1.method.DEFAULT,
metadata: Sequence[Tuple[str, str]] = (),
) -> security_center_management.EventThreatDetectionCustomModule:
r"""Gets an Event Threat Detection custom module.
r"""Gets an ETD custom module. Retrieves the module at the given
level. The difference between an EffectiveCustomModule and a
CustomModule is that the fields for an EffectiveCustomModule are
computed from ancestors if needed. For example, the
enablement_state for a CustomModule can be either ENABLED,
DISABLED, or INHERITED. Where as the enablement_state for an
EffectiveCustomModule is always computed to ENABLED or DISABLED
(the effective enablement_state).

.. code-block:: python

Expand Down Expand Up @@ -2196,11 +2210,9 @@ async def create_event_threat_detection_custom_module(
timeout: Union[float, object] = gapic_v1.method.DEFAULT,
metadata: Sequence[Tuple[str, str]] = (),
) -> security_center_management.EventThreatDetectionCustomModule:
r"""Creates a resident Event Threat Detection custom
module at the scope of the given Resource Manager
parent, and also creates inherited custom modules for
all descendants of the given parent. These modules are
enabled by default.
r"""Creates an ETD custom module at the given level.
Creating a module has a side-effect of creating modules
at all descendants.

.. code-block:: python

Expand Down Expand Up @@ -2334,14 +2346,12 @@ async def update_event_threat_detection_custom_module(
timeout: Union[float, object] = gapic_v1.method.DEFAULT,
metadata: Sequence[Tuple[str, str]] = (),
) -> security_center_management.EventThreatDetectionCustomModule:
r"""Updates the Event Threat Detection custom module with
the given name based on the given update mask. Updating
the enablement state is supported for both resident and
inherited modules (though resident modules cannot have
an enablement state of "inherited"). Updating the
display name or configuration of a module is supported
for resident modules only. The type of a module cannot
be changed.
r"""Updates an ETD custom module at the given level. All
config fields can be updated when updating the module at
resident level. Only enablement state can be updated
when updating the module at inherited levels. Updating
the module has a side-effect that it updates all
descendants that are inherited from this module.

.. code-block:: python

Expand Down Expand Up @@ -2476,10 +2486,9 @@ async def delete_event_threat_detection_custom_module(
timeout: Union[float, object] = gapic_v1.method.DEFAULT,
metadata: Sequence[Tuple[str, str]] = (),
) -> None:
r"""Deletes the specified Event Threat Detection custom
module and all of its descendants in the Resource
Manager hierarchy. This method is only supported for
resident custom modules.
r"""Deletes an ETD custom module. Deletion at resident
level also deletes modules at all descendants. Deletion
at any other level is not supported.

.. code-block:: python

Expand Down
67 changes: 38 additions & 29 deletions ...nt/google/cloud/securitycentermanagement_v1/services/security_center_management/client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1771,10 +1771,16 @@ def list_effective_event_threat_detection_custom_modules(
timeout: Union[float, object] = gapic_v1.method.DEFAULT,
metadata: Sequence[Tuple[str, str]] = (),
) -> pagers.ListEffectiveEventThreatDetectionCustomModulesPager:
r"""Lists all effective Event Threat Detection custom
modules for the given parent. This includes resident
modules defined at the scope of the parent along with
modules inherited from its ancestors.
r"""Returns a list of all EffectiveEventThreatDetectionCustomModules
for the given parent. This includes resident modules defined at
the scope of the parent, and inherited modules, inherited from
CRM ancestors (no descendants). The difference between an
EffectiveCustomModule and a CustomModule is that the fields for
an EffectiveCustomModule are computed from ancestors if needed.
For example, the enablement_state for a CustomModule can be
either ENABLED, DISABLED, or INHERITED. Where as the
enablement_state for an EffectiveCustomModule is always computed
to ENABLED or DISABLED (the effective enablement_state).

.. code-block:: python

Expand Down Expand Up @@ -2042,10 +2048,11 @@ def list_event_threat_detection_custom_modules(
timeout: Union[float, object] = gapic_v1.method.DEFAULT,
metadata: Sequence[Tuple[str, str]] = (),
) -> pagers.ListEventThreatDetectionCustomModulesPager:
r"""Lists all Event Threat Detection custom modules for
the given Resource Manager parent. This includes
resident modules defined at the scope of the parent
along with modules inherited from ancestors.
r"""Returns a list of all
EventThreatDetectionCustomModules for the given parent.
This includes resident modules defined at the scope of
the parent, and inherited modules, inherited from CRM
ancestors (no descendants).

.. code-block:: python

Expand Down Expand Up @@ -2178,9 +2185,9 @@ def list_descendant_event_threat_detection_custom_modules(
timeout: Union[float, object] = gapic_v1.method.DEFAULT,
metadata: Sequence[Tuple[str, str]] = (),
) -> pagers.ListDescendantEventThreatDetectionCustomModulesPager:
r"""Lists all resident Event Threat Detection custom
modules under the given Resource Manager parent and its
descendants.
r"""Returns a list of all resident
EventThreatDetectionCustomModules under the given CRM
parent and all of the parent’s CRM descendants.

.. code-block:: python

Expand Down Expand Up @@ -2314,7 +2321,14 @@ def get_event_threat_detection_custom_module(
timeout: Union[float, object] = gapic_v1.method.DEFAULT,
metadata: Sequence[Tuple[str, str]] = (),
) -> security_center_management.EventThreatDetectionCustomModule:
r"""Gets an Event Threat Detection custom module.
r"""Gets an ETD custom module. Retrieves the module at the given
level. The difference between an EffectiveCustomModule and a
CustomModule is that the fields for an EffectiveCustomModule are
computed from ancestors if needed. For example, the
enablement_state for a CustomModule can be either ENABLED,
DISABLED, or INHERITED. Where as the enablement_state for an
EffectiveCustomModule is always computed to ENABLED or DISABLED
(the effective enablement_state).

.. code-block:: python

Expand Down Expand Up @@ -2442,11 +2456,9 @@ def create_event_threat_detection_custom_module(
timeout: Union[float, object] = gapic_v1.method.DEFAULT,
metadata: Sequence[Tuple[str, str]] = (),
) -> security_center_management.EventThreatDetectionCustomModule:
r"""Creates a resident Event Threat Detection custom
module at the scope of the given Resource Manager
parent, and also creates inherited custom modules for
all descendants of the given parent. These modules are
enabled by default.
r"""Creates an ETD custom module at the given level.
Creating a module has a side-effect of creating modules
at all descendants.

.. code-block:: python

Expand Down Expand Up @@ -2583,14 +2595,12 @@ def update_event_threat_detection_custom_module(
timeout: Union[float, object] = gapic_v1.method.DEFAULT,
metadata: Sequence[Tuple[str, str]] = (),
) -> security_center_management.EventThreatDetectionCustomModule:
r"""Updates the Event Threat Detection custom module with
the given name based on the given update mask. Updating
the enablement state is supported for both resident and
inherited modules (though resident modules cannot have
an enablement state of "inherited"). Updating the
display name or configuration of a module is supported
for resident modules only. The type of a module cannot
be changed.
r"""Updates an ETD custom module at the given level. All
config fields can be updated when updating the module at
resident level. Only enablement state can be updated
when updating the module at inherited levels. Updating
the module has a side-effect that it updates all
descendants that are inherited from this module.

.. code-block:: python

Expand Down Expand Up @@ -2728,10 +2738,9 @@ def delete_event_threat_detection_custom_module(
timeout: Union[float, object] = gapic_v1.method.DEFAULT,
metadata: Sequence[Tuple[str, str]] = (),
) -> None:
r"""Deletes the specified Event Threat Detection custom
module and all of its descendants in the Resource
Manager hierarchy. This method is only supported for
resident custom modules.
r"""Deletes an ETD custom module. Deletion at resident
level also deletes modules at all descendants. Deletion
at any other level is not supported.

.. code-block:: python

Expand Down
67 changes: 38 additions & 29 deletions .../cloud/securitycentermanagement_v1/services/security_center_management/transports/grpc.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -565,10 +565,16 @@ def list_effective_event_threat_detection_custom_modules(
r"""Return a callable for the list effective event threat
detection custom modules method over gRPC.

Lists all effective Event Threat Detection custom
modules for the given parent. This includes resident
modules defined at the scope of the parent along with
modules inherited from its ancestors.
Returns a list of all EffectiveEventThreatDetectionCustomModules
for the given parent. This includes resident modules defined at
the scope of the parent, and inherited modules, inherited from
CRM ancestors (no descendants). The difference between an
EffectiveCustomModule and a CustomModule is that the fields for
an EffectiveCustomModule are computed from ancestors if needed.
For example, the enablement_state for a CustomModule can be
either ENABLED, DISABLED, or INHERITED. Where as the
enablement_state for an EffectiveCustomModule is always computed
to ENABLED or DISABLED (the effective enablement_state).

Returns:
Callable[[~.ListEffectiveEventThreatDetectionCustomModulesRequest],
Expand Down Expand Up @@ -641,10 +647,11 @@ def list_event_threat_detection_custom_modules(
r"""Return a callable for the list event threat detection
custom modules method over gRPC.

Lists all Event Threat Detection custom modules for
the given Resource Manager parent. This includes
resident modules defined at the scope of the parent
along with modules inherited from ancestors.
Returns a list of all
EventThreatDetectionCustomModules for the given parent.
This includes resident modules defined at the scope of
the parent, and inherited modules, inherited from CRM
ancestors (no descendants).

Returns:
Callable[[~.ListEventThreatDetectionCustomModulesRequest],
Expand Down Expand Up @@ -678,9 +685,9 @@ def list_descendant_event_threat_detection_custom_modules(
r"""Return a callable for the list descendant event threat
detection custom modules method over gRPC.

Lists all resident Event Threat Detection custom
modules under the given Resource Manager parent and its
descendants.
Returns a list of all resident
EventThreatDetectionCustomModules under the given CRM
parent and all of the parent’s CRM descendants.

Returns:
Callable[[~.ListDescendantEventThreatDetectionCustomModulesRequest],
Expand Down Expand Up @@ -712,7 +719,14 @@ def get_event_threat_detection_custom_module(
r"""Return a callable for the get event threat detection
custom module method over gRPC.

Gets an Event Threat Detection custom module.
Gets an ETD custom module. Retrieves the module at the given
level. The difference between an EffectiveCustomModule and a
CustomModule is that the fields for an EffectiveCustomModule are
computed from ancestors if needed. For example, the
enablement_state for a CustomModule can be either ENABLED,
DISABLED, or INHERITED. Where as the enablement_state for an
EffectiveCustomModule is always computed to ENABLED or DISABLED
(the effective enablement_state).

Returns:
Callable[[~.GetEventThreatDetectionCustomModuleRequest],
Expand Down Expand Up @@ -744,11 +758,9 @@ def create_event_threat_detection_custom_module(
r"""Return a callable for the create event threat detection
custom module method over gRPC.

Creates a resident Event Threat Detection custom
module at the scope of the given Resource Manager
parent, and also creates inherited custom modules for
all descendants of the given parent. These modules are
enabled by default.
Creates an ETD custom module at the given level.
Creating a module has a side-effect of creating modules
at all descendants.

Returns:
Callable[[~.CreateEventThreatDetectionCustomModuleRequest],
Expand Down Expand Up @@ -780,14 +792,12 @@ def update_event_threat_detection_custom_module(
r"""Return a callable for the update event threat detection
custom module method over gRPC.

Updates the Event Threat Detection custom module with
the given name based on the given update mask. Updating
the enablement state is supported for both resident and
inherited modules (though resident modules cannot have
an enablement state of "inherited"). Updating the
display name or configuration of a module is supported
for resident modules only. The type of a module cannot
be changed.
Updates an ETD custom module at the given level. All
config fields can be updated when updating the module at
resident level. Only enablement state can be updated
when updating the module at inherited levels. Updating
the module has a side-effect that it updates all
descendants that are inherited from this module.

Returns:
Callable[[~.UpdateEventThreatDetectionCustomModuleRequest],
Expand Down Expand Up @@ -819,10 +829,9 @@ def delete_event_threat_detection_custom_module(
r"""Return a callable for the delete event threat detection
custom module method over gRPC.

Deletes the specified Event Threat Detection custom
module and all of its descendants in the Resource
Manager hierarchy. This method is only supported for
resident custom modules.
Deletes an ETD custom module. Deletion at resident
level also deletes modules at all descendants. Deletion
at any other level is not supported.

Returns:
Callable[[~.DeleteEventThreatDetectionCustomModuleRequest],
Expand Down
Loading