From dba6b3214decb746f84153eac1013b5620b9d91c Mon Sep 17 00:00:00 2001 From: "gcf-owl-bot[bot]" <78513119+gcf-owl-bot[bot]@users.noreply.github.com> Date: Thu, 14 Nov 2024 15:41:08 -0500 Subject: [PATCH] chore: comment fixes (#7835) PiperOrigin-RevId: 696243486 Source-Link: https://github.com/googleapis/googleapis/commit/aa3dd2bc6cbb44fa75443ddf44e73b6d36a90766 Source-Link: https://github.com/googleapis/googleapis-gen/commit/a794581d2c44b70faa024eeecf6f05f2cc3bb4b8 Copy-Tag: eyJwIjoiUHJpdmlsZWdlZEFjY2Vzc01hbmFnZXIvLk93bEJvdC55YW1sIiwiaCI6ImE3OTQ1ODFkMmM0NGI3MGZhYTAyNGVlZWNmNmYwNWYyY2MzYmI0YjgifQ== --- .../check_onboarding_status.php | 2 +- .../PrivilegedAccessManagerClient/create_grant.php | 3 ++- .../delete_entitlement.php | 2 +- .../src/V1/AccessControlEntry.php | 2 +- .../src/V1/Client/PrivilegedAccessManagerClient.php | 7 ++++--- .../src/V1/CreateEntitlementRequest.php | 8 ++++---- .../src/V1/CreateGrantRequest.php | 8 ++++---- .../src/V1/DeleteEntitlementRequest.php | 12 ++++-------- .../V1/Entitlement/AdditionalNotificationTargets.php | 2 +- PrivilegedAccessManager/src/V1/Grant.php | 2 -- .../src/V1/PrivilegedAccess/GcpIamAccess.php | 2 +- .../V1/PrivilegedAccess/GcpIamAccess/RoleBinding.php | 2 +- 12 files changed, 24 insertions(+), 28 deletions(-) diff --git a/PrivilegedAccessManager/samples/V1/PrivilegedAccessManagerClient/check_onboarding_status.php b/PrivilegedAccessManager/samples/V1/PrivilegedAccessManagerClient/check_onboarding_status.php index 58e4d94a4920..27397e94e9e8 100644 --- a/PrivilegedAccessManager/samples/V1/PrivilegedAccessManagerClient/check_onboarding_status.php +++ b/PrivilegedAccessManager/samples/V1/PrivilegedAccessManagerClient/check_onboarding_status.php @@ -29,7 +29,7 @@ use Google\Cloud\PrivilegedAccessManager\V1\Client\PrivilegedAccessManagerClient; /** - * CheckOnboardingStatus reports the onboarding status for a + * `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. * diff --git a/PrivilegedAccessManager/samples/V1/PrivilegedAccessManagerClient/create_grant.php b/PrivilegedAccessManager/samples/V1/PrivilegedAccessManagerClient/create_grant.php index 7405217547bb..17db7704940b 100644 --- a/PrivilegedAccessManager/samples/V1/PrivilegedAccessManagerClient/create_grant.php +++ b/PrivilegedAccessManager/samples/V1/PrivilegedAccessManagerClient/create_grant.php @@ -30,7 +30,8 @@ use Google\Protobuf\Duration; /** - * Creates a new grant in a given project and location. + * Creates a new grant in a given project/folder/organization and + * location. * * @param string $formattedParent Name of the parent entitlement for which this grant is being * requested. Please see diff --git a/PrivilegedAccessManager/samples/V1/PrivilegedAccessManagerClient/delete_entitlement.php b/PrivilegedAccessManager/samples/V1/PrivilegedAccessManagerClient/delete_entitlement.php index 3c8ddb46103d..cd0537c801a5 100644 --- a/PrivilegedAccessManager/samples/V1/PrivilegedAccessManagerClient/delete_entitlement.php +++ b/PrivilegedAccessManager/samples/V1/PrivilegedAccessManagerClient/delete_entitlement.php @@ -32,7 +32,7 @@ /** * Deletes a single entitlement. This method can only be called when there - * are no in-progress (ACTIVE/ACTIVATING/REVOKING) grants under the + * are no in-progress (`ACTIVE`/`ACTIVATING`/`REVOKING`) grants under the * entitlement. * * @param string $formattedName Name of the resource. Please see diff --git a/PrivilegedAccessManager/src/V1/AccessControlEntry.php b/PrivilegedAccessManager/src/V1/AccessControlEntry.php index 9419f5da5c2c..cab2cd155887 100644 --- a/PrivilegedAccessManager/src/V1/AccessControlEntry.php +++ b/PrivilegedAccessManager/src/V1/AccessControlEntry.php @@ -9,7 +9,7 @@ use Google\Protobuf\Internal\GPBUtil; /** - * AccessControlEntry is used to control who can do some operation. + * `AccessControlEntry` is used to control who can do some operation. * * Generated from protobuf message google.cloud.privilegedaccessmanager.v1.AccessControlEntry */ diff --git a/PrivilegedAccessManager/src/V1/Client/PrivilegedAccessManagerClient.php b/PrivilegedAccessManager/src/V1/Client/PrivilegedAccessManagerClient.php index 20a78d8b3685..d8b494026c29 100644 --- a/PrivilegedAccessManager/src/V1/Client/PrivilegedAccessManagerClient.php +++ b/PrivilegedAccessManager/src/V1/Client/PrivilegedAccessManagerClient.php @@ -568,7 +568,7 @@ public function approveGrant(ApproveGrantRequest $request, array $callOptions = } /** - * CheckOnboardingStatus reports the onboarding status for a + * `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. * @@ -627,7 +627,8 @@ public function createEntitlement(CreateEntitlementRequest $request, array $call } /** - * Creates a new grant in a given project and location. + * Creates a new grant in a given project/folder/organization and + * location. * * The async variant is {@see PrivilegedAccessManagerClient::createGrantAsync()} . * @@ -654,7 +655,7 @@ public function createGrant(CreateGrantRequest $request, array $callOptions = [] /** * Deletes a single entitlement. This method can only be called when there - * are no in-progress (ACTIVE/ACTIVATING/REVOKING) grants under the + * are no in-progress (`ACTIVE`/`ACTIVATING`/`REVOKING`) grants under the * entitlement. * * The async variant is diff --git a/PrivilegedAccessManager/src/V1/CreateEntitlementRequest.php b/PrivilegedAccessManager/src/V1/CreateEntitlementRequest.php index 54f3056b3e14..0fdeca61930a 100644 --- a/PrivilegedAccessManager/src/V1/CreateEntitlementRequest.php +++ b/PrivilegedAccessManager/src/V1/CreateEntitlementRequest.php @@ -52,7 +52,7 @@ class CreateEntitlementRequest extends \Google\Protobuf\Internal\Message * ID, the server can check if original operation with the same request ID * was received, and if so, ignores the second request and returns the * previous operation's response. This prevents clients from accidentally - * creating duplicate commitments. + * creating duplicate entitlements. * The request ID must be a valid UUID with the exception that zero UUID is * not supported (00000000-0000-0000-0000-000000000000). * @@ -121,7 +121,7 @@ public static function build(string $parent, \Google\Cloud\PrivilegedAccessManag * ID, the server can check if original operation with the same request ID * was received, and if so, ignores the second request and returns the * previous operation's response. This prevents clients from accidentally - * creating duplicate commitments. + * creating duplicate entitlements. * The request ID must be a valid UUID with the exception that zero UUID is * not supported (00000000-0000-0000-0000-000000000000). * } @@ -247,7 +247,7 @@ public function setEntitlement($var) * ID, the server can check if original operation with the same request ID * was received, and if so, ignores the second request and returns the * previous operation's response. This prevents clients from accidentally - * creating duplicate commitments. + * creating duplicate entitlements. * The request ID must be a valid UUID with the exception that zero UUID is * not supported (00000000-0000-0000-0000-000000000000). * @@ -269,7 +269,7 @@ public function getRequestId() * ID, the server can check if original operation with the same request ID * was received, and if so, ignores the second request and returns the * previous operation's response. This prevents clients from accidentally - * creating duplicate commitments. + * creating duplicate entitlements. * The request ID must be a valid UUID with the exception that zero UUID is * not supported (00000000-0000-0000-0000-000000000000). * diff --git a/PrivilegedAccessManager/src/V1/CreateGrantRequest.php b/PrivilegedAccessManager/src/V1/CreateGrantRequest.php index 0580b8bed3f8..6f5feadca9b8 100644 --- a/PrivilegedAccessManager/src/V1/CreateGrantRequest.php +++ b/PrivilegedAccessManager/src/V1/CreateGrantRequest.php @@ -37,7 +37,7 @@ class CreateGrantRequest extends \Google\Protobuf\Internal\Message * request times out. If you make the request again with the same request * ID, the server can check if original operation with the same request ID * was received, and if so, ignores the second request. This prevents - * clients from accidentally creating duplicate commitments. + * clients from accidentally creating duplicate grants. * The request ID must be a valid UUID with the exception that zero UUID is * not supported (00000000-0000-0000-0000-000000000000). * @@ -82,7 +82,7 @@ public static function build(string $parent, \Google\Cloud\PrivilegedAccessManag * request times out. If you make the request again with the same request * ID, the server can check if original operation with the same request ID * was received, and if so, ignores the second request. This prevents - * clients from accidentally creating duplicate commitments. + * clients from accidentally creating duplicate grants. * The request ID must be a valid UUID with the exception that zero UUID is * not supported (00000000-0000-0000-0000-000000000000). * } @@ -165,7 +165,7 @@ public function setGrant($var) * request times out. If you make the request again with the same request * ID, the server can check if original operation with the same request ID * was received, and if so, ignores the second request. This prevents - * clients from accidentally creating duplicate commitments. + * clients from accidentally creating duplicate grants. * The request ID must be a valid UUID with the exception that zero UUID is * not supported (00000000-0000-0000-0000-000000000000). * @@ -186,7 +186,7 @@ public function getRequestId() * request times out. If you make the request again with the same request * ID, the server can check if original operation with the same request ID * was received, and if so, ignores the second request. This prevents - * clients from accidentally creating duplicate commitments. + * clients from accidentally creating duplicate grants. * The request ID must be a valid UUID with the exception that zero UUID is * not supported (00000000-0000-0000-0000-000000000000). * diff --git a/PrivilegedAccessManager/src/V1/DeleteEntitlementRequest.php b/PrivilegedAccessManager/src/V1/DeleteEntitlementRequest.php index e4bc56339a39..bc1fd4bf826d 100644 --- a/PrivilegedAccessManager/src/V1/DeleteEntitlementRequest.php +++ b/PrivilegedAccessManager/src/V1/DeleteEntitlementRequest.php @@ -29,8 +29,7 @@ class DeleteEntitlementRequest extends \Google\Protobuf\Internal\Message * For example, consider a situation where you make an initial request and the * request times out. If you make the request again with the same request * ID, the server can check if original operation with the same request ID - * was received, and if so, ignores the second request. This prevents - * clients from accidentally creating duplicate commitments. + * was received, and if so, ignores the second request. * The request ID must be a valid UUID with the exception that zero UUID is * not supported (00000000-0000-0000-0000-000000000000). * @@ -76,8 +75,7 @@ public static function build(string $name): self * For example, consider a situation where you make an initial request and the * request times out. If you make the request again with the same request * ID, the server can check if original operation with the same request ID - * was received, and if so, ignores the second request. This prevents - * clients from accidentally creating duplicate commitments. + * was received, and if so, ignores the second request. * The request ID must be a valid UUID with the exception that zero UUID is * not supported (00000000-0000-0000-0000-000000000000). * @type bool $force @@ -125,8 +123,7 @@ public function setName($var) * For example, consider a situation where you make an initial request and the * request times out. If you make the request again with the same request * ID, the server can check if original operation with the same request ID - * was received, and if so, ignores the second request. This prevents - * clients from accidentally creating duplicate commitments. + * was received, and if so, ignores the second request. * The request ID must be a valid UUID with the exception that zero UUID is * not supported (00000000-0000-0000-0000-000000000000). * @@ -146,8 +143,7 @@ public function getRequestId() * For example, consider a situation where you make an initial request and the * request times out. If you make the request again with the same request * ID, the server can check if original operation with the same request ID - * was received, and if so, ignores the second request. This prevents - * clients from accidentally creating duplicate commitments. + * was received, and if so, ignores the second request. * The request ID must be a valid UUID with the exception that zero UUID is * not supported (00000000-0000-0000-0000-000000000000). * diff --git a/PrivilegedAccessManager/src/V1/Entitlement/AdditionalNotificationTargets.php b/PrivilegedAccessManager/src/V1/Entitlement/AdditionalNotificationTargets.php index dc5e1a0bb02b..38729a396752 100644 --- a/PrivilegedAccessManager/src/V1/Entitlement/AdditionalNotificationTargets.php +++ b/PrivilegedAccessManager/src/V1/Entitlement/AdditionalNotificationTargets.php @@ -9,7 +9,7 @@ use Google\Protobuf\Internal\GPBUtil; /** - * AdditionalNotificationTargets includes email addresses to be notified. + * `AdditionalNotificationTargets` includes email addresses to be notified. * * Generated from protobuf message google.cloud.privilegedaccessmanager.v1.Entitlement.AdditionalNotificationTargets */ diff --git a/PrivilegedAccessManager/src/V1/Grant.php b/PrivilegedAccessManager/src/V1/Grant.php index aae478f8135b..a0a8bec28879 100644 --- a/PrivilegedAccessManager/src/V1/Grant.php +++ b/PrivilegedAccessManager/src/V1/Grant.php @@ -9,8 +9,6 @@ use Google\Protobuf\Internal\GPBUtil; /** - * 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. * diff --git a/PrivilegedAccessManager/src/V1/PrivilegedAccess/GcpIamAccess.php b/PrivilegedAccessManager/src/V1/PrivilegedAccess/GcpIamAccess.php index 455098388e75..af5837d3cfe0 100644 --- a/PrivilegedAccessManager/src/V1/PrivilegedAccess/GcpIamAccess.php +++ b/PrivilegedAccessManager/src/V1/PrivilegedAccess/GcpIamAccess.php @@ -9,7 +9,7 @@ use Google\Protobuf\Internal\GPBUtil; /** - * GcpIamAccess represents IAM based access control on a Google Cloud + * `GcpIamAccess` represents IAM based access control on a Google Cloud * resource. Refer to https://cloud.google.com/iam/docs to understand more * about IAM. * diff --git a/PrivilegedAccessManager/src/V1/PrivilegedAccess/GcpIamAccess/RoleBinding.php b/PrivilegedAccessManager/src/V1/PrivilegedAccess/GcpIamAccess/RoleBinding.php index 8f94cdb0d0ab..8e6dc341bbf5 100644 --- a/PrivilegedAccessManager/src/V1/PrivilegedAccess/GcpIamAccess/RoleBinding.php +++ b/PrivilegedAccessManager/src/V1/PrivilegedAccess/GcpIamAccess/RoleBinding.php @@ -9,7 +9,7 @@ use Google\Protobuf\Internal\GPBUtil; /** - * IAM Role bindings that are created after a successful grant. + * IAM role bindings that are created after a successful grant. * * Generated from protobuf message google.cloud.privilegedaccessmanager.v1.PrivilegedAccess.GcpIamAccess.RoleBinding */