diff --git a/packages/google-cloud-privilegedaccessmanager/README.md b/packages/google-cloud-privilegedaccessmanager/README.md index 5e5ed9b4f52..7bc79ac4725 100644 --- a/packages/google-cloud-privilegedaccessmanager/README.md +++ b/packages/google-cloud-privilegedaccessmanager/README.md @@ -44,7 +44,7 @@ Google APIs Client Libraries, in [Client Libraries Explained][explained]. 1. [Select or create a Cloud Platform project][projects]. 1. [Enable billing for your project][billing]. 1. [Enable the Privileged Access Manager API API][enable_api]. -1. [Set up authentication with a service account][auth] so you can access the +1. [Set up authentication][auth] so you can access the API from your local workstation. ### Installing the client library @@ -201,4 +201,4 @@ See [LICENSE](https://github.com/googleapis/google-cloud-node/blob/main/LICENSE) [projects]: https://console.cloud.google.com/project [billing]: https://support.google.com/cloud/answer/6293499#enable-billing [enable_api]: https://console.cloud.google.com/flows/enableapi?apiid=privilegedaccessmanager.googleapis.com -[auth]: https://cloud.google.com/docs/authentication/getting-started +[auth]: https://cloud.google.com/docs/authentication/external/set-up-adc-local diff --git a/packages/google-cloud-privilegedaccessmanager/protos/google/cloud/privilegedaccessmanager/v1/privilegedaccessmanager.proto b/packages/google-cloud-privilegedaccessmanager/protos/google/cloud/privilegedaccessmanager/v1/privilegedaccessmanager.proto index 2d49ecb8560..8fbee23888c 100644 --- a/packages/google-cloud-privilegedaccessmanager/protos/google/cloud/privilegedaccessmanager/v1/privilegedaccessmanager.proto +++ b/packages/google-cloud-privilegedaccessmanager/protos/google/cloud/privilegedaccessmanager/v1/privilegedaccessmanager.proto @@ -67,7 +67,7 @@ service PrivilegedAccessManager { option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/cloud-platform"; - // 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. rpc CheckOnboardingStatus(CheckOnboardingStatusRequest) @@ -151,7 +151,7 @@ service PrivilegedAccessManager { } // 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. rpc DeleteEntitlement(DeleteEntitlementRequest) returns (google.longrunning.Operation) { @@ -254,7 +254,8 @@ service PrivilegedAccessManager { option (google.api.method_signature) = "name"; } - // Creates a new grant in a given project and location. + // Creates a new grant in a given project/folder/organization and + // location. rpc CreateGrant(CreateGrantRequest) returns (Grant) { option (google.api.http) = { post: "/v1/{parent=projects/*/locations/*/entitlements/*}/grants" @@ -411,7 +412,7 @@ message Entitlement { } } - // AdditionalNotificationTargets includes email addresses to be notified. + // `AdditionalNotificationTargets` includes email addresses to be notified. message AdditionalNotificationTargets { // Optional. Additional email addresses to be notified when a principal // (requester) is granted access. @@ -500,7 +501,7 @@ message Entitlement { string etag = 12; } -// AccessControlEntry is used to control who can do some operation. +// `AccessControlEntry` is used to control who can do some operation. message AccessControlEntry { // Optional. Users who are allowed for the operation. Each entry should be a // valid v1 IAM principal identifier. The format for these is documented at: @@ -564,11 +565,11 @@ message ManualApprovals { // Privileged access that this service can be used to gate. message PrivilegedAccess { - // 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. message GcpIamAccess { - // IAM Role bindings that are created after a successful grant. + // IAM role bindings that are created after a successful grant. message RoleBinding { // Required. IAM role to be granted. // https://cloud.google.com/iam/docs/roles-overview. @@ -736,7 +737,7 @@ message CreateEntitlementRequest { // 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). @@ -761,8 +762,7 @@ message DeleteEntitlementRequest { // 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). @@ -792,8 +792,6 @@ message UpdateEntitlementRequest { [(google.api.field_behavior) = REQUIRED]; } -// 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. message Grant { @@ -1210,7 +1208,7 @@ message CreateGrantRequest { // 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/packages/google-cloud-privilegedaccessmanager/protos/protos.json b/packages/google-cloud-privilegedaccessmanager/protos/protos.json index 5e273e1da01..ba760f5d664 100644 --- a/packages/google-cloud-privilegedaccessmanager/protos/protos.json +++ b/packages/google-cloud-privilegedaccessmanager/protos/protos.json @@ -1,4 +1,7 @@ { + "options": { + "syntax": "proto3" + }, "nested": { "google": { "nested": { diff --git a/packages/google-cloud-privilegedaccessmanager/samples/generated/v1/privileged_access_manager.create_entitlement.js b/packages/google-cloud-privilegedaccessmanager/samples/generated/v1/privileged_access_manager.create_entitlement.js index 6b9e55e569d..c9947780d43 100644 --- a/packages/google-cloud-privilegedaccessmanager/samples/generated/v1/privileged_access_manager.create_entitlement.js +++ b/packages/google-cloud-privilegedaccessmanager/samples/generated/v1/privileged_access_manager.create_entitlement.js @@ -59,7 +59,7 @@ function main(parent, entitlementId, entitlement) { * 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/packages/google-cloud-privilegedaccessmanager/samples/generated/v1/privileged_access_manager.create_grant.js b/packages/google-cloud-privilegedaccessmanager/samples/generated/v1/privileged_access_manager.create_grant.js index 97592f6d825..184b1f428b2 100644 --- a/packages/google-cloud-privilegedaccessmanager/samples/generated/v1/privileged_access_manager.create_grant.js +++ b/packages/google-cloud-privilegedaccessmanager/samples/generated/v1/privileged_access_manager.create_grant.js @@ -46,7 +46,7 @@ function main(parent, grant) { * 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/packages/google-cloud-privilegedaccessmanager/samples/generated/v1/privileged_access_manager.delete_entitlement.js b/packages/google-cloud-privilegedaccessmanager/samples/generated/v1/privileged_access_manager.delete_entitlement.js index 21ed4029ce8..e124db1c66b 100644 --- a/packages/google-cloud-privilegedaccessmanager/samples/generated/v1/privileged_access_manager.delete_entitlement.js +++ b/packages/google-cloud-privilegedaccessmanager/samples/generated/v1/privileged_access_manager.delete_entitlement.js @@ -40,8 +40,7 @@ function main(name) { * 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/packages/google-cloud-privilegedaccessmanager/samples/generated/v1/snippet_metadata_google.cloud.privilegedaccessmanager.v1.json b/packages/google-cloud-privilegedaccessmanager/samples/generated/v1/snippet_metadata_google.cloud.privilegedaccessmanager.v1.json index 1e6b0eec3d2..2f9bb1b2b68 100644 --- a/packages/google-cloud-privilegedaccessmanager/samples/generated/v1/snippet_metadata_google.cloud.privilegedaccessmanager.v1.json +++ b/packages/google-cloud-privilegedaccessmanager/samples/generated/v1/snippet_metadata_google.cloud.privilegedaccessmanager.v1.json @@ -15,7 +15,7 @@ "regionTag": "privilegedaccessmanager_v1_generated_PrivilegedAccessManager_CheckOnboardingStatus_async", "title": "PrivilegedAccessManager checkOnboardingStatus Sample", "origin": "API_DEFINITION", - "description": " 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.", + "description": " `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.", "canonical": true, "file": "privileged_access_manager.check_onboarding_status.js", "language": "JAVASCRIPT", @@ -259,14 +259,14 @@ "regionTag": "privilegedaccessmanager_v1_generated_PrivilegedAccessManager_DeleteEntitlement_async", "title": "PrivilegedAccessManager deleteEntitlement Sample", "origin": "API_DEFINITION", - "description": " Deletes a single entitlement. This method can only be called when there are no in-progress (ACTIVE/ACTIVATING/REVOKING) grants under the entitlement.", + "description": " Deletes a single entitlement. This method can only be called when there are no in-progress (`ACTIVE`/`ACTIVATING`/`REVOKING`) grants under the entitlement.", "canonical": true, "file": "privileged_access_manager.delete_entitlement.js", "language": "JAVASCRIPT", "segments": [ { "start": 25, - "end": 74, + "end": 73, "type": "FULL" } ], @@ -503,7 +503,7 @@ "regionTag": "privilegedaccessmanager_v1_generated_PrivilegedAccessManager_CreateGrant_async", "title": "PrivilegedAccessManager createGrant Sample", "origin": "API_DEFINITION", - "description": " Creates a new grant in a given project and location.", + "description": " Creates a new grant in a given project/folder/organization and location.", "canonical": true, "file": "privileged_access_manager.create_grant.js", "language": "JAVASCRIPT", diff --git a/packages/google-cloud-privilegedaccessmanager/src/v1/privileged_access_manager_client.ts b/packages/google-cloud-privilegedaccessmanager/src/v1/privileged_access_manager_client.ts index beacb23a91d..8b8d3777d0d 100644 --- a/packages/google-cloud-privilegedaccessmanager/src/v1/privileged_access_manager_client.ts +++ b/packages/google-cloud-privilegedaccessmanager/src/v1/privileged_access_manager_client.ts @@ -572,7 +572,7 @@ export class PrivilegedAccessManagerClient { // -- Service calls -- // ------------------- /** - * 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. * @@ -867,7 +867,8 @@ export class PrivilegedAccessManagerClient { return this.innerApiCalls.getGrant(request, options, callback); } /** - * Creates a new grant in a given project and location. + * Creates a new grant in a given project/folder/organization and + * location. * * @param {Object} request * The request object that will be sent. @@ -886,7 +887,7 @@ export class PrivilegedAccessManagerClient { * 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). @@ -1219,7 +1220,7 @@ export class PrivilegedAccessManagerClient { * 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). @@ -1354,7 +1355,7 @@ export class PrivilegedAccessManagerClient { } /** * 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 {Object} request @@ -1370,8 +1371,7 @@ export class PrivilegedAccessManagerClient { * 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).