Skip to content

docs: [google-cloud-privilegedaccessmanager] comment fixes #13278

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 2 commits into from
Nov 14, 2024
Merged

docs: [google-cloud-privilegedaccessmanager] comment fixes #13278

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
24a875f
chore: comment fixes
gcf-owl-bot[bot] Nov 14, 2024
c98040a
🦉 Updates from OwlBot post-processor
gcf-owl-bot[bot] Nov 14, 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 ...oogle-cloud-privilegedaccessmanager/google/cloud/privilegedaccessmanager/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.3" # {x-release-please-version}
__version__ = "0.0.0" # {x-release-please-version}
2 changes: 1 addition & 1 deletion ...le-cloud-privilegedaccessmanager/google/cloud/privilegedaccessmanager_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.3" # {x-release-please-version}
__version__ = "0.0.0" # {x-release-please-version}
50 changes: 22 additions & 28 deletions ...oogle/cloud/privilegedaccessmanager_v1/services/privileged_access_manager/async_client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -311,10 +311,9 @@ async def check_onboarding_status(
timeout: Union[float, object] = gapic_v1.method.DEFAULT,
metadata: Sequence[Tuple[str, str]] = (),
) -> privilegedaccessmanager.CheckOnboardingStatusResponse:
r"""CheckOnboardingStatus reports the onboarding status
for a project/folder/organization. Any findings reported
by this API need to be fixed before PAM can be used on
the resource.
r"""``CheckOnboardingStatus`` reports the onboarding status for a
project/folder/organization. Any findings reported by this API
need to be fixed before PAM can be used on the resource.

.. code-block:: python

Expand Down Expand Up @@ -886,9 +885,9 @@ async def delete_entitlement(
timeout: Union[float, object] = gapic_v1.method.DEFAULT,
metadata: Sequence[Tuple[str, str]] = (),
) -> operation_async.AsyncOperation:
r"""Deletes a single entitlement. This method can only be
called when there are no in-progress
(ACTIVE/ACTIVATING/REVOKING) grants under the
r"""Deletes a single entitlement. This method can only be called
when there are no in-progress
(``ACTIVE``/``ACTIVATING``/``REVOKING``) grants under the
entitlement.

.. code-block:: python
Expand Down Expand Up @@ -1438,10 +1437,9 @@ async def sample_get_grant():

Returns:
google.cloud.privilegedaccessmanager_v1.types.Grant:
This is to ensure that the Grants and ProducerGrants proto are byte
compatible. A grant represents a request from a user
for obtaining the access specified in an entitlement
they are eligible for.
A grant represents a request from a
user for obtaining the access specified
in an entitlement they are eligible for.

"""
# Create or coerce a protobuf request object.
Expand Down Expand Up @@ -1502,7 +1500,8 @@ async def create_grant(
timeout: Union[float, object] = gapic_v1.method.DEFAULT,
metadata: Sequence[Tuple[str, str]] = (),
) -> privilegedaccessmanager.Grant:
r"""Creates a new grant in a given project and location.
r"""Creates a new grant in a given
project/folder/organization and location.

.. code-block:: python

Expand Down Expand Up @@ -1554,10 +1553,9 @@ async def sample_create_grant():

Returns:
google.cloud.privilegedaccessmanager_v1.types.Grant:
This is to ensure that the Grants and ProducerGrants proto are byte
compatible. A grant represents a request from a user
for obtaining the access specified in an entitlement
they are eligible for.
A grant represents a request from a
user for obtaining the access specified
in an entitlement they are eligible for.

"""
# Create or coerce a protobuf request object.
Expand Down Expand Up @@ -1659,10 +1657,9 @@ async def sample_approve_grant():

Returns:
google.cloud.privilegedaccessmanager_v1.types.Grant:
This is to ensure that the Grants and ProducerGrants proto are byte
compatible. A grant represents a request from a user
for obtaining the access specified in an entitlement
they are eligible for.
A grant represents a request from a
user for obtaining the access specified
in an entitlement they are eligible for.

"""
# Create or coerce a protobuf request object.
Expand Down Expand Up @@ -1746,10 +1743,9 @@ async def sample_deny_grant():

Returns:
google.cloud.privilegedaccessmanager_v1.types.Grant:
This is to ensure that the Grants and ProducerGrants proto are byte
compatible. A grant represents a request from a user
for obtaining the access specified in an entitlement
they are eligible for.
A grant represents a request from a
user for obtaining the access specified
in an entitlement they are eligible for.

"""
# Create or coerce a protobuf request object.
Expand Down Expand Up @@ -1841,10 +1837,8 @@ async def sample_revoke_grant():
google.api_core.operation_async.AsyncOperation:
An object representing a long-running operation.

The result type for the operation will be :class:`google.cloud.privilegedaccessmanager_v1.types.Grant` This is to ensure that the Grants and ProducerGrants proto are byte
compatible. A grant represents a request from a user
for obtaining the access specified in an entitlement
they are eligible for.
The result type for the operation will be :class:`google.cloud.privilegedaccessmanager_v1.types.Grant` A grant represents a request from a user for obtaining the access specified
in an entitlement they are eligible for.

"""
# Create or coerce a protobuf request object.
Expand Down
50 changes: 22 additions & 28 deletions ...ager/google/cloud/privilegedaccessmanager_v1/services/privileged_access_manager/client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -721,10 +721,9 @@ def check_onboarding_status(
timeout: Union[float, object] = gapic_v1.method.DEFAULT,
metadata: Sequence[Tuple[str, str]] = (),
) -> privilegedaccessmanager.CheckOnboardingStatusResponse:
r"""CheckOnboardingStatus reports the onboarding status
for a project/folder/organization. Any findings reported
by this API need to be fixed before PAM can be used on
the resource.
r"""``CheckOnboardingStatus`` reports the onboarding status for a
project/folder/organization. Any findings reported by this API
need to be fixed before PAM can be used on the resource.

.. code-block:: python

Expand Down Expand Up @@ -1283,9 +1282,9 @@ def delete_entitlement(
timeout: Union[float, object] = gapic_v1.method.DEFAULT,
metadata: Sequence[Tuple[str, str]] = (),
) -> operation.Operation:
r"""Deletes a single entitlement. This method can only be
called when there are no in-progress
(ACTIVE/ACTIVATING/REVOKING) grants under the
r"""Deletes a single entitlement. This method can only be called
when there are no in-progress
(``ACTIVE``/``ACTIVATING``/``REVOKING``) grants under the
entitlement.

.. code-block:: python
Expand Down Expand Up @@ -1824,10 +1823,9 @@ def sample_get_grant():

Returns:
google.cloud.privilegedaccessmanager_v1.types.Grant:
This is to ensure that the Grants and ProducerGrants proto are byte
compatible. A grant represents a request from a user
for obtaining the access specified in an entitlement
they are eligible for.
A grant represents a request from a
user for obtaining the access specified
in an entitlement they are eligible for.

"""
# Create or coerce a protobuf request object.
Expand Down Expand Up @@ -1885,7 +1883,8 @@ def create_grant(
timeout: Union[float, object] = gapic_v1.method.DEFAULT,
metadata: Sequence[Tuple[str, str]] = (),
) -> privilegedaccessmanager.Grant:
r"""Creates a new grant in a given project and location.
r"""Creates a new grant in a given
project/folder/organization and location.

.. code-block:: python

Expand Down Expand Up @@ -1937,10 +1936,9 @@ def sample_create_grant():

Returns:
google.cloud.privilegedaccessmanager_v1.types.Grant:
This is to ensure that the Grants and ProducerGrants proto are byte
compatible. A grant represents a request from a user
for obtaining the access specified in an entitlement
they are eligible for.
A grant represents a request from a
user for obtaining the access specified
in an entitlement they are eligible for.

"""
# Create or coerce a protobuf request object.
Expand Down Expand Up @@ -2039,10 +2037,9 @@ def sample_approve_grant():

Returns:
google.cloud.privilegedaccessmanager_v1.types.Grant:
This is to ensure that the Grants and ProducerGrants proto are byte
compatible. A grant represents a request from a user
for obtaining the access specified in an entitlement
they are eligible for.
A grant represents a request from a
user for obtaining the access specified
in an entitlement they are eligible for.

"""
# Create or coerce a protobuf request object.
Expand Down Expand Up @@ -2124,10 +2121,9 @@ def sample_deny_grant():

Returns:
google.cloud.privilegedaccessmanager_v1.types.Grant:
This is to ensure that the Grants and ProducerGrants proto are byte
compatible. A grant represents a request from a user
for obtaining the access specified in an entitlement
they are eligible for.
A grant represents a request from a
user for obtaining the access specified
in an entitlement they are eligible for.

"""
# Create or coerce a protobuf request object.
Expand Down Expand Up @@ -2217,10 +2213,8 @@ def sample_revoke_grant():
google.api_core.operation.Operation:
An object representing a long-running operation.

The result type for the operation will be :class:`google.cloud.privilegedaccessmanager_v1.types.Grant` This is to ensure that the Grants and ProducerGrants proto are byte
compatible. A grant represents a request from a user
for obtaining the access specified in an entitlement
they are eligible for.
The result type for the operation will be :class:`google.cloud.privilegedaccessmanager_v1.types.Grant` A grant represents a request from a user for obtaining the access specified
in an entitlement they are eligible for.

"""
# Create or coerce a protobuf request object.
Expand Down
16 changes: 8 additions & 8 deletions ...le/cloud/privilegedaccessmanager_v1/services/privileged_access_manager/transports/grpc.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -282,10 +282,9 @@ def check_onboarding_status(
]:
r"""Return a callable for the check onboarding status method over gRPC.

CheckOnboardingStatus reports the onboarding status
for a project/folder/organization. Any findings reported
by this API need to be fixed before PAM can be used on
the resource.
``CheckOnboardingStatus`` reports the onboarding status for a
project/folder/organization. Any findings reported by this API
need to be fixed before PAM can be used on the resource.

Returns:
Callable[[~.CheckOnboardingStatusRequest],
Expand Down Expand Up @@ -431,9 +430,9 @@ def delete_entitlement(
]:
r"""Return a callable for the delete entitlement method over gRPC.

Deletes a single entitlement. This method can only be
called when there are no in-progress
(ACTIVE/ACTIVATING/REVOKING) grants under the
Deletes a single entitlement. This method can only be called
when there are no in-progress
(``ACTIVE``/``ACTIVATING``/``REVOKING``) grants under the
entitlement.

Returns:
Expand Down Expand Up @@ -597,7 +596,8 @@ def create_grant(
]:
r"""Return a callable for the create grant method over gRPC.

Creates a new grant in a given project and location.
Creates a new grant in a given
project/folder/organization and location.

Returns:
Callable[[~.CreateGrantRequest],
Expand Down
16 changes: 8 additions & 8 deletions .../privilegedaccessmanager_v1/services/privileged_access_manager/transports/grpc_asyncio.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -292,10 +292,9 @@ def check_onboarding_status(
]:
r"""Return a callable for the check onboarding status method over gRPC.

CheckOnboardingStatus reports the onboarding status
for a project/folder/organization. Any findings reported
by this API need to be fixed before PAM can be used on
the resource.
``CheckOnboardingStatus`` reports the onboarding status for a
project/folder/organization. Any findings reported by this API
need to be fixed before PAM can be used on the resource.

Returns:
Callable[[~.CheckOnboardingStatusRequest],
Expand Down Expand Up @@ -443,9 +442,9 @@ def delete_entitlement(
]:
r"""Return a callable for the delete entitlement method over gRPC.

Deletes a single entitlement. This method can only be
called when there are no in-progress
(ACTIVE/ACTIVATING/REVOKING) grants under the
Deletes a single entitlement. This method can only be called
when there are no in-progress
(``ACTIVE``/``ACTIVATING``/``REVOKING``) grants under the
entitlement.

Returns:
Expand Down Expand Up @@ -612,7 +611,8 @@ def create_grant(
]:
r"""Return a callable for the create grant method over gRPC.

Creates a new grant in a given project and location.
Creates a new grant in a given
project/folder/organization and location.

Returns:
Callable[[~.CreateGrantRequest],
Expand Down
32 changes: 12 additions & 20 deletions ...le/cloud/privilegedaccessmanager_v1/services/privileged_access_manager/transports/rest.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -860,11 +860,9 @@ def __call__(

Returns:
~.privilegedaccessmanager.Grant:
This is to ensure that the ``Grants`` and
``ProducerGrants`` proto are byte compatible. A grant
represents a request from a user for obtaining the
access specified in an entitlement they are eligible
for.
A grant represents a request from a
user for obtaining the access specified
in an entitlement they are eligible for.

"""

Expand Down Expand Up @@ -1151,11 +1149,9 @@ def __call__(

Returns:
~.privilegedaccessmanager.Grant:
This is to ensure that the ``Grants`` and
``ProducerGrants`` proto are byte compatible. A grant
represents a request from a user for obtaining the
access specified in an entitlement they are eligible
for.
A grant represents a request from a
user for obtaining the access specified
in an entitlement they are eligible for.

"""

Expand Down Expand Up @@ -1345,11 +1341,9 @@ def __call__(

Returns:
~.privilegedaccessmanager.Grant:
This is to ensure that the ``Grants`` and
``ProducerGrants`` proto are byte compatible. A grant
represents a request from a user for obtaining the
access specified in an entitlement they are eligible
for.
A grant represents a request from a
user for obtaining the access specified
in an entitlement they are eligible for.

"""

Expand Down Expand Up @@ -1540,11 +1534,9 @@ def __call__(

Returns:
~.privilegedaccessmanager.Grant:
This is to ensure that the ``Grants`` and
``ProducerGrants`` proto are byte compatible. A grant
represents a request from a user for obtaining the
access specified in an entitlement they are eligible
for.
A grant represents a request from a
user for obtaining the access specified
in an entitlement they are eligible for.

"""

Expand Down
Loading
Loading