Skip to content

Commit 03e1057

Browse files
gcf-owl-bot[bot]gcf-owl-bot[bot]
authored
docs: [google-cloud-privilegedaccessmanager] comment fixes (#13278)
- [ ] Regenerate this pull request now. PiperOrigin-RevId: 696243486 Source-Link: googleapis/googleapis@aa3dd2b Source-Link: googleapis/googleapis-gen@a794581 Copy-Tag: eyJwIjoicGFja2FnZXMvZ29vZ2xlLWNsb3VkLXByaXZpbGVnZWRhY2Nlc3NtYW5hZ2VyLy5Pd2xCb3QueWFtbCIsImgiOiJhNzk0NTgxZDJjNDRiNzBmYWEwMjRlZWVjZjZmMDVmMmNjM2JiNGI4In0= --------- Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com>
1 parent 28eb346 commit 03e1057

File tree

9 files changed

+84
-109
lines changed

9 files changed

+84
-109
lines changed

‎packages/google-cloud-privilegedaccessmanager/google/cloud/privilegedaccessmanager/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__ = "0.1.3" # {x-release-please-version}
16+
__version__ = "0.0.0" # {x-release-please-version}

‎packages/google-cloud-privilegedaccessmanager/google/cloud/privilegedaccessmanager_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__ = "0.1.3" # {x-release-please-version}
16+
__version__ = "0.0.0" # {x-release-please-version}

‎packages/google-cloud-privilegedaccessmanager/google/cloud/privilegedaccessmanager_v1/services/privileged_access_manager/async_client.py‎

Lines changed: 22 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -311,10 +311,9 @@ async def check_onboarding_status(
311311
timeout: Union[float, object] = gapic_v1.method.DEFAULT,
312312
metadata: Sequence[Tuple[str, str]] = (),
313313
) -> privilegedaccessmanager.CheckOnboardingStatusResponse:
314-
r"""CheckOnboardingStatus reports the onboarding status
315-
for a project/folder/organization. Any findings reported
316-
by this API need to be fixed before PAM can be used on
317-
the resource.
314+
r"""``CheckOnboardingStatus`` reports the onboarding status for a
315+
project/folder/organization. Any findings reported by this API
316+
need to be fixed before PAM can be used on the resource.
318317
319318
.. code-block:: python
320319
@@ -886,9 +885,9 @@ async def delete_entitlement(
886885
timeout: Union[float, object] = gapic_v1.method.DEFAULT,
887886
metadata: Sequence[Tuple[str, str]] = (),
888887
) -> operation_async.AsyncOperation:
889-
r"""Deletes a single entitlement. This method can only be
890-
called when there are no in-progress
891-
(ACTIVE/ACTIVATING/REVOKING) grants under the
888+
r"""Deletes a single entitlement. This method can only be called
889+
when there are no in-progress
890+
(``ACTIVE``/``ACTIVATING``/``REVOKING``) grants under the
892891
entitlement.
893892
894893
.. code-block:: python
@@ -1438,10 +1437,9 @@ async def sample_get_grant():
14381437
14391438
Returns:
14401439
google.cloud.privilegedaccessmanager_v1.types.Grant:
1441-
This is to ensure that the Grants and ProducerGrants proto are byte
1442-
compatible. A grant represents a request from a user
1443-
for obtaining the access specified in an entitlement
1444-
they are eligible for.
1440+
A grant represents a request from a
1441+
user for obtaining the access specified
1442+
in an entitlement they are eligible for.
14451443
14461444
"""
14471445
# Create or coerce a protobuf request object.
@@ -1502,7 +1500,8 @@ async def create_grant(
15021500
timeout: Union[float, object] = gapic_v1.method.DEFAULT,
15031501
metadata: Sequence[Tuple[str, str]] = (),
15041502
) -> privilegedaccessmanager.Grant:
1505-
r"""Creates a new grant in a given project and location.
1503+
r"""Creates a new grant in a given
1504+
project/folder/organization and location.
15061505
15071506
.. code-block:: python
15081507
@@ -1554,10 +1553,9 @@ async def sample_create_grant():
15541553
15551554
Returns:
15561555
google.cloud.privilegedaccessmanager_v1.types.Grant:
1557-
This is to ensure that the Grants and ProducerGrants proto are byte
1558-
compatible. A grant represents a request from a user
1559-
for obtaining the access specified in an entitlement
1560-
they are eligible for.
1556+
A grant represents a request from a
1557+
user for obtaining the access specified
1558+
in an entitlement they are eligible for.
15611559
15621560
"""
15631561
# Create or coerce a protobuf request object.
@@ -1659,10 +1657,9 @@ async def sample_approve_grant():
16591657
16601658
Returns:
16611659
google.cloud.privilegedaccessmanager_v1.types.Grant:
1662-
This is to ensure that the Grants and ProducerGrants proto are byte
1663-
compatible. A grant represents a request from a user
1664-
for obtaining the access specified in an entitlement
1665-
they are eligible for.
1660+
A grant represents a request from a
1661+
user for obtaining the access specified
1662+
in an entitlement they are eligible for.
16661663
16671664
"""
16681665
# Create or coerce a protobuf request object.
@@ -1746,10 +1743,9 @@ async def sample_deny_grant():
17461743
17471744
Returns:
17481745
google.cloud.privilegedaccessmanager_v1.types.Grant:
1749-
This is to ensure that the Grants and ProducerGrants proto are byte
1750-
compatible. A grant represents a request from a user
1751-
for obtaining the access specified in an entitlement
1752-
they are eligible for.
1746+
A grant represents a request from a
1747+
user for obtaining the access specified
1748+
in an entitlement they are eligible for.
17531749
17541750
"""
17551751
# Create or coerce a protobuf request object.
@@ -1841,10 +1837,8 @@ async def sample_revoke_grant():
18411837
google.api_core.operation_async.AsyncOperation:
18421838
An object representing a long-running operation.
18431839
1844-
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
1845-
compatible. A grant represents a request from a user
1846-
for obtaining the access specified in an entitlement
1847-
they are eligible for.
1840+
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
1841+
in an entitlement they are eligible for.
18481842
18491843
"""
18501844
# Create or coerce a protobuf request object.

‎packages/google-cloud-privilegedaccessmanager/google/cloud/privilegedaccessmanager_v1/services/privileged_access_manager/client.py‎

Lines changed: 22 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -721,10 +721,9 @@ def check_onboarding_status(
721721
timeout: Union[float, object] = gapic_v1.method.DEFAULT,
722722
metadata: Sequence[Tuple[str, str]] = (),
723723
) -> privilegedaccessmanager.CheckOnboardingStatusResponse:
724-
r"""CheckOnboardingStatus reports the onboarding status
725-
for a project/folder/organization. Any findings reported
726-
by this API need to be fixed before PAM can be used on
727-
the resource.
724+
r"""``CheckOnboardingStatus`` reports the onboarding status for a
725+
project/folder/organization. Any findings reported by this API
726+
need to be fixed before PAM can be used on the resource.
728727
729728
.. code-block:: python
730729
@@ -1283,9 +1282,9 @@ def delete_entitlement(
12831282
timeout: Union[float, object] = gapic_v1.method.DEFAULT,
12841283
metadata: Sequence[Tuple[str, str]] = (),
12851284
) -> operation.Operation:
1286-
r"""Deletes a single entitlement. This method can only be
1287-
called when there are no in-progress
1288-
(ACTIVE/ACTIVATING/REVOKING) grants under the
1285+
r"""Deletes a single entitlement. This method can only be called
1286+
when there are no in-progress
1287+
(``ACTIVE``/``ACTIVATING``/``REVOKING``) grants under the
12891288
entitlement.
12901289
12911290
.. code-block:: python
@@ -1824,10 +1823,9 @@ def sample_get_grant():
18241823
18251824
Returns:
18261825
google.cloud.privilegedaccessmanager_v1.types.Grant:
1827-
This is to ensure that the Grants and ProducerGrants proto are byte
1828-
compatible. A grant represents a request from a user
1829-
for obtaining the access specified in an entitlement
1830-
they are eligible for.
1826+
A grant represents a request from a
1827+
user for obtaining the access specified
1828+
in an entitlement they are eligible for.
18311829
18321830
"""
18331831
# Create or coerce a protobuf request object.
@@ -1885,7 +1883,8 @@ def create_grant(
18851883
timeout: Union[float, object] = gapic_v1.method.DEFAULT,
18861884
metadata: Sequence[Tuple[str, str]] = (),
18871885
) -> privilegedaccessmanager.Grant:
1888-
r"""Creates a new grant in a given project and location.
1886+
r"""Creates a new grant in a given
1887+
project/folder/organization and location.
18891888
18901889
.. code-block:: python
18911890
@@ -1937,10 +1936,9 @@ def sample_create_grant():
19371936
19381937
Returns:
19391938
google.cloud.privilegedaccessmanager_v1.types.Grant:
1940-
This is to ensure that the Grants and ProducerGrants proto are byte
1941-
compatible. A grant represents a request from a user
1942-
for obtaining the access specified in an entitlement
1943-
they are eligible for.
1939+
A grant represents a request from a
1940+
user for obtaining the access specified
1941+
in an entitlement they are eligible for.
19441942
19451943
"""
19461944
# Create or coerce a protobuf request object.
@@ -2039,10 +2037,9 @@ def sample_approve_grant():
20392037
20402038
Returns:
20412039
google.cloud.privilegedaccessmanager_v1.types.Grant:
2042-
This is to ensure that the Grants and ProducerGrants proto are byte
2043-
compatible. A grant represents a request from a user
2044-
for obtaining the access specified in an entitlement
2045-
they are eligible for.
2040+
A grant represents a request from a
2041+
user for obtaining the access specified
2042+
in an entitlement they are eligible for.
20462043
20472044
"""
20482045
# Create or coerce a protobuf request object.
@@ -2124,10 +2121,9 @@ def sample_deny_grant():
21242121
21252122
Returns:
21262123
google.cloud.privilegedaccessmanager_v1.types.Grant:
2127-
This is to ensure that the Grants and ProducerGrants proto are byte
2128-
compatible. A grant represents a request from a user
2129-
for obtaining the access specified in an entitlement
2130-
they are eligible for.
2124+
A grant represents a request from a
2125+
user for obtaining the access specified
2126+
in an entitlement they are eligible for.
21312127
21322128
"""
21332129
# Create or coerce a protobuf request object.
@@ -2217,10 +2213,8 @@ def sample_revoke_grant():
22172213
google.api_core.operation.Operation:
22182214
An object representing a long-running operation.
22192215
2220-
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
2221-
compatible. A grant represents a request from a user
2222-
for obtaining the access specified in an entitlement
2223-
they are eligible for.
2216+
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
2217+
in an entitlement they are eligible for.
22242218
22252219
"""
22262220
# Create or coerce a protobuf request object.

‎packages/google-cloud-privilegedaccessmanager/google/cloud/privilegedaccessmanager_v1/services/privileged_access_manager/transports/grpc.py‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -282,10 +282,9 @@ def check_onboarding_status(
282282
]:
283283
r"""Return a callable for the check onboarding status method over gRPC.
284284
285-
CheckOnboardingStatus reports the onboarding status
286-
for a project/folder/organization. Any findings reported
287-
by this API need to be fixed before PAM can be used on
288-
the resource.
285+
``CheckOnboardingStatus`` reports the onboarding status for a
286+
project/folder/organization. Any findings reported by this API
287+
need to be fixed before PAM can be used on the resource.
289288
290289
Returns:
291290
Callable[[~.CheckOnboardingStatusRequest],
@@ -431,9 +430,9 @@ def delete_entitlement(
431430
]:
432431
r"""Return a callable for the delete entitlement method over gRPC.
433432
434-
Deletes a single entitlement. This method can only be
435-
called when there are no in-progress
436-
(ACTIVE/ACTIVATING/REVOKING) grants under the
433+
Deletes a single entitlement. This method can only be called
434+
when there are no in-progress
435+
(``ACTIVE``/``ACTIVATING``/``REVOKING``) grants under the
437436
entitlement.
438437
439438
Returns:
@@ -597,7 +596,8 @@ def create_grant(
597596
]:
598597
r"""Return a callable for the create grant method over gRPC.
599598
600-
Creates a new grant in a given project and location.
599+
Creates a new grant in a given
600+
project/folder/organization and location.
601601
602602
Returns:
603603
Callable[[~.CreateGrantRequest],

‎packages/google-cloud-privilegedaccessmanager/google/cloud/privilegedaccessmanager_v1/services/privileged_access_manager/transports/grpc_asyncio.py‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -292,10 +292,9 @@ def check_onboarding_status(
292292
]:
293293
r"""Return a callable for the check onboarding status method over gRPC.
294294
295-
CheckOnboardingStatus reports the onboarding status
296-
for a project/folder/organization. Any findings reported
297-
by this API need to be fixed before PAM can be used on
298-
the resource.
295+
``CheckOnboardingStatus`` reports the onboarding status for a
296+
project/folder/organization. Any findings reported by this API
297+
need to be fixed before PAM can be used on the resource.
299298
300299
Returns:
301300
Callable[[~.CheckOnboardingStatusRequest],
@@ -443,9 +442,9 @@ def delete_entitlement(
443442
]:
444443
r"""Return a callable for the delete entitlement method over gRPC.
445444
446-
Deletes a single entitlement. This method can only be
447-
called when there are no in-progress
448-
(ACTIVE/ACTIVATING/REVOKING) grants under the
445+
Deletes a single entitlement. This method can only be called
446+
when there are no in-progress
447+
(``ACTIVE``/``ACTIVATING``/``REVOKING``) grants under the
449448
entitlement.
450449
451450
Returns:
@@ -612,7 +611,8 @@ def create_grant(
612611
]:
613612
r"""Return a callable for the create grant method over gRPC.
614613
615-
Creates a new grant in a given project and location.
614+
Creates a new grant in a given
615+
project/folder/organization and location.
616616
617617
Returns:
618618
Callable[[~.CreateGrantRequest],

‎packages/google-cloud-privilegedaccessmanager/google/cloud/privilegedaccessmanager_v1/services/privileged_access_manager/transports/rest.py‎

Lines changed: 12 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -860,11 +860,9 @@ def __call__(
860860
861861
Returns:
862862
~.privilegedaccessmanager.Grant:
863-
This is to ensure that the ``Grants`` and
864-
``ProducerGrants`` proto are byte compatible. A grant
865-
represents a request from a user for obtaining the
866-
access specified in an entitlement they are eligible
867-
for.
863+
A grant represents a request from a
864+
user for obtaining the access specified
865+
in an entitlement they are eligible for.
868866
869867
"""
870868

@@ -1151,11 +1149,9 @@ def __call__(
11511149
11521150
Returns:
11531151
~.privilegedaccessmanager.Grant:
1154-
This is to ensure that the ``Grants`` and
1155-
``ProducerGrants`` proto are byte compatible. A grant
1156-
represents a request from a user for obtaining the
1157-
access specified in an entitlement they are eligible
1158-
for.
1152+
A grant represents a request from a
1153+
user for obtaining the access specified
1154+
in an entitlement they are eligible for.
11591155
11601156
"""
11611157

@@ -1345,11 +1341,9 @@ def __call__(
13451341
13461342
Returns:
13471343
~.privilegedaccessmanager.Grant:
1348-
This is to ensure that the ``Grants`` and
1349-
``ProducerGrants`` proto are byte compatible. A grant
1350-
represents a request from a user for obtaining the
1351-
access specified in an entitlement they are eligible
1352-
for.
1344+
A grant represents a request from a
1345+
user for obtaining the access specified
1346+
in an entitlement they are eligible for.
13531347
13541348
"""
13551349

@@ -1540,11 +1534,9 @@ def __call__(
15401534
15411535
Returns:
15421536
~.privilegedaccessmanager.Grant:
1543-
This is to ensure that the ``Grants`` and
1544-
``ProducerGrants`` proto are byte compatible. A grant
1545-
represents a request from a user for obtaining the
1546-
access specified in an entitlement they are eligible
1547-
for.
1537+
A grant represents a request from a
1538+
user for obtaining the access specified
1539+
in an entitlement they are eligible for.
15481540
15491541
"""
15501542

0 commit comments

Comments
 (0)