From 1d510bef5bd7b0ac3552b4729ef3d9ebe1ac3dc4 Mon Sep 17 00:00:00 2001 From: "gcf-owl-bot[bot]" <78513119+gcf-owl-bot[bot]@users.noreply.github.com> Date: Fri, 28 Jul 2023 02:36:22 -0500 Subject: [PATCH] fix: [Many APIs] fix typings for IAM methods (#4459) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * fix: fix typings for IAM methods docs: fixed links in the generated Markdown documentation PiperOrigin-RevId: 551610576 Source-Link: https://github.com/googleapis/googleapis/commit/73b1313cbd1fd0cc1e22684bc89ee1b1a416cfe0 Source-Link: https://github.com/googleapis/googleapis-gen/commit/8bec066492a6da2855b1b8ce562664c0a6b30b01 Copy-Tag: eyJwIjoicGFja2FnZXMvZ29vZ2xlLWFpLWdlbmVyYXRpdmVsYW5ndWFnZS8uT3dsQm90LnlhbWwiLCJoIjoiOGJlYzA2NjQ5MmE2ZGEyODU1YjFiOGNlNTYyNjY0YzBhNmIzMGIwMSJ9 Copy-Tag: eyJwIjoicGFja2FnZXMvZ29vZ2xlLWFuYWx5dGljcy1kYXRhLy5Pd2xCb3QueWFtbCIsImgiOiI4YmVjMDY2NDkyYTZkYTI4NTViMWI4Y2U1NjI2NjRjMGE2YjMwYjAxIn0= Copy-Tag: eyJwIjoicGFja2FnZXMvZ29vZ2xlLWFwaS1hcGlrZXlzLy5Pd2xCb3QueWFtbCIsImgiOiI4YmVjMDY2NDkyYTZkYTI4NTViMWI4Y2U1NjI2NjRjMGE2YjMwYjAxIn0= Copy-Tag: eyJwIjoicGFja2FnZXMvZ29vZ2xlLWFwaS1zZXJ2aWNlY29udHJvbC8uT3dsQm90LnlhbWwiLCJoIjoiOGJlYzA2NjQ5MmE2ZGEyODU1YjFiOGNlNTYyNjY0YzBhNmIzMGIwMSJ9 Copy-Tag: eyJwIjoicGFja2FnZXMvZ29vZ2xlLWFwaS1zZXJ2aWNlbWFuYWdlbWVudC8uT3dsQm90LnlhbWwiLCJoIjoiOGJlYzA2NjQ5MmE2ZGEyODU1YjFiOGNlNTYyNjY0YzBhNmIzMGIwMSJ9 Copy-Tag: eyJwIjoicGFja2FnZXMvZ29vZ2xlLWFwaS1zZXJ2aWNldXNhZ2UvLk93bEJvdC55YW1sIiwiaCI6IjhiZWMwNjY0OTJhNmRhMjg1NWIxYjhjZTU2MjY2NGMwYTZiMzBiMDEifQ== Copy-Tag: eyJwIjoicGFja2FnZXMvZ29vZ2xlLWFwcGVuZ2luZS8uT3dsQm90LnlhbWwiLCJoIjoiOGJlYzA2NjQ5MmE2ZGEyODU1YjFiOGNlNTYyNjY0YzBhNmIzMGIwMSJ9 Copy-Tag: eyJwIjoicGFja2FnZXMvZ29vZ2xlLWFyZWExMjAtdGFibGVzLy5Pd2xCb3QueWFtbCIsImgiOiI4YmVjMDY2NDkyYTZkYTI4NTViMWI4Y2U1NjI2NjRjMGE2YjMwYjAxIn0= Copy-Tag: eyJwIjoicGFja2FnZXMvZ29vZ2xlLWNsb3VkLWFjY2Vzc2FwcHJvdmFsLy5Pd2xCb3QueWFtbCIsImgiOiI4YmVjMDY2NDkyYTZkYTI4NTViMWI4Y2U1NjI2NjRjMGE2YjMwYjAxIn0= Copy-Tag: eyJwIjoicGFja2FnZXMvZ29vZ2xlLWNsb3VkLWFkdmlzb3J5bm90aWZpY2F0aW9ucy8uT3dsQm90LnlhbWwiLCJoIjoiOGJlYzA2NjQ5MmE2ZGEyODU1YjFiOGNlNTYyNjY0YzBhNmIzMGIwMSJ9 Copy-Tag: eyJwIjoicGFja2FnZXMvZ29vZ2xlLWNsb3VkLWFsbG95ZGIvLk93bEJvdC55YW1sIiwiaCI6IjhiZWMwNjY0OTJhNmRhMjg1NWIxYjhjZTU2MjY2NGMwYTZiMzBiMDEifQ== Copy-Tag: eyJwIjoicGFja2FnZXMvZ29vZ2xlLWNsb3VkLWFwaWdhdGV3YXkvLk93bEJvdC55YW1sIiwiaCI6IjhiZWMwNjY0OTJhNmRhMjg1NWIxYjhjZTU2MjY2NGMwYTZiMzBiMDEifQ== Copy-Tag: eyJwIjoicGFja2FnZXMvZ29vZ2xlLWNsb3VkLWFwaWdlZWNvbm5lY3QvLk93bEJvdC55YW1sIiwiaCI6IjhiZWMwNjY0OTJhNmRhMjg1NWIxYjhjZTU2MjY2NGMwYTZiMzBiMDEifQ== Copy-Tag: eyJwIjoicGFja2FnZXMvZ29vZ2xlLWNsb3VkLWFzc2V0Ly5Pd2xCb3QueWFtbCIsImgiOiI4YmVjMDY2NDkyYTZkYTI4NTViMWI4Y2U1NjI2NjRjMGE2YjMwYjAxIn0= Copy-Tag: eyJwIjoicGFja2FnZXMvZ29vZ2xlLWNsb3VkLWFzc3VyZWR3b3JrbG9hZHMvLk93bEJvdC55YW1sIiwiaCI6IjhiZWMwNjY0OTJhNmRhMjg1NWIxYjhjZTU2MjY2NGMwYTZiMzBiMDEifQ== Copy-Tag: eyJwIjoicGFja2FnZXMvZ29vZ2xlLWNsb3VkLWJhcmVtZXRhbHNvbHV0aW9uLy5Pd2xCb3QueWFtbCIsImgiOiI4YmVjMDY2NDkyYTZkYTI4NTViMWI4Y2U1NjI2NjRjMGE2YjMwYjAxIn0= Copy-Tag: eyJwIjoicGFja2FnZXMvZ29vZ2xlLWNsb3VkLWJleW9uZGNvcnAtYXBwY29ubmVjdGlvbnMvLk93bEJvdC55YW1sIiwiaCI6IjhiZWMwNjY0OTJhNmRhMjg1NWIxYjhjZTU2MjY2NGMwYTZiMzBiMDEifQ== Copy-Tag: eyJwIjoicGFja2FnZXMvZ29vZ2xlLWNsb3VkLWJleW9uZGNvcnAtYXBwY29ubmVjdG9ycy8uT3dsQm90LnlhbWwiLCJoIjoiOGJlYzA2NjQ5MmE2ZGEyODU1YjFiOGNlNTYyNjY0YzBhNmIzMGIwMSJ9 Copy-Tag: eyJwIjoicGFja2FnZXMvZ29vZ2xlLWNsb3VkLWJleW9uZGNvcnAtYXBwZ2F0ZXdheXMvLk93bEJvdC55YW1sIiwiaCI6IjhiZWMwNjY0OTJhNmRhMjg1NWIxYjhjZTU2MjY2NGMwYTZiMzBiMDEifQ== Copy-Tag: eyJwIjoicGFja2FnZXMvZ29vZ2xlLWNsb3VkLWJleW9uZGNvcnAtY2xpZW50Y29ubmVjdG9yc2VydmljZXMvLk93bEJvdC55YW1sIiwiaCI6IjhiZWMwNjY0OTJhNmRhMjg1NWIxYjhjZTU2MjY2NGMwYTZiMzBiMDEifQ== * chore!: update to Node 14 * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md --------- Co-authored-by: Owl Bot Co-authored-by: Sofia Leon Co-authored-by: sofisl <55454395+sofisl@users.noreply.github.com> --- .../google-ai-generativelanguage/package.json | 13 +- ..._google.ai.generativelanguage.v1beta2.json | 319 ++++ .../v1beta2/text_service.generate_text.js | 4 +- .../samples/package.json | 4 +- .../src/v1beta2/discuss_service_client.ts | 10 +- .../src/v1beta2/model_service_client.ts | 22 +- .../src/v1beta2/text_service_client.ts | 10 +- packages/google-analytics-data/package.json | 11 +- .../alpha_analytics_data.run_funnel_report.js | 4 +- ...etadata_google.analytics.data.v1alpha.json | 271 +++ ..._analytics_data.batch_run_pivot_reports.js | 2 +- .../beta_analytics_data.batch_run_reports.js | 2 +- ...beta_analytics_data.check_compatibility.js | 4 +- .../beta_analytics_data.run_pivot_report.js | 8 +- ...beta_analytics_data.run_realtime_report.js | 10 +- .../v1beta/beta_analytics_data.run_report.js | 10 +- ...metadata_google.analytics.data.v1beta.json | 451 +++++ .../samples/package.json | 4 +- .../v1alpha/alpha_analytics_data_client.ts | 38 +- .../src/v1beta/beta_analytics_data_client.ts | 35 +- packages/google-api-apikeys/README.md | 23 +- packages/google-api-apikeys/package.json | 11 +- packages/google-api-apikeys/samples/README.md | 18 - ...nippet_metadata.google.api.apikeys.v2.json | 2 +- ...nippet_metadata_google.api.apikeys.v2.json | 363 ++++ .../google-api-apikeys/samples/package.json | 4 +- .../src/v2/api_keys_client.ts | 56 +- packages/google-api-apikeys/webpack.config.js | 2 +- .../google-api-servicecontrol/package.json | 11 +- .../generated/v1/service_controller.report.js | 2 +- ...metadata_google.api.servicecontrol.v1.json | 159 ++ .../generated/v2/service_controller.check.js | 2 +- .../generated/v2/service_controller.report.js | 2 +- ...metadata_google.api.servicecontrol.v2.json | 119 ++ .../samples/package.json | 2 +- .../src/v1/quota_controller_client.ts | 7 +- .../src/v1/service_controller_client.ts | 16 +- .../src/v2/service_controller_client.ts | 10 +- .../google-api-servicemanagement/package.json | 11 +- ...adata_google.api.servicemanagement.v1.json | 599 ++++++ .../samples/package.json | 2 +- .../src/v1/service_manager_client.ts | 138 +- packages/google-api-serviceusage/README.md | 57 +- packages/google-api-serviceusage/package.json | 11 +- .../google-api-serviceusage/samples/README.md | 18 - .../v1/service_usage.batch_enable_services.js | 2 +- .../v1/service_usage.batch_get_services.js | 2 +- ...t_metadata.google.api.serviceusage.v1.json | 2 +- ...t_metadata_google.api.serviceusage.v1.json | 283 +++ .../service_usage.batch_enable_services.js | 2 +- .../service_usage.create_admin_override.js | 2 +- .../service_usage.create_consumer_override.js | 2 +- .../service_usage.delete_admin_override.js | 2 +- .../service_usage.delete_consumer_override.js | 2 +- .../service_usage.import_admin_overrides.js | 2 +- ...service_usage.import_consumer_overrides.js | 2 +- .../service_usage.update_admin_override.js | 2 +- .../service_usage.update_consumer_override.js | 2 +- ...adata.google.api.serviceusage.v1beta1.json | 2 +- ...adata_google.api.serviceusage.v1beta1.json | 923 ++++++++++ .../samples/package.json | 2 +- .../src/v1/service_usage_client.ts | 45 +- .../src/v1beta1/service_usage_client.ts | 155 +- .../google-api-serviceusage/webpack.config.js | 2 +- packages/google-appengine/README.md | 75 +- packages/google-appengine/package.json | 11 +- packages/google-appengine/samples/README.md | 18 - .../v1/firewall.batch_update_ingress_rules.js | 2 +- .../snippet_metadata.google.appengine.v1.json | 2 +- .../snippet_metadata_google.appengine.v1.json | 1531 +++++++++++++++ .../google-appengine/samples/package.json | 2 +- .../src/v1/applications_client.ts | 23 +- .../src/v1/authorized_certificates_client.ts | 37 +- .../src/v1/authorized_domains_client.ts | 17 +- .../src/v1/domain_mappings_client.ts | 40 +- .../src/v1/firewall_client.ts | 42 +- .../src/v1/instances_client.ts | 34 +- .../src/v1/services_client.ts | 34 +- .../src/v1/versions_client.ts | 40 +- packages/google-appengine/webpack.config.js | 2 +- packages/google-area120-tables/README.md | 31 +- packages/google-area120-tables/package.json | 11 +- .../google-area120-tables/samples/README.md | 18 - ...tadata.google.area120.tables.v1alpha1.json | 2 +- ...tadata_google.area120.tables.v1alpha1.json | 551 ++++++ .../tables_service.batch_create_rows.js | 2 +- .../tables_service.batch_delete_rows.js | 2 +- .../tables_service.batch_update_rows.js | 2 +- .../samples/package.json | 4 +- .../src/v1alpha1/tables_service_client.ts | 102 +- .../google-area120-tables/webpack.config.js | 2 +- .../google-cloud-accessapproval/README.md | 25 +- .../google-cloud-accessapproval/package.json | 11 +- .../samples/README.md | 18 - ...tadata.google.cloud.accessapproval.v1.json | 2 +- ...tadata_google.cloud.accessapproval.v1.json | 395 ++++ .../samples/package.json | 4 +- .../src/v1/access_approval_client.ts | 59 +- .../README.md | 11 +- .../package.json | 11 +- .../samples/README.md | 18 - ...google.cloud.advisorynotifications.v1.json | 2 +- ...google.cloud.advisorynotifications.v1.json | 115 ++ .../samples/package.json | 4 +- .../advisory_notifications_service_client.ts | 22 +- packages/google-cloud-alloydb/package.json | 11 +- ...ppet_metadata_google.cloud.alloydb.v1.json | 1535 +++++++++++++++ ...metadata_google.cloud.alloydb.v1alpha.json | 1639 +++++++++++++++++ ..._metadata_google.cloud.alloydb.v1beta.json | 1635 ++++++++++++++++ .../google-cloud-alloydb/samples/package.json | 4 +- .../src/v1/alloy_d_b_admin_client.ts | 242 +-- .../src/v1alpha/alloy_d_b_admin_client.ts | 252 +-- .../src/v1beta/alloy_d_b_admin_client.ts | 252 +-- packages/google-cloud-apigateway/README.md | 37 +- packages/google-cloud-apigateway/package.json | 11 +- .../google-cloud-apigateway/samples/README.md | 18 - ...t_metadata.google.cloud.apigateway.v1.json | 2 +- ...t_metadata_google.cloud.apigateway.v1.json | 703 +++++++ .../samples/package.json | 4 +- .../src/v1/api_gateway_service_client.ts | 120 +- packages/google-cloud-apigeeconnect/README.md | 11 +- .../google-cloud-apigeeconnect/package.json | 11 +- .../samples/README.md | 18 - ...etadata.google.cloud.apigeeconnect.v1.json | 2 +- ...etadata_google.cloud.apigeeconnect.v1.json | 127 ++ .../samples/package.json | 2 +- .../src/v1/connection_service_client.ts | 17 +- .../src/v1/tether_client.ts | 7 +- packages/google-cloud-asset/package.json | 11 +- .../asset_service.batch_get_assets_history.js | 4 +- ...ervice.batch_get_effective_iam_policies.js | 2 +- .../v1/asset_service.export_assets.js | 4 +- .../generated/v1/asset_service.list_assets.js | 4 +- .../asset_service.search_all_iam_policies.js | 2 +- .../v1/asset_service.search_all_resources.js | 2 +- ...nippet_metadata_google.cloud.asset.v1.json | 1183 ++++++++++++ .../asset_service.search_all_resources.js | 2 +- ...metadata_google.cloud.asset.v1p1beta1.json | 127 ++ ...metadata_google.cloud.asset.v1p2beta1.json | 227 +++ .../v1p5beta1/asset_service.list_assets.js | 2 +- ...metadata_google.cloud.asset.v1p5beta1.json | 75 + .../v1p7beta1/asset_service.export_assets.js | 4 +- ...metadata_google.cloud.asset.v1p7beta1.json | 75 + .../google-cloud-asset/samples/package.json | 4 +- .../src/v1/asset_service_client.ts | 235 +-- .../src/v1p1beta1/asset_service_client.ts | 34 +- .../src/v1p2beta1/asset_service_client.ts | 25 +- .../src/v1p5beta1/asset_service_client.ts | 17 +- .../src/v1p7beta1/asset_service_client.ts | 10 +- .../google-cloud-assuredworkloads/README.md | 41 +- .../package.json | 11 +- .../samples/README.md | 18 - ...data.google.cloud.assuredworkloads.v1.json | 2 +- ...data_google.cloud.assuredworkloads.v1.json | 431 +++++ ...google.cloud.assuredworkloads.v1beta1.json | 2 +- ...google.cloud.assuredworkloads.v1beta1.json | 335 ++++ .../samples/package.json | 4 +- .../v1/assured_workloads_service_client.ts | 70 +- .../assured_workloads_service_client.ts | 48 +- .../google-cloud-baremetalsolution/README.md | 47 +- .../package.json | 11 +- .../samples/README.md | 18 - ...ata.google.cloud.baremetalsolution.v2.json | 2 +- ...ata_google.cloud.baremetalsolution.v2.json | 895 +++++++++ .../samples/package.json | 4 +- .../src/v2/bare_metal_solution_client.ts | 189 +- .../README.md | 19 +- .../package.json | 11 +- .../samples/README.md | 18 - ...le.cloud.beyondcorp.appconnections.v1.json | 2 +- ...le.cloud.beyondcorp.appconnections.v1.json | 323 ++++ .../samples/package.json | 4 +- .../src/v1/app_connections_service_client.ts | 91 +- .../README.md | 19 +- .../package.json | 11 +- .../samples/README.md | 18 - ...gle.cloud.beyondcorp.appconnectors.v1.json | 2 +- ...gle.cloud.beyondcorp.appconnectors.v1.json | 319 ++++ .../samples/package.json | 4 +- .../src/v1/app_connectors_service_client.ts | 74 +- .../README.md | 15 +- .../package.json | 11 +- .../samples/README.md | 18 - ...oogle.cloud.beyondcorp.appgateways.v1.json | 2 +- ...oogle.cloud.beyondcorp.appgateways.v1.json | 215 +++ .../samples/package.json | 4 +- .../src/v1/app_gateways_service_client.ts | 62 +- .../README.md | 27 +- .../package.json | 11 +- .../protos/protos.js | 2 +- .../samples/README.md | 18 - ...beyondcorp.clientconnectorservices.v1.json | 2 +- ...beyondcorp.clientconnectorservices.v1.json | 271 +++ .../samples/package.json | 4 +- ...lient_connector_services_service_client.ts | 62 +- .../system-test/install.ts | 34 +- 196 files changed, 17747 insertions(+), 2410 deletions(-) create mode 100644 packages/google-ai-generativelanguage/samples/generated/v1beta2/snippet_metadata_google.ai.generativelanguage.v1beta2.json create mode 100644 packages/google-analytics-data/samples/generated/v1alpha/snippet_metadata_google.analytics.data.v1alpha.json create mode 100644 packages/google-analytics-data/samples/generated/v1beta/snippet_metadata_google.analytics.data.v1beta.json create mode 100644 packages/google-api-apikeys/samples/generated/v2/snippet_metadata_google.api.apikeys.v2.json create mode 100644 packages/google-api-servicecontrol/samples/generated/v1/snippet_metadata_google.api.servicecontrol.v1.json create mode 100644 packages/google-api-servicecontrol/samples/generated/v2/snippet_metadata_google.api.servicecontrol.v2.json create mode 100644 packages/google-api-servicemanagement/samples/generated/v1/snippet_metadata_google.api.servicemanagement.v1.json create mode 100644 packages/google-api-serviceusage/samples/generated/v1/snippet_metadata_google.api.serviceusage.v1.json create mode 100644 packages/google-api-serviceusage/samples/generated/v1beta1/snippet_metadata_google.api.serviceusage.v1beta1.json create mode 100644 packages/google-appengine/samples/generated/v1/snippet_metadata_google.appengine.v1.json create mode 100644 packages/google-area120-tables/samples/generated/v1alpha1/snippet_metadata_google.area120.tables.v1alpha1.json create mode 100644 packages/google-cloud-accessapproval/samples/generated/v1/snippet_metadata_google.cloud.accessapproval.v1.json create mode 100644 packages/google-cloud-advisorynotifications/samples/generated/v1/snippet_metadata_google.cloud.advisorynotifications.v1.json create mode 100644 packages/google-cloud-alloydb/samples/generated/v1/snippet_metadata_google.cloud.alloydb.v1.json create mode 100644 packages/google-cloud-alloydb/samples/generated/v1alpha/snippet_metadata_google.cloud.alloydb.v1alpha.json create mode 100644 packages/google-cloud-alloydb/samples/generated/v1beta/snippet_metadata_google.cloud.alloydb.v1beta.json create mode 100644 packages/google-cloud-apigateway/samples/generated/v1/snippet_metadata_google.cloud.apigateway.v1.json create mode 100644 packages/google-cloud-apigeeconnect/samples/generated/v1/snippet_metadata_google.cloud.apigeeconnect.v1.json create mode 100644 packages/google-cloud-asset/samples/generated/v1/snippet_metadata_google.cloud.asset.v1.json create mode 100644 packages/google-cloud-asset/samples/generated/v1p1beta1/snippet_metadata_google.cloud.asset.v1p1beta1.json create mode 100644 packages/google-cloud-asset/samples/generated/v1p2beta1/snippet_metadata_google.cloud.asset.v1p2beta1.json create mode 100644 packages/google-cloud-asset/samples/generated/v1p5beta1/snippet_metadata_google.cloud.asset.v1p5beta1.json create mode 100644 packages/google-cloud-asset/samples/generated/v1p7beta1/snippet_metadata_google.cloud.asset.v1p7beta1.json create mode 100644 packages/google-cloud-assuredworkloads/samples/generated/v1/snippet_metadata_google.cloud.assuredworkloads.v1.json create mode 100644 packages/google-cloud-assuredworkloads/samples/generated/v1beta1/snippet_metadata_google.cloud.assuredworkloads.v1beta1.json create mode 100644 packages/google-cloud-baremetalsolution/samples/generated/v2/snippet_metadata_google.cloud.baremetalsolution.v2.json create mode 100644 packages/google-cloud-beyondcorp-appconnections/samples/generated/v1/snippet_metadata_google.cloud.beyondcorp.appconnections.v1.json create mode 100644 packages/google-cloud-beyondcorp-appconnectors/samples/generated/v1/snippet_metadata_google.cloud.beyondcorp.appconnectors.v1.json create mode 100644 packages/google-cloud-beyondcorp-appgateways/samples/generated/v1/snippet_metadata_google.cloud.beyondcorp.appgateways.v1.json create mode 100644 packages/google-cloud-beyondcorp-clientconnectorservices/samples/generated/v1/snippet_metadata_google.cloud.beyondcorp.clientconnectorservices.v1.json diff --git a/packages/google-ai-generativelanguage/package.json b/packages/google-ai-generativelanguage/package.json index ef82602c83f..617e26fa86f 100644 --- a/packages/google-ai-generativelanguage/package.json +++ b/packages/google-ai-generativelanguage/package.json @@ -44,29 +44,30 @@ "prelint": "cd samples; npm link ../; npm i" }, "dependencies": { - "google-gax": "^3.5.8" + "google-gax": "^4.0.3" }, "devDependencies": { "@types/mocha": "^9.0.0", - "@types/node": "^18.0.0", + "@types/node": "^20.4.5", "@types/sinon": "^10.0.0", "c8": "^7.3.5", - "gts": "^3.1.0", + "gapic-tools": "^0.1.8", + "gts": "^5.0.0", "jsdoc": "^4.0.0", "jsdoc-fresh": "^2.0.0", "jsdoc-region-tag": "^2.0.0", - "long": "^5.2.3", "linkinator": "4.1.2", + "long": "^5.2.3", "mocha": "^9.2.2", "null-loader": "^4.0.1", "pack-n-play": "^1.0.0-2", "sinon": "^15.0.0", "ts-loader": "^9.0.0", - "typescript": "^4.6.4", + "typescript": "^5.1.6", "webpack": "^5.9.0", "webpack-cli": "^5.0.0" }, "engines": { - "node": ">=12.0.0" + "node": ">=14.0.0" } } diff --git a/packages/google-ai-generativelanguage/samples/generated/v1beta2/snippet_metadata_google.ai.generativelanguage.v1beta2.json b/packages/google-ai-generativelanguage/samples/generated/v1beta2/snippet_metadata_google.ai.generativelanguage.v1beta2.json new file mode 100644 index 00000000000..671009e9a5a --- /dev/null +++ b/packages/google-ai-generativelanguage/samples/generated/v1beta2/snippet_metadata_google.ai.generativelanguage.v1beta2.json @@ -0,0 +1,319 @@ +{ + "clientLibrary": { + "name": "nodejs-generativelanguage", + "version": "0.2.1", + "language": "TYPESCRIPT", + "apis": [ + { + "id": "google.ai.generativelanguage.v1beta2", + "version": "v1beta2" + } + ] + }, + "snippets": [ + { + "regionTag": "generativelanguage_v1beta2_generated_DiscussService_GenerateMessage_async", + "title": "DiscussService generateMessage Sample", + "origin": "API_DEFINITION", + "description": " Generates a response from the model given an input `MessagePrompt`.", + "canonical": true, + "file": "discuss_service.generate_message.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 90, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GenerateMessage", + "fullName": "google.ai.generativelanguage.v1beta2.DiscussService.GenerateMessage", + "async": true, + "parameters": [ + { + "name": "model", + "type": "TYPE_STRING" + }, + { + "name": "prompt", + "type": ".google.ai.generativelanguage.v1beta2.MessagePrompt" + }, + { + "name": "temperature", + "type": "TYPE_FLOAT" + }, + { + "name": "candidate_count", + "type": "TYPE_INT32" + }, + { + "name": "top_p", + "type": "TYPE_FLOAT" + }, + { + "name": "top_k", + "type": "TYPE_INT32" + } + ], + "resultType": ".google.ai.generativelanguage.v1beta2.GenerateMessageResponse", + "client": { + "shortName": "DiscussServiceClient", + "fullName": "google.ai.generativelanguage.v1beta2.DiscussServiceClient" + }, + "method": { + "shortName": "GenerateMessage", + "fullName": "google.ai.generativelanguage.v1beta2.DiscussService.GenerateMessage", + "service": { + "shortName": "DiscussService", + "fullName": "google.ai.generativelanguage.v1beta2.DiscussService" + } + } + } + }, + { + "regionTag": "generativelanguage_v1beta2_generated_DiscussService_CountMessageTokens_async", + "title": "DiscussService countMessageTokens Sample", + "origin": "API_DEFINITION", + "description": " Runs a model's tokenizer on a string and returns the token count.", + "canonical": true, + "file": "discuss_service.count_message_tokens.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 61, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CountMessageTokens", + "fullName": "google.ai.generativelanguage.v1beta2.DiscussService.CountMessageTokens", + "async": true, + "parameters": [ + { + "name": "model", + "type": "TYPE_STRING" + }, + { + "name": "prompt", + "type": ".google.ai.generativelanguage.v1beta2.MessagePrompt" + } + ], + "resultType": ".google.ai.generativelanguage.v1beta2.CountMessageTokensResponse", + "client": { + "shortName": "DiscussServiceClient", + "fullName": "google.ai.generativelanguage.v1beta2.DiscussServiceClient" + }, + "method": { + "shortName": "CountMessageTokens", + "fullName": "google.ai.generativelanguage.v1beta2.DiscussService.CountMessageTokens", + "service": { + "shortName": "DiscussService", + "fullName": "google.ai.generativelanguage.v1beta2.DiscussService" + } + } + } + }, + { + "regionTag": "generativelanguage_v1beta2_generated_ModelService_GetModel_async", + "title": "DiscussService getModel Sample", + "origin": "API_DEFINITION", + "description": " Gets information about a specific Model.", + "canonical": true, + "file": "model_service.get_model.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 55, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetModel", + "fullName": "google.ai.generativelanguage.v1beta2.ModelService.GetModel", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.ai.generativelanguage.v1beta2.Model", + "client": { + "shortName": "ModelServiceClient", + "fullName": "google.ai.generativelanguage.v1beta2.ModelServiceClient" + }, + "method": { + "shortName": "GetModel", + "fullName": "google.ai.generativelanguage.v1beta2.ModelService.GetModel", + "service": { + "shortName": "ModelService", + "fullName": "google.ai.generativelanguage.v1beta2.ModelService" + } + } + } + }, + { + "regionTag": "generativelanguage_v1beta2_generated_ModelService_ListModels_async", + "title": "DiscussService listModels Sample", + "origin": "API_DEFINITION", + "description": " Lists models available through the API.", + "canonical": true, + "file": "model_service.list_models.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 66, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListModels", + "fullName": "google.ai.generativelanguage.v1beta2.ModelService.ListModels", + "async": true, + "parameters": [ + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.ai.generativelanguage.v1beta2.ListModelsResponse", + "client": { + "shortName": "ModelServiceClient", + "fullName": "google.ai.generativelanguage.v1beta2.ModelServiceClient" + }, + "method": { + "shortName": "ListModels", + "fullName": "google.ai.generativelanguage.v1beta2.ModelService.ListModels", + "service": { + "shortName": "ModelService", + "fullName": "google.ai.generativelanguage.v1beta2.ModelService" + } + } + } + }, + { + "regionTag": "generativelanguage_v1beta2_generated_TextService_GenerateText_async", + "title": "DiscussService generateText Sample", + "origin": "API_DEFINITION", + "description": " Generates a response from the model given an input message.", + "canonical": true, + "file": "text_service.generate_text.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 119, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GenerateText", + "fullName": "google.ai.generativelanguage.v1beta2.TextService.GenerateText", + "async": true, + "parameters": [ + { + "name": "model", + "type": "TYPE_STRING" + }, + { + "name": "prompt", + "type": ".google.ai.generativelanguage.v1beta2.TextPrompt" + }, + { + "name": "temperature", + "type": "TYPE_FLOAT" + }, + { + "name": "candidate_count", + "type": "TYPE_INT32" + }, + { + "name": "max_output_tokens", + "type": "TYPE_INT32" + }, + { + "name": "top_p", + "type": "TYPE_FLOAT" + }, + { + "name": "top_k", + "type": "TYPE_INT32" + }, + { + "name": "safety_settings", + "type": "TYPE_MESSAGE[]" + }, + { + "name": "stop_sequences", + "type": "TYPE_STRING[]" + } + ], + "resultType": ".google.ai.generativelanguage.v1beta2.GenerateTextResponse", + "client": { + "shortName": "TextServiceClient", + "fullName": "google.ai.generativelanguage.v1beta2.TextServiceClient" + }, + "method": { + "shortName": "GenerateText", + "fullName": "google.ai.generativelanguage.v1beta2.TextService.GenerateText", + "service": { + "shortName": "TextService", + "fullName": "google.ai.generativelanguage.v1beta2.TextService" + } + } + } + }, + { + "regionTag": "generativelanguage_v1beta2_generated_TextService_EmbedText_async", + "title": "DiscussService embedText Sample", + "origin": "API_DEFINITION", + "description": " Generates an embedding from the model given an input message.", + "canonical": true, + "file": "text_service.embed_text.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 59, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "EmbedText", + "fullName": "google.ai.generativelanguage.v1beta2.TextService.EmbedText", + "async": true, + "parameters": [ + { + "name": "model", + "type": "TYPE_STRING" + }, + { + "name": "text", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.ai.generativelanguage.v1beta2.EmbedTextResponse", + "client": { + "shortName": "TextServiceClient", + "fullName": "google.ai.generativelanguage.v1beta2.TextServiceClient" + }, + "method": { + "shortName": "EmbedText", + "fullName": "google.ai.generativelanguage.v1beta2.TextService.EmbedText", + "service": { + "shortName": "TextService", + "fullName": "google.ai.generativelanguage.v1beta2.TextService" + } + } + } + } + ] +} \ No newline at end of file diff --git a/packages/google-ai-generativelanguage/samples/generated/v1beta2/text_service.generate_text.js b/packages/google-ai-generativelanguage/samples/generated/v1beta2/text_service.generate_text.js index ab12633573c..8022e85cf21 100644 --- a/packages/google-ai-generativelanguage/samples/generated/v1beta2/text_service.generate_text.js +++ b/packages/google-ai-generativelanguage/samples/generated/v1beta2/text_service.generate_text.js @@ -90,13 +90,13 @@ function main(model, prompt) { * `SafetyCategory` provided in the list, the API will use the default safety * setting for that category. */ - // const safetySettings = 1234 + // const safetySettings = [1,2,3,4] /** * The set of character sequences (up to 5) that will stop output generation. * If specified, the API will stop at the first appearance of a stop * sequence. The stop sequence will not be included as part of the response. */ - // const stopSequences = 'abc123' + // const stopSequences = ['abc','def'] // Imports the Generativelanguage library const {TextServiceClient} = require('@google-ai/generativelanguage').v1beta2; diff --git a/packages/google-ai-generativelanguage/samples/package.json b/packages/google-ai-generativelanguage/samples/package.json index 6ce2387078e..cb0178a8d3c 100644 --- a/packages/google-ai-generativelanguage/samples/package.json +++ b/packages/google-ai-generativelanguage/samples/package.json @@ -4,7 +4,7 @@ "license": "Apache-2.0", "author": "Google LLC", "engines": { - "node": ">=12.0.0" + "node": ">=14.0.0" }, "files": [ "*.js" @@ -21,4 +21,4 @@ "chai": "^4.2.0", "mocha": "^8.0.0" } -} +} \ No newline at end of file diff --git a/packages/google-ai-generativelanguage/src/v1beta2/discuss_service_client.ts b/packages/google-ai-generativelanguage/src/v1beta2/discuss_service_client.ts index 8640108a1e9..ce58cc72f5e 100644 --- a/packages/google-ai-generativelanguage/src/v1beta2/discuss_service_client.ts +++ b/packages/google-ai-generativelanguage/src/v1beta2/discuss_service_client.ts @@ -359,9 +359,8 @@ export class DiscussServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.ai.generativelanguage.v1beta2.GenerateMessageResponse | GenerateMessageResponse}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.ai.generativelanguage.v1beta2.GenerateMessageResponse|GenerateMessageResponse}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1beta2/discuss_service.generate_message.js * region_tag:generativelanguage_v1beta2_generated_DiscussService_GenerateMessage_async @@ -463,9 +462,8 @@ export class DiscussServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.ai.generativelanguage.v1beta2.CountMessageTokensResponse | CountMessageTokensResponse}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.ai.generativelanguage.v1beta2.CountMessageTokensResponse|CountMessageTokensResponse}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1beta2/discuss_service.count_message_tokens.js * region_tag:generativelanguage_v1beta2_generated_DiscussService_CountMessageTokens_async diff --git a/packages/google-ai-generativelanguage/src/v1beta2/model_service_client.ts b/packages/google-ai-generativelanguage/src/v1beta2/model_service_client.ts index 90915238234..14b915d77b1 100644 --- a/packages/google-ai-generativelanguage/src/v1beta2/model_service_client.ts +++ b/packages/google-ai-generativelanguage/src/v1beta2/model_service_client.ts @@ -339,9 +339,8 @@ export class ModelServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.ai.generativelanguage.v1beta2.Model | Model}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.ai.generativelanguage.v1beta2.Model|Model}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1beta2/model_service.get_model.js * region_tag:generativelanguage_v1beta2_generated_ModelService_GetModel_async @@ -444,14 +443,13 @@ export class ModelServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.ai.generativelanguage.v1beta2.Model | Model}. + * The first element of the array is Array of {@link protos.google.ai.generativelanguage.v1beta2.Model|Model}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `listModelsAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listModels( @@ -547,13 +545,12 @@ export class ModelServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.ai.generativelanguage.v1beta2.Model | Model} on 'data' event. + * An object stream which emits an object representing {@link protos.google.ai.generativelanguage.v1beta2.Model|Model} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listModelsAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listModelsStream( @@ -598,12 +595,11 @@ export class ModelServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.ai.generativelanguage.v1beta2.Model | Model}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.ai.generativelanguage.v1beta2.Model|Model}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1beta2/model_service.list_models.js * region_tag:generativelanguage_v1beta2_generated_ModelService_ListModels_async diff --git a/packages/google-ai-generativelanguage/src/v1beta2/text_service_client.ts b/packages/google-ai-generativelanguage/src/v1beta2/text_service_client.ts index c34462470ff..22b77453f82 100644 --- a/packages/google-ai-generativelanguage/src/v1beta2/text_service_client.ts +++ b/packages/google-ai-generativelanguage/src/v1beta2/text_service_client.ts @@ -385,9 +385,8 @@ export class TextServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.ai.generativelanguage.v1beta2.GenerateTextResponse | GenerateTextResponse}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.ai.generativelanguage.v1beta2.GenerateTextResponse|GenerateTextResponse}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1beta2/text_service.generate_text.js * region_tag:generativelanguage_v1beta2_generated_TextService_GenerateText_async @@ -485,9 +484,8 @@ export class TextServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.ai.generativelanguage.v1beta2.EmbedTextResponse | EmbedTextResponse}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.ai.generativelanguage.v1beta2.EmbedTextResponse|EmbedTextResponse}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1beta2/text_service.embed_text.js * region_tag:generativelanguage_v1beta2_generated_TextService_EmbedText_async diff --git a/packages/google-analytics-data/package.json b/packages/google-analytics-data/package.json index 8334c8fe73c..cb979364b5f 100644 --- a/packages/google-analytics-data/package.json +++ b/packages/google-analytics-data/package.json @@ -45,14 +45,15 @@ "test": "c8 mocha build/test" }, "dependencies": { - "google-gax": "^3.5.8" + "google-gax": "^4.0.3" }, "devDependencies": { "@types/mocha": "^9.0.0", - "@types/node": "^18.0.0", + "@types/node": "^20.4.5", "@types/sinon": "^10.0.0", "c8": "^7.2.0", - "gts": "^3.1.0", + "gapic-tools": "^0.1.8", + "gts": "^5.0.0", "jsdoc": "^4.0.0", "jsdoc-fresh": "^2.0.0", "jsdoc-region-tag": "^2.0.0", @@ -63,12 +64,12 @@ "pack-n-play": "^1.0.0-2", "sinon": "^15.0.0", "ts-loader": "^9.0.0", - "typescript": "^4.6.4", + "typescript": "^5.1.6", "webpack": "^5.0.0", "webpack-cli": "^5.0.0" }, "engines": { - "node": ">=12.0.0" + "node": ">=14.0.0" }, "homepage": "https://github.com/googleapis/google-cloud-node/tree/main/packages/google-analytics-data" } diff --git a/packages/google-analytics-data/samples/generated/v1alpha/alpha_analytics_data.run_funnel_report.js b/packages/google-analytics-data/samples/generated/v1alpha/alpha_analytics_data.run_funnel_report.js index ebe7a2b1dee..dbd79b87c3b 100644 --- a/packages/google-analytics-data/samples/generated/v1alpha/alpha_analytics_data.run_funnel_report.js +++ b/packages/google-analytics-data/samples/generated/v1alpha/alpha_analytics_data.run_funnel_report.js @@ -44,7 +44,7 @@ function main() { * ranges overlap, the event data for the overlapping days is included in the * response rows for both date ranges. */ - // const dateRanges = 1234 + // const dateRanges = [1,2,3,4] /** * The configuration of this request's funnel. This funnel configuration is * required. @@ -82,7 +82,7 @@ function main() { * identified by its name. * The segments parameter is optional. Requests are limited to 4 segments. */ - // const segments = 1234 + // const segments = [1,2,3,4] /** * The number of rows to return. If unspecified, 10,000 rows are returned. The * API returns a maximum of 250,000 rows per request, no matter how many you diff --git a/packages/google-analytics-data/samples/generated/v1alpha/snippet_metadata_google.analytics.data.v1alpha.json b/packages/google-analytics-data/samples/generated/v1alpha/snippet_metadata_google.analytics.data.v1alpha.json new file mode 100644 index 00000000000..194dfc98955 --- /dev/null +++ b/packages/google-analytics-data/samples/generated/v1alpha/snippet_metadata_google.analytics.data.v1alpha.json @@ -0,0 +1,271 @@ +{ + "clientLibrary": { + "name": "nodejs-data", + "version": "3.3.0", + "language": "TYPESCRIPT", + "apis": [ + { + "id": "google.analytics.data.v1alpha", + "version": "v1alpha" + } + ] + }, + "snippets": [ + { + "regionTag": "analyticsdata_v1alpha_generated_AlphaAnalyticsData_RunFunnelReport_async", + "title": "AlphaAnalyticsData runFunnelReport Sample", + "origin": "API_DEFINITION", + "description": " Returns a customized funnel report of your Google Analytics event data. The data returned from the API is as a table with columns for the requested dimensions and metrics. Funnel exploration lets you visualize the steps your users take to complete a task and quickly see how well they are succeeding or failing at each step. For example, how do prospects become shoppers and then become buyers? How do one time buyers become repeat buyers? With this information, you can improve inefficient or abandoned customer journeys. To learn more, see [GA4 Funnel Explorations](https://support.google.com/analytics/answer/9327974). This method is introduced at alpha stability with the intention of gathering feedback on syntax and capabilities before entering beta. To give your feedback on this API, complete the [Google Analytics Data API Funnel Reporting Feedback](https://docs.google.com/forms/d/e/1FAIpQLSdwOlQDJAUoBiIgUZZ3S_Lwi8gr7Bb0k1jhvc-DEg7Rol3UjA/viewform).", + "canonical": true, + "file": "alpha_analytics_data.run_funnel_report.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 123, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "RunFunnelReport", + "fullName": "google.analytics.data.v1alpha.AlphaAnalyticsData.RunFunnelReport", + "async": true, + "parameters": [ + { + "name": "property", + "type": "TYPE_STRING" + }, + { + "name": "date_ranges", + "type": "TYPE_MESSAGE[]" + }, + { + "name": "funnel", + "type": ".google.analytics.data.v1alpha.Funnel" + }, + { + "name": "funnel_breakdown", + "type": ".google.analytics.data.v1alpha.FunnelBreakdown" + }, + { + "name": "funnel_next_action", + "type": ".google.analytics.data.v1alpha.FunnelNextAction" + }, + { + "name": "funnel_visualization_type", + "type": ".google.analytics.data.v1alpha.RunFunnelReportRequest.FunnelVisualizationType" + }, + { + "name": "segments", + "type": "TYPE_MESSAGE[]" + }, + { + "name": "limit", + "type": "TYPE_INT64" + }, + { + "name": "dimension_filter", + "type": ".google.analytics.data.v1alpha.FilterExpression" + }, + { + "name": "return_property_quota", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.analytics.data.v1alpha.RunFunnelReportResponse", + "client": { + "shortName": "AlphaAnalyticsDataClient", + "fullName": "google.analytics.data.v1alpha.AlphaAnalyticsDataClient" + }, + "method": { + "shortName": "RunFunnelReport", + "fullName": "google.analytics.data.v1alpha.AlphaAnalyticsData.RunFunnelReport", + "service": { + "shortName": "AlphaAnalyticsData", + "fullName": "google.analytics.data.v1alpha.AlphaAnalyticsData" + } + } + } + }, + { + "regionTag": "analyticsdata_v1alpha_generated_AlphaAnalyticsData_CreateAudienceList_async", + "title": "AlphaAnalyticsData createAudienceList Sample", + "origin": "API_DEFINITION", + "description": " Creates an audience list for later retrieval. This method quickly returns the audience list's resource name and initiates a long running asynchronous request to form an audience list. To list the users in an audience list, first create the audience list through this method and then send the audience resource name to the `QueryAudienceList` method. An audience list is a snapshot of the users currently in the audience at the time of audience list creation. Creating audience lists for one audience on different days will return different results as users enter and exit the audience. Audiences in Google Analytics 4 allow you to segment your users in the ways that are important to your business. To learn more, see https://support.google.com/analytics/answer/9267572. Audience lists contain the users in each audience.", + "canonical": true, + "file": "alpha_analytics_data.create_audience_list.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 60, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CreateAudienceList", + "fullName": "google.analytics.data.v1alpha.AlphaAnalyticsData.CreateAudienceList", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "audience_list", + "type": ".google.analytics.data.v1alpha.AudienceList" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "AlphaAnalyticsDataClient", + "fullName": "google.analytics.data.v1alpha.AlphaAnalyticsDataClient" + }, + "method": { + "shortName": "CreateAudienceList", + "fullName": "google.analytics.data.v1alpha.AlphaAnalyticsData.CreateAudienceList", + "service": { + "shortName": "AlphaAnalyticsData", + "fullName": "google.analytics.data.v1alpha.AlphaAnalyticsData" + } + } + } + }, + { + "regionTag": "analyticsdata_v1alpha_generated_AlphaAnalyticsData_QueryAudienceList_async", + "title": "AlphaAnalyticsData queryAudienceList Sample", + "origin": "API_DEFINITION", + "description": " Retrieves an audience list of users. After creating an audience, the users are not immediately available for listing. First, a request to `CreateAudienceList` is necessary to create an audience list of users, and then second, this method is used to retrieve the users in the audience. Audiences in Google Analytics 4 allow you to segment your users in the ways that are important to your business. To learn more, see https://support.google.com/analytics/answer/9267572.", + "canonical": true, + "file": "alpha_analytics_data.query_audience_list.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 73, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "QueryAudienceList", + "fullName": "google.analytics.data.v1alpha.AlphaAnalyticsData.QueryAudienceList", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + }, + { + "name": "offset", + "type": "TYPE_INT64" + }, + { + "name": "limit", + "type": "TYPE_INT64" + } + ], + "resultType": ".google.analytics.data.v1alpha.QueryAudienceListResponse", + "client": { + "shortName": "AlphaAnalyticsDataClient", + "fullName": "google.analytics.data.v1alpha.AlphaAnalyticsDataClient" + }, + "method": { + "shortName": "QueryAudienceList", + "fullName": "google.analytics.data.v1alpha.AlphaAnalyticsData.QueryAudienceList", + "service": { + "shortName": "AlphaAnalyticsData", + "fullName": "google.analytics.data.v1alpha.AlphaAnalyticsData" + } + } + } + }, + { + "regionTag": "analyticsdata_v1alpha_generated_AlphaAnalyticsData_GetAudienceList_async", + "title": "AlphaAnalyticsData getAudienceList Sample", + "origin": "API_DEFINITION", + "description": " Gets configuration metadata about a specific audience list. This method can be used to understand an audience list after it has been created.", + "canonical": true, + "file": "alpha_analytics_data.get_audience_list.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 54, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetAudienceList", + "fullName": "google.analytics.data.v1alpha.AlphaAnalyticsData.GetAudienceList", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.analytics.data.v1alpha.AudienceList", + "client": { + "shortName": "AlphaAnalyticsDataClient", + "fullName": "google.analytics.data.v1alpha.AlphaAnalyticsDataClient" + }, + "method": { + "shortName": "GetAudienceList", + "fullName": "google.analytics.data.v1alpha.AlphaAnalyticsData.GetAudienceList", + "service": { + "shortName": "AlphaAnalyticsData", + "fullName": "google.analytics.data.v1alpha.AlphaAnalyticsData" + } + } + } + }, + { + "regionTag": "analyticsdata_v1alpha_generated_AlphaAnalyticsData_ListAudienceLists_async", + "title": "AlphaAnalyticsData listAudienceLists Sample", + "origin": "API_DEFINITION", + "description": " Lists all audience lists for a property. This method can be used for you to find and reuse existing audience lists rather than creating unnecessary new audience lists. The same audience can have multiple audience lists that represent the list of users that were in an audience on different days.", + "canonical": true, + "file": "alpha_analytics_data.list_audience_lists.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 70, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListAudienceLists", + "fullName": "google.analytics.data.v1alpha.AlphaAnalyticsData.ListAudienceLists", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.analytics.data.v1alpha.ListAudienceListsResponse", + "client": { + "shortName": "AlphaAnalyticsDataClient", + "fullName": "google.analytics.data.v1alpha.AlphaAnalyticsDataClient" + }, + "method": { + "shortName": "ListAudienceLists", + "fullName": "google.analytics.data.v1alpha.AlphaAnalyticsData.ListAudienceLists", + "service": { + "shortName": "AlphaAnalyticsData", + "fullName": "google.analytics.data.v1alpha.AlphaAnalyticsData" + } + } + } + } + ] +} \ No newline at end of file diff --git a/packages/google-analytics-data/samples/generated/v1beta/beta_analytics_data.batch_run_pivot_reports.js b/packages/google-analytics-data/samples/generated/v1beta/beta_analytics_data.batch_run_pivot_reports.js index 3bcb210d10d..d4931f639f0 100644 --- a/packages/google-analytics-data/samples/generated/v1beta/beta_analytics_data.batch_run_pivot_reports.js +++ b/packages/google-analytics-data/samples/generated/v1beta/beta_analytics_data.batch_run_pivot_reports.js @@ -43,7 +43,7 @@ function main() { * Individual requests. Each request has a separate pivot report response. * Each batch request is allowed up to 5 requests. */ - // const requests = 1234 + // const requests = [1,2,3,4] // Imports the Data library const {BetaAnalyticsDataClient} = require('@google-analytics/data').v1beta; diff --git a/packages/google-analytics-data/samples/generated/v1beta/beta_analytics_data.batch_run_reports.js b/packages/google-analytics-data/samples/generated/v1beta/beta_analytics_data.batch_run_reports.js index 25e3f17cb88..025c6cb7dad 100644 --- a/packages/google-analytics-data/samples/generated/v1beta/beta_analytics_data.batch_run_reports.js +++ b/packages/google-analytics-data/samples/generated/v1beta/beta_analytics_data.batch_run_reports.js @@ -43,7 +43,7 @@ function main() { * Individual requests. Each request has a separate report response. Each * batch request is allowed up to 5 requests. */ - // const requests = 1234 + // const requests = [1,2,3,4] // Imports the Data library const {BetaAnalyticsDataClient} = require('@google-analytics/data').v1beta; diff --git a/packages/google-analytics-data/samples/generated/v1beta/beta_analytics_data.check_compatibility.js b/packages/google-analytics-data/samples/generated/v1beta/beta_analytics_data.check_compatibility.js index 564dedd59d1..d9a5f4b193f 100644 --- a/packages/google-analytics-data/samples/generated/v1beta/beta_analytics_data.check_compatibility.js +++ b/packages/google-analytics-data/samples/generated/v1beta/beta_analytics_data.check_compatibility.js @@ -43,12 +43,12 @@ function main() { * The dimensions in this report. `dimensions` should be the same value as in * your `runReport` request. */ - // const dimensions = 1234 + // const dimensions = [1,2,3,4] /** * The metrics in this report. `metrics` should be the same value as in your * `runReport` request. */ - // const metrics = 1234 + // const metrics = [1,2,3,4] /** * The filter clause of dimensions. `dimensionFilter` should be the same value * as in your `runReport` request. diff --git a/packages/google-analytics-data/samples/generated/v1beta/beta_analytics_data.run_pivot_report.js b/packages/google-analytics-data/samples/generated/v1beta/beta_analytics_data.run_pivot_report.js index 3a5362f4949..00cbbdb48d5 100644 --- a/packages/google-analytics-data/samples/generated/v1beta/beta_analytics_data.run_pivot_report.js +++ b/packages/google-analytics-data/samples/generated/v1beta/beta_analytics_data.run_pivot_report.js @@ -42,13 +42,13 @@ function main() { * The dimensions requested. All defined dimensions must be used by one of the * following: dimension_expression, dimension_filter, pivots, order_bys. */ - // const dimensions = 1234 + // const dimensions = [1,2,3,4] /** * The metrics requested, at least one metric needs to be specified. All * defined metrics must be used by one of the following: metric_expression, * metric_filter, order_bys. */ - // const metrics = 1234 + // const metrics = [1,2,3,4] /** * The date range to retrieve event data for the report. If multiple date * ranges are specified, event data from each date range is used in the @@ -56,14 +56,14 @@ function main() { * a Pivot's field names; if included, the report compares between date * ranges. In a cohort request, this `dateRanges` must be unspecified. */ - // const dateRanges = 1234 + // const dateRanges = [1,2,3,4] /** * Describes the visual format of the report's dimensions in columns or rows. * The union of the fieldNames (dimension names) in all pivots must be a * subset of dimension names defined in Dimensions. No two pivots can share a * dimension. A dimension is only visible if it appears in a pivot. */ - // const pivots = 1234 + // const pivots = [1,2,3,4] /** * The filter clause of dimensions. Dimensions must be requested to be used in * this filter. Metrics cannot be used in this filter. diff --git a/packages/google-analytics-data/samples/generated/v1beta/beta_analytics_data.run_realtime_report.js b/packages/google-analytics-data/samples/generated/v1beta/beta_analytics_data.run_realtime_report.js index bc70f4ac0d2..d495ecb6220 100644 --- a/packages/google-analytics-data/samples/generated/v1beta/beta_analytics_data.run_realtime_report.js +++ b/packages/google-analytics-data/samples/generated/v1beta/beta_analytics_data.run_realtime_report.js @@ -39,11 +39,11 @@ function main() { /** * The dimensions requested and displayed. */ - // const dimensions = 1234 + // const dimensions = [1,2,3,4] /** * The metrics requested and displayed. */ - // const metrics = 1234 + // const metrics = [1,2,3,4] /** * The filter clause of dimensions. Metrics cannot be used in this filter. */ @@ -68,11 +68,11 @@ function main() { * Aggregation of metrics. Aggregated metric values will be shown in rows * where the dimension_values are set to "RESERVED_(MetricAggregation)". */ - // const metricAggregations = 1234 + // const metricAggregations = [1,2,3,4] /** * Specifies how rows are ordered in the response. */ - // const orderBys = 1234 + // const orderBys = [1,2,3,4] /** * Toggles whether to return the current state of this Analytics Property's * Realtime quota. Quota is returned in PropertyQuota (#PropertyQuota). @@ -85,7 +85,7 @@ function main() { * If two minute ranges overlap, the event data for the overlapping minutes is * included in the response rows for both minute ranges. */ - // const minuteRanges = 1234 + // const minuteRanges = [1,2,3,4] // Imports the Data library const {BetaAnalyticsDataClient} = require('@google-analytics/data').v1beta; diff --git a/packages/google-analytics-data/samples/generated/v1beta/beta_analytics_data.run_report.js b/packages/google-analytics-data/samples/generated/v1beta/beta_analytics_data.run_report.js index 0828aae6928..4dc34064da1 100644 --- a/packages/google-analytics-data/samples/generated/v1beta/beta_analytics_data.run_report.js +++ b/packages/google-analytics-data/samples/generated/v1beta/beta_analytics_data.run_report.js @@ -41,11 +41,11 @@ function main() { /** * The dimensions requested and displayed. */ - // const dimensions = 1234 + // const dimensions = [1,2,3,4] /** * The metrics requested and displayed. */ - // const metrics = 1234 + // const metrics = [1,2,3,4] /** * Date ranges of data to read. If multiple date ranges are requested, each * response row will contain a zero based date range index. If two date @@ -53,7 +53,7 @@ function main() { * response rows for both date ranges. In a cohort request, this `dateRanges` * must be unspecified. */ - // const dateRanges = 1234 + // const dateRanges = [1,2,3,4] /** * Dimension filters allow you to ask for only specific dimension values in * the report. To learn more, see Fundamentals of Dimension @@ -93,11 +93,11 @@ function main() { * Aggregation of metrics. Aggregated metric values will be shown in rows * where the dimension_values are set to "RESERVED_(MetricAggregation)". */ - // const metricAggregations = 1234 + // const metricAggregations = [1,2,3,4] /** * Specifies how rows are ordered in the response. */ - // const orderBys = 1234 + // const orderBys = [1,2,3,4] /** * A currency code in ISO4217 format, such as "AED", "USD", "JPY". * If the field is empty, the report uses the property's default currency. diff --git a/packages/google-analytics-data/samples/generated/v1beta/snippet_metadata_google.analytics.data.v1beta.json b/packages/google-analytics-data/samples/generated/v1beta/snippet_metadata_google.analytics.data.v1beta.json new file mode 100644 index 00000000000..a8397dc8e2d --- /dev/null +++ b/packages/google-analytics-data/samples/generated/v1beta/snippet_metadata_google.analytics.data.v1beta.json @@ -0,0 +1,451 @@ +{ + "clientLibrary": { + "name": "nodejs-data", + "version": "3.3.0", + "language": "TYPESCRIPT", + "apis": [ + { + "id": "google.analytics.data.v1beta", + "version": "v1beta" + } + ] + }, + "snippets": [ + { + "regionTag": "analyticsdata_v1beta_generated_BetaAnalyticsData_RunReport_async", + "title": "BetaAnalyticsData runReport Sample", + "origin": "API_DEFINITION", + "description": " Returns a customized report of your Google Analytics event data. Reports contain statistics derived from data collected by the Google Analytics tracking code. The data returned from the API is as a table with columns for the requested dimensions and metrics. Metrics are individual measurements of user activity on your property, such as active users or event count. Dimensions break down metrics across some common criteria, such as country or event name. For a guide to constructing requests & understanding responses, see [Creating a Report](https://developers.google.com/analytics/devguides/reporting/data/v1/basics).", + "canonical": true, + "file": "beta_analytics_data.run_report.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 139, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "RunReport", + "fullName": "google.analytics.data.v1beta.BetaAnalyticsData.RunReport", + "async": true, + "parameters": [ + { + "name": "property", + "type": "TYPE_STRING" + }, + { + "name": "dimensions", + "type": "TYPE_MESSAGE[]" + }, + { + "name": "metrics", + "type": "TYPE_MESSAGE[]" + }, + { + "name": "date_ranges", + "type": "TYPE_MESSAGE[]" + }, + { + "name": "dimension_filter", + "type": ".google.analytics.data.v1beta.FilterExpression" + }, + { + "name": "metric_filter", + "type": ".google.analytics.data.v1beta.FilterExpression" + }, + { + "name": "offset", + "type": "TYPE_INT64" + }, + { + "name": "limit", + "type": "TYPE_INT64" + }, + { + "name": "metric_aggregations", + "type": "TYPE_ENUM[]" + }, + { + "name": "order_bys", + "type": "TYPE_MESSAGE[]" + }, + { + "name": "currency_code", + "type": "TYPE_STRING" + }, + { + "name": "cohort_spec", + "type": ".google.analytics.data.v1beta.CohortSpec" + }, + { + "name": "keep_empty_rows", + "type": "TYPE_BOOL" + }, + { + "name": "return_property_quota", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.analytics.data.v1beta.RunReportResponse", + "client": { + "shortName": "BetaAnalyticsDataClient", + "fullName": "google.analytics.data.v1beta.BetaAnalyticsDataClient" + }, + "method": { + "shortName": "RunReport", + "fullName": "google.analytics.data.v1beta.BetaAnalyticsData.RunReport", + "service": { + "shortName": "BetaAnalyticsData", + "fullName": "google.analytics.data.v1beta.BetaAnalyticsData" + } + } + } + }, + { + "regionTag": "analyticsdata_v1beta_generated_BetaAnalyticsData_RunPivotReport_async", + "title": "BetaAnalyticsData runPivotReport Sample", + "origin": "API_DEFINITION", + "description": " Returns a customized pivot report of your Google Analytics event data. Pivot reports are more advanced and expressive formats than regular reports. In a pivot report, dimensions are only visible if they are included in a pivot. Multiple pivots can be specified to further dissect your data.", + "canonical": true, + "file": "beta_analytics_data.run_pivot_report.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 116, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "RunPivotReport", + "fullName": "google.analytics.data.v1beta.BetaAnalyticsData.RunPivotReport", + "async": true, + "parameters": [ + { + "name": "property", + "type": "TYPE_STRING" + }, + { + "name": "dimensions", + "type": "TYPE_MESSAGE[]" + }, + { + "name": "metrics", + "type": "TYPE_MESSAGE[]" + }, + { + "name": "date_ranges", + "type": "TYPE_MESSAGE[]" + }, + { + "name": "pivots", + "type": "TYPE_MESSAGE[]" + }, + { + "name": "dimension_filter", + "type": ".google.analytics.data.v1beta.FilterExpression" + }, + { + "name": "metric_filter", + "type": ".google.analytics.data.v1beta.FilterExpression" + }, + { + "name": "currency_code", + "type": "TYPE_STRING" + }, + { + "name": "cohort_spec", + "type": ".google.analytics.data.v1beta.CohortSpec" + }, + { + "name": "keep_empty_rows", + "type": "TYPE_BOOL" + }, + { + "name": "return_property_quota", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.analytics.data.v1beta.RunPivotReportResponse", + "client": { + "shortName": "BetaAnalyticsDataClient", + "fullName": "google.analytics.data.v1beta.BetaAnalyticsDataClient" + }, + "method": { + "shortName": "RunPivotReport", + "fullName": "google.analytics.data.v1beta.BetaAnalyticsData.RunPivotReport", + "service": { + "shortName": "BetaAnalyticsData", + "fullName": "google.analytics.data.v1beta.BetaAnalyticsData" + } + } + } + }, + { + "regionTag": "analyticsdata_v1beta_generated_BetaAnalyticsData_BatchRunReports_async", + "title": "BetaAnalyticsData batchRunReports Sample", + "origin": "API_DEFINITION", + "description": " Returns multiple reports in a batch. All reports must be for the same GA4 Property.", + "canonical": true, + "file": "beta_analytics_data.batch_run_reports.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 64, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "BatchRunReports", + "fullName": "google.analytics.data.v1beta.BetaAnalyticsData.BatchRunReports", + "async": true, + "parameters": [ + { + "name": "property", + "type": "TYPE_STRING" + }, + { + "name": "requests", + "type": "TYPE_MESSAGE[]" + } + ], + "resultType": ".google.analytics.data.v1beta.BatchRunReportsResponse", + "client": { + "shortName": "BetaAnalyticsDataClient", + "fullName": "google.analytics.data.v1beta.BetaAnalyticsDataClient" + }, + "method": { + "shortName": "BatchRunReports", + "fullName": "google.analytics.data.v1beta.BetaAnalyticsData.BatchRunReports", + "service": { + "shortName": "BetaAnalyticsData", + "fullName": "google.analytics.data.v1beta.BetaAnalyticsData" + } + } + } + }, + { + "regionTag": "analyticsdata_v1beta_generated_BetaAnalyticsData_BatchRunPivotReports_async", + "title": "BetaAnalyticsData batchRunPivotReports Sample", + "origin": "API_DEFINITION", + "description": " Returns multiple pivot reports in a batch. All reports must be for the same GA4 Property.", + "canonical": true, + "file": "beta_analytics_data.batch_run_pivot_reports.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 64, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "BatchRunPivotReports", + "fullName": "google.analytics.data.v1beta.BetaAnalyticsData.BatchRunPivotReports", + "async": true, + "parameters": [ + { + "name": "property", + "type": "TYPE_STRING" + }, + { + "name": "requests", + "type": "TYPE_MESSAGE[]" + } + ], + "resultType": ".google.analytics.data.v1beta.BatchRunPivotReportsResponse", + "client": { + "shortName": "BetaAnalyticsDataClient", + "fullName": "google.analytics.data.v1beta.BetaAnalyticsDataClient" + }, + "method": { + "shortName": "BatchRunPivotReports", + "fullName": "google.analytics.data.v1beta.BetaAnalyticsData.BatchRunPivotReports", + "service": { + "shortName": "BetaAnalyticsData", + "fullName": "google.analytics.data.v1beta.BetaAnalyticsData" + } + } + } + }, + { + "regionTag": "analyticsdata_v1beta_generated_BetaAnalyticsData_GetMetadata_async", + "title": "BetaAnalyticsData getMetadata Sample", + "origin": "API_DEFINITION", + "description": " Returns metadata for dimensions and metrics available in reporting methods. Used to explore the dimensions and metrics. In this method, a Google Analytics GA4 Property Identifier is specified in the request, and the metadata response includes Custom dimensions and metrics as well as Universal metadata. For example if a custom metric with parameter name `levels_unlocked` is registered to a property, the Metadata response will contain `customEvent:levels_unlocked`. Universal metadata are dimensions and metrics applicable to any property such as `country` and `totalUsers`.", + "canonical": true, + "file": "beta_analytics_data.get_metadata.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 61, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetMetadata", + "fullName": "google.analytics.data.v1beta.BetaAnalyticsData.GetMetadata", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.analytics.data.v1beta.Metadata", + "client": { + "shortName": "BetaAnalyticsDataClient", + "fullName": "google.analytics.data.v1beta.BetaAnalyticsDataClient" + }, + "method": { + "shortName": "GetMetadata", + "fullName": "google.analytics.data.v1beta.BetaAnalyticsData.GetMetadata", + "service": { + "shortName": "BetaAnalyticsData", + "fullName": "google.analytics.data.v1beta.BetaAnalyticsData" + } + } + } + }, + { + "regionTag": "analyticsdata_v1beta_generated_BetaAnalyticsData_RunRealtimeReport_async", + "title": "BetaAnalyticsData runRealtimeReport Sample", + "origin": "API_DEFINITION", + "description": " Returns a customized report of realtime event data for your property. Events appear in realtime reports seconds after they have been sent to the Google Analytics. Realtime reports show events and usage data for the periods of time ranging from the present moment to 30 minutes ago (up to 60 minutes for Google Analytics 360 properties). For a guide to constructing realtime requests & understanding responses, see [Creating a Realtime Report](https://developers.google.com/analytics/devguides/reporting/data/v1/realtime-basics).", + "canonical": true, + "file": "beta_analytics_data.run_realtime_report.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 106, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "RunRealtimeReport", + "fullName": "google.analytics.data.v1beta.BetaAnalyticsData.RunRealtimeReport", + "async": true, + "parameters": [ + { + "name": "property", + "type": "TYPE_STRING" + }, + { + "name": "dimensions", + "type": "TYPE_MESSAGE[]" + }, + { + "name": "metrics", + "type": "TYPE_MESSAGE[]" + }, + { + "name": "dimension_filter", + "type": ".google.analytics.data.v1beta.FilterExpression" + }, + { + "name": "metric_filter", + "type": ".google.analytics.data.v1beta.FilterExpression" + }, + { + "name": "limit", + "type": "TYPE_INT64" + }, + { + "name": "metric_aggregations", + "type": "TYPE_ENUM[]" + }, + { + "name": "order_bys", + "type": "TYPE_MESSAGE[]" + }, + { + "name": "return_property_quota", + "type": "TYPE_BOOL" + }, + { + "name": "minute_ranges", + "type": "TYPE_MESSAGE[]" + } + ], + "resultType": ".google.analytics.data.v1beta.RunRealtimeReportResponse", + "client": { + "shortName": "BetaAnalyticsDataClient", + "fullName": "google.analytics.data.v1beta.BetaAnalyticsDataClient" + }, + "method": { + "shortName": "RunRealtimeReport", + "fullName": "google.analytics.data.v1beta.BetaAnalyticsData.RunRealtimeReport", + "service": { + "shortName": "BetaAnalyticsData", + "fullName": "google.analytics.data.v1beta.BetaAnalyticsData" + } + } + } + }, + { + "regionTag": "analyticsdata_v1beta_generated_BetaAnalyticsData_CheckCompatibility_async", + "title": "BetaAnalyticsData checkCompatibility Sample", + "origin": "API_DEFINITION", + "description": " This compatibility method lists dimensions and metrics that can be added to a report request and maintain compatibility. This method fails if the request's dimensions and metrics are incompatible. In Google Analytics, reports fail if they request incompatible dimensions and/or metrics; in that case, you will need to remove dimensions and/or metrics from the incompatible report until the report is compatible. The Realtime and Core reports have different compatibility rules. This method checks compatibility for Core reports.", + "canonical": true, + "file": "beta_analytics_data.check_compatibility.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 85, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CheckCompatibility", + "fullName": "google.analytics.data.v1beta.BetaAnalyticsData.CheckCompatibility", + "async": true, + "parameters": [ + { + "name": "property", + "type": "TYPE_STRING" + }, + { + "name": "dimensions", + "type": "TYPE_MESSAGE[]" + }, + { + "name": "metrics", + "type": "TYPE_MESSAGE[]" + }, + { + "name": "dimension_filter", + "type": ".google.analytics.data.v1beta.FilterExpression" + }, + { + "name": "metric_filter", + "type": ".google.analytics.data.v1beta.FilterExpression" + }, + { + "name": "compatibility_filter", + "type": ".google.analytics.data.v1beta.Compatibility" + } + ], + "resultType": ".google.analytics.data.v1beta.CheckCompatibilityResponse", + "client": { + "shortName": "BetaAnalyticsDataClient", + "fullName": "google.analytics.data.v1beta.BetaAnalyticsDataClient" + }, + "method": { + "shortName": "CheckCompatibility", + "fullName": "google.analytics.data.v1beta.BetaAnalyticsData.CheckCompatibility", + "service": { + "shortName": "BetaAnalyticsData", + "fullName": "google.analytics.data.v1beta.BetaAnalyticsData" + } + } + } + } + ] +} \ No newline at end of file diff --git a/packages/google-analytics-data/samples/package.json b/packages/google-analytics-data/samples/package.json index 93f5c6447a7..0a89106b9ac 100644 --- a/packages/google-analytics-data/samples/package.json +++ b/packages/google-analytics-data/samples/package.json @@ -4,7 +4,7 @@ "license": "Apache-2.0", "author": "Google LLC", "engines": { - "node": ">=12.0.0" + "node": ">=14.0.0" }, "files": [ "*.js" @@ -27,4 +27,4 @@ "chai": "^4.2.0", "mocha": "^8.0.0" } -} +} \ No newline at end of file diff --git a/packages/google-analytics-data/src/v1alpha/alpha_analytics_data_client.ts b/packages/google-analytics-data/src/v1alpha/alpha_analytics_data_client.ts index c8158b67c41..40ff68f8604 100644 --- a/packages/google-analytics-data/src/v1alpha/alpha_analytics_data_client.ts +++ b/packages/google-analytics-data/src/v1alpha/alpha_analytics_data_client.ts @@ -458,9 +458,8 @@ export class AlphaAnalyticsDataClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.analytics.data.v1alpha.RunFunnelReportResponse | RunFunnelReportResponse}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.analytics.data.v1alpha.RunFunnelReportResponse|RunFunnelReportResponse}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1alpha/alpha_analytics_data.run_funnel_report.js * region_tag:analyticsdata_v1alpha_generated_AlphaAnalyticsData_RunFunnelReport_async @@ -577,9 +576,8 @@ export class AlphaAnalyticsDataClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.analytics.data.v1alpha.QueryAudienceListResponse | QueryAudienceListResponse}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.analytics.data.v1alpha.QueryAudienceListResponse|QueryAudienceListResponse}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1alpha/alpha_analytics_data.query_audience_list.js * region_tag:analyticsdata_v1alpha_generated_AlphaAnalyticsData_QueryAudienceList_async @@ -676,9 +674,8 @@ export class AlphaAnalyticsDataClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.analytics.data.v1alpha.AudienceList | AudienceList}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.analytics.data.v1alpha.AudienceList|AudienceList}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1alpha/alpha_analytics_data.get_audience_list.js * region_tag:analyticsdata_v1alpha_generated_AlphaAnalyticsData_GetAudienceList_async @@ -788,8 +785,7 @@ export class AlphaAnalyticsDataClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1alpha/alpha_analytics_data.create_audience_list.js * region_tag:analyticsdata_v1alpha_generated_AlphaAnalyticsData_CreateAudienceList_async @@ -884,8 +880,7 @@ export class AlphaAnalyticsDataClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1alpha/alpha_analytics_data.create_audience_list.js * region_tag:analyticsdata_v1alpha_generated_AlphaAnalyticsData_CreateAudienceList_async @@ -938,14 +933,13 @@ export class AlphaAnalyticsDataClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.analytics.data.v1alpha.AudienceList | AudienceList}. + * The first element of the array is Array of {@link protos.google.analytics.data.v1alpha.AudienceList|AudienceList}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `listAudienceListsAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listAudienceLists( @@ -1044,13 +1038,12 @@ export class AlphaAnalyticsDataClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.analytics.data.v1alpha.AudienceList | AudienceList} on 'data' event. + * An object stream which emits an object representing {@link protos.google.analytics.data.v1alpha.AudienceList|AudienceList} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listAudienceListsAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listAudienceListsStream( @@ -1098,12 +1091,11 @@ export class AlphaAnalyticsDataClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.analytics.data.v1alpha.AudienceList | AudienceList}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.analytics.data.v1alpha.AudienceList|AudienceList}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1alpha/alpha_analytics_data.list_audience_lists.js * region_tag:analyticsdata_v1alpha_generated_AlphaAnalyticsData_ListAudienceLists_async diff --git a/packages/google-analytics-data/src/v1beta/beta_analytics_data_client.ts b/packages/google-analytics-data/src/v1beta/beta_analytics_data_client.ts index 08530abe0ad..b2971f2a757 100644 --- a/packages/google-analytics-data/src/v1beta/beta_analytics_data_client.ts +++ b/packages/google-analytics-data/src/v1beta/beta_analytics_data_client.ts @@ -410,9 +410,8 @@ export class BetaAnalyticsDataClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.analytics.data.v1beta.RunReportResponse | RunReportResponse}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.analytics.data.v1beta.RunReportResponse|RunReportResponse}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1beta/beta_analytics_data.run_report.js * region_tag:analyticsdata_v1beta_generated_BetaAnalyticsData_RunReport_async @@ -544,9 +543,8 @@ export class BetaAnalyticsDataClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.analytics.data.v1beta.RunPivotReportResponse | RunPivotReportResponse}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.analytics.data.v1beta.RunPivotReportResponse|RunPivotReportResponse}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1beta/beta_analytics_data.run_pivot_report.js * region_tag:analyticsdata_v1beta_generated_BetaAnalyticsData_RunPivotReport_async @@ -647,9 +645,8 @@ export class BetaAnalyticsDataClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.analytics.data.v1beta.BatchRunReportsResponse | BatchRunReportsResponse}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.analytics.data.v1beta.BatchRunReportsResponse|BatchRunReportsResponse}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1beta/beta_analytics_data.batch_run_reports.js * region_tag:analyticsdata_v1beta_generated_BetaAnalyticsData_BatchRunReports_async @@ -750,9 +747,8 @@ export class BetaAnalyticsDataClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.analytics.data.v1beta.BatchRunPivotReportsResponse | BatchRunPivotReportsResponse}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.analytics.data.v1beta.BatchRunPivotReportsResponse|BatchRunPivotReportsResponse}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1beta/beta_analytics_data.batch_run_pivot_reports.js * region_tag:analyticsdata_v1beta_generated_BetaAnalyticsData_BatchRunPivotReports_async @@ -866,9 +862,8 @@ export class BetaAnalyticsDataClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.analytics.data.v1beta.Metadata | Metadata}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.analytics.data.v1beta.Metadata|Metadata}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1beta/beta_analytics_data.get_metadata.js * region_tag:analyticsdata_v1beta_generated_BetaAnalyticsData_GetMetadata_async @@ -1003,9 +998,8 @@ export class BetaAnalyticsDataClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.analytics.data.v1beta.RunRealtimeReportResponse | RunRealtimeReportResponse}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.analytics.data.v1beta.RunRealtimeReportResponse|RunRealtimeReportResponse}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1beta/beta_analytics_data.run_realtime_report.js * region_tag:analyticsdata_v1beta_generated_BetaAnalyticsData_RunRealtimeReport_async @@ -1128,9 +1122,8 @@ export class BetaAnalyticsDataClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.analytics.data.v1beta.CheckCompatibilityResponse | CheckCompatibilityResponse}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.analytics.data.v1beta.CheckCompatibilityResponse|CheckCompatibilityResponse}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1beta/beta_analytics_data.check_compatibility.js * region_tag:analyticsdata_v1beta_generated_BetaAnalyticsData_CheckCompatibility_async diff --git a/packages/google-api-apikeys/README.md b/packages/google-api-apikeys/README.md index dc0202a428c..3963be4b37f 100644 --- a/packages/google-api-apikeys/README.md +++ b/packages/google-api-apikeys/README.md @@ -2,7 +2,7 @@ [//]: # "To regenerate it, use `python -m synthtool`." Google Cloud Platform logo -# [API Keys API: Node.js Client](https://github.com/googleapis/google-cloud-node) +# [API Keys API: Node.js Client](https://github.com/googleapis/google-cloud-node/tree/main/packages/google-api-apikeys) [![release level](https://img.shields.io/badge/release%20level-preview-yellow.svg?style=flat)](https://cloud.google.com/terms/launch-stages) [![npm version](https://img.shields.io/npm/v/@google-cloud/apikeys.svg)](https://www.npmjs.org/package/@google-cloud/apikeys) @@ -108,20 +108,19 @@ callListKeys(); ## Samples -Samples are in the [`samples/`](https://github.com/googleapis/google-cloud-node/tree/main/samples) directory. Each sample's `README.md` has instructions for running its sample. +Samples are in the [`samples/`](https://github.com/googleapis/google-cloud-node/tree/main/packages/google-api-apikeys/samples) directory. Each sample's `README.md` has instructions for running its sample. | Sample | Source Code | Try it | | --------------------------- | --------------------------------- | ------ | -| Api_keys.create_key | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-api-apikeys/samples/generated/v2/api_keys.create_key.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-api-apikeys/samples/generated/v2/api_keys.create_key.js,samples/README.md) | -| Api_keys.delete_key | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-api-apikeys/samples/generated/v2/api_keys.delete_key.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-api-apikeys/samples/generated/v2/api_keys.delete_key.js,samples/README.md) | -| Api_keys.get_key | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-api-apikeys/samples/generated/v2/api_keys.get_key.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-api-apikeys/samples/generated/v2/api_keys.get_key.js,samples/README.md) | -| Api_keys.get_key_string | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-api-apikeys/samples/generated/v2/api_keys.get_key_string.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-api-apikeys/samples/generated/v2/api_keys.get_key_string.js,samples/README.md) | -| Api_keys.list_keys | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-api-apikeys/samples/generated/v2/api_keys.list_keys.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-api-apikeys/samples/generated/v2/api_keys.list_keys.js,samples/README.md) | -| Api_keys.lookup_key | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-api-apikeys/samples/generated/v2/api_keys.lookup_key.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-api-apikeys/samples/generated/v2/api_keys.lookup_key.js,samples/README.md) | -| Api_keys.undelete_key | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-api-apikeys/samples/generated/v2/api_keys.undelete_key.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-api-apikeys/samples/generated/v2/api_keys.undelete_key.js,samples/README.md) | -| Api_keys.update_key | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-api-apikeys/samples/generated/v2/api_keys.update_key.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-api-apikeys/samples/generated/v2/api_keys.update_key.js,samples/README.md) | -| Quickstart | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-api-apikeys/samples/quickstart.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-api-apikeys/samples/quickstart.js,samples/README.md) | -| Quickstart | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-api-apikeys/samples/test/quickstart.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-api-apikeys/samples/test/quickstart.js,samples/README.md) | +| Api_keys.create_key | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-api-apikeys/samples/generated/v2/api_keys.create_key.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-api-apikeys/samples/generated/v2/api_keys.create_key.js,packages/google-api-apikeys/samples/README.md) | +| Api_keys.delete_key | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-api-apikeys/samples/generated/v2/api_keys.delete_key.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-api-apikeys/samples/generated/v2/api_keys.delete_key.js,packages/google-api-apikeys/samples/README.md) | +| Api_keys.get_key | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-api-apikeys/samples/generated/v2/api_keys.get_key.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-api-apikeys/samples/generated/v2/api_keys.get_key.js,packages/google-api-apikeys/samples/README.md) | +| Api_keys.get_key_string | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-api-apikeys/samples/generated/v2/api_keys.get_key_string.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-api-apikeys/samples/generated/v2/api_keys.get_key_string.js,packages/google-api-apikeys/samples/README.md) | +| Api_keys.list_keys | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-api-apikeys/samples/generated/v2/api_keys.list_keys.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-api-apikeys/samples/generated/v2/api_keys.list_keys.js,packages/google-api-apikeys/samples/README.md) | +| Api_keys.lookup_key | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-api-apikeys/samples/generated/v2/api_keys.lookup_key.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-api-apikeys/samples/generated/v2/api_keys.lookup_key.js,packages/google-api-apikeys/samples/README.md) | +| Api_keys.undelete_key | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-api-apikeys/samples/generated/v2/api_keys.undelete_key.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-api-apikeys/samples/generated/v2/api_keys.undelete_key.js,packages/google-api-apikeys/samples/README.md) | +| Api_keys.update_key | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-api-apikeys/samples/generated/v2/api_keys.update_key.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-api-apikeys/samples/generated/v2/api_keys.update_key.js,packages/google-api-apikeys/samples/README.md) | +| Quickstart | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-api-apikeys/samples/quickstart.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-api-apikeys/samples/quickstart.js,packages/google-api-apikeys/samples/README.md) | diff --git a/packages/google-api-apikeys/package.json b/packages/google-api-apikeys/package.json index ed2d08cb506..e93cf62194c 100644 --- a/packages/google-api-apikeys/package.json +++ b/packages/google-api-apikeys/package.json @@ -46,14 +46,15 @@ "test": "c8 mocha build/test" }, "dependencies": { - "google-gax": "^3.5.8" + "google-gax": "^4.0.3" }, "devDependencies": { "@types/mocha": "^9.0.0", - "@types/node": "^18.0.0", + "@types/node": "^20.4.5", "@types/sinon": "^10.0.0", "c8": "^7.3.5", - "gts": "^3.1.0", + "gapic-tools": "^0.1.8", + "gts": "^5.0.0", "jsdoc": "^4.0.0", "jsdoc-fresh": "^2.0.0", "jsdoc-region-tag": "^2.0.0", @@ -64,11 +65,11 @@ "pack-n-play": "^1.0.0-2", "sinon": "^15.0.0", "ts-loader": "^9.0.0", - "typescript": "^4.6.4", + "typescript": "^5.1.6", "webpack": "^5.9.0", "webpack-cli": "^5.0.0" }, "engines": { - "node": ">=12.0.0" + "node": ">=14.0.0" } } diff --git a/packages/google-api-apikeys/samples/README.md b/packages/google-api-apikeys/samples/README.md index afdd5042eb1..9d798bee9ac 100644 --- a/packages/google-api-apikeys/samples/README.md +++ b/packages/google-api-apikeys/samples/README.md @@ -21,7 +21,6 @@ * [Api_keys.undelete_key](#api_keys.undelete_key) * [Api_keys.update_key](#api_keys.update_key) * [Quickstart](#quickstart) - * [Quickstart](#quickstart) ## Before you begin @@ -186,23 +185,6 @@ __Usage:__ `node packages/google-api-apikeys/samples/quickstart.js` ------ - - - - -### Quickstart - -View the [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-api-apikeys/samples/test/quickstart.js). - -[![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-api-apikeys/samples/test/quickstart.js,samples/README.md) - -__Usage:__ - - -`node packages/google-api-apikeys/samples/test/quickstart.js` - - diff --git a/packages/google-api-apikeys/samples/generated/v2/snippet_metadata.google.api.apikeys.v2.json b/packages/google-api-apikeys/samples/generated/v2/snippet_metadata.google.api.apikeys.v2.json index e2368ddb5bf..3648c4848f9 100644 --- a/packages/google-api-apikeys/samples/generated/v2/snippet_metadata.google.api.apikeys.v2.json +++ b/packages/google-api-apikeys/samples/generated/v2/snippet_metadata.google.api.apikeys.v2.json @@ -1,7 +1,7 @@ { "clientLibrary": { "name": "nodejs-apikeys", - "version": "0.2.1", + "version": "0.2.2", "language": "TYPESCRIPT", "apis": [ { diff --git a/packages/google-api-apikeys/samples/generated/v2/snippet_metadata_google.api.apikeys.v2.json b/packages/google-api-apikeys/samples/generated/v2/snippet_metadata_google.api.apikeys.v2.json new file mode 100644 index 00000000000..3648c4848f9 --- /dev/null +++ b/packages/google-api-apikeys/samples/generated/v2/snippet_metadata_google.api.apikeys.v2.json @@ -0,0 +1,363 @@ +{ + "clientLibrary": { + "name": "nodejs-apikeys", + "version": "0.2.2", + "language": "TYPESCRIPT", + "apis": [ + { + "id": "google.api.apikeys.v2", + "version": "v2" + } + ] + }, + "snippets": [ + { + "regionTag": "apikeys_v2_generated_ApiKeys_CreateKey_async", + "title": "ApiKeys createKey Sample", + "origin": "API_DEFINITION", + "description": " Creates a new API key. NOTE: Key is a global resource; hence the only supported value for location is `global`.", + "canonical": true, + "file": "api_keys.create_key.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 71, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CreateKey", + "fullName": "google.api.apikeys.v2.ApiKeys.CreateKey", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "key", + "type": ".google.api.apikeys.v2.Key" + }, + { + "name": "key_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "ApiKeysClient", + "fullName": "google.api.apikeys.v2.ApiKeysClient" + }, + "method": { + "shortName": "CreateKey", + "fullName": "google.api.apikeys.v2.ApiKeys.CreateKey", + "service": { + "shortName": "ApiKeys", + "fullName": "google.api.apikeys.v2.ApiKeys" + } + } + } + }, + { + "regionTag": "apikeys_v2_generated_ApiKeys_ListKeys_async", + "title": "ApiKeys listKeys Sample", + "origin": "API_DEFINITION", + "description": " Lists the API keys owned by a project. The key string of the API key isn't included in the response. NOTE: Key is a global resource; hence the only supported value for location is `global`.", + "canonical": true, + "file": "api_keys.list_keys.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 68, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListKeys", + "fullName": "google.api.apikeys.v2.ApiKeys.ListKeys", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "show_deleted", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.api.apikeys.v2.ListKeysResponse", + "client": { + "shortName": "ApiKeysClient", + "fullName": "google.api.apikeys.v2.ApiKeysClient" + }, + "method": { + "shortName": "ListKeys", + "fullName": "google.api.apikeys.v2.ApiKeys.ListKeys", + "service": { + "shortName": "ApiKeys", + "fullName": "google.api.apikeys.v2.ApiKeys" + } + } + } + }, + { + "regionTag": "apikeys_v2_generated_ApiKeys_GetKey_async", + "title": "ApiKeys getKey Sample", + "origin": "API_DEFINITION", + "description": " Gets the metadata for an API key. The key string of the API key isn't included in the response. NOTE: Key is a global resource; hence the only supported value for location is `global`.", + "canonical": true, + "file": "api_keys.get_key.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 53, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetKey", + "fullName": "google.api.apikeys.v2.ApiKeys.GetKey", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.api.apikeys.v2.Key", + "client": { + "shortName": "ApiKeysClient", + "fullName": "google.api.apikeys.v2.ApiKeysClient" + }, + "method": { + "shortName": "GetKey", + "fullName": "google.api.apikeys.v2.ApiKeys.GetKey", + "service": { + "shortName": "ApiKeys", + "fullName": "google.api.apikeys.v2.ApiKeys" + } + } + } + }, + { + "regionTag": "apikeys_v2_generated_ApiKeys_GetKeyString_async", + "title": "ApiKeys getKeyString Sample", + "origin": "API_DEFINITION", + "description": " Get the key string for an API key. NOTE: Key is a global resource; hence the only supported value for location is `global`.", + "canonical": true, + "file": "api_keys.get_key_string.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 53, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetKeyString", + "fullName": "google.api.apikeys.v2.ApiKeys.GetKeyString", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.api.apikeys.v2.GetKeyStringResponse", + "client": { + "shortName": "ApiKeysClient", + "fullName": "google.api.apikeys.v2.ApiKeysClient" + }, + "method": { + "shortName": "GetKeyString", + "fullName": "google.api.apikeys.v2.ApiKeys.GetKeyString", + "service": { + "shortName": "ApiKeys", + "fullName": "google.api.apikeys.v2.ApiKeys" + } + } + } + }, + { + "regionTag": "apikeys_v2_generated_ApiKeys_UpdateKey_async", + "title": "ApiKeys updateKey Sample", + "origin": "API_DEFINITION", + "description": " Patches the modifiable fields of an API key. The key string of the API key isn't included in the response. NOTE: Key is a global resource; hence the only supported value for location is `global`.", + "canonical": true, + "file": "api_keys.update_key.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 66, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "UpdateKey", + "fullName": "google.api.apikeys.v2.ApiKeys.UpdateKey", + "async": true, + "parameters": [ + { + "name": "key", + "type": ".google.api.apikeys.v2.Key" + }, + { + "name": "update_mask", + "type": ".google.protobuf.FieldMask" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "ApiKeysClient", + "fullName": "google.api.apikeys.v2.ApiKeysClient" + }, + "method": { + "shortName": "UpdateKey", + "fullName": "google.api.apikeys.v2.ApiKeys.UpdateKey", + "service": { + "shortName": "ApiKeys", + "fullName": "google.api.apikeys.v2.ApiKeys" + } + } + } + }, + { + "regionTag": "apikeys_v2_generated_ApiKeys_DeleteKey_async", + "title": "ApiKeys deleteKey Sample", + "origin": "API_DEFINITION", + "description": " Deletes an API key. Deleted key can be retrieved within 30 days of deletion. Afterward, key will be purged from the project. NOTE: Key is a global resource; hence the only supported value for location is `global`.", + "canonical": true, + "file": "api_keys.delete_key.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 59, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeleteKey", + "fullName": "google.api.apikeys.v2.ApiKeys.DeleteKey", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + }, + { + "name": "etag", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "ApiKeysClient", + "fullName": "google.api.apikeys.v2.ApiKeysClient" + }, + "method": { + "shortName": "DeleteKey", + "fullName": "google.api.apikeys.v2.ApiKeys.DeleteKey", + "service": { + "shortName": "ApiKeys", + "fullName": "google.api.apikeys.v2.ApiKeys" + } + } + } + }, + { + "regionTag": "apikeys_v2_generated_ApiKeys_UndeleteKey_async", + "title": "ApiKeys undeleteKey Sample", + "origin": "API_DEFINITION", + "description": " Undeletes an API key which was deleted within 30 days. NOTE: Key is a global resource; hence the only supported value for location is `global`.", + "canonical": true, + "file": "api_keys.undelete_key.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 54, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "UndeleteKey", + "fullName": "google.api.apikeys.v2.ApiKeys.UndeleteKey", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "ApiKeysClient", + "fullName": "google.api.apikeys.v2.ApiKeysClient" + }, + "method": { + "shortName": "UndeleteKey", + "fullName": "google.api.apikeys.v2.ApiKeys.UndeleteKey", + "service": { + "shortName": "ApiKeys", + "fullName": "google.api.apikeys.v2.ApiKeys" + } + } + } + }, + { + "regionTag": "apikeys_v2_generated_ApiKeys_LookupKey_async", + "title": "ApiKeys lookupKey Sample", + "origin": "API_DEFINITION", + "description": " Find the parent project and resource name of the API key that matches the key string in the request. If the API key has been purged, resource name will not be set. The service account must have the `apikeys.keys.lookup` permission on the parent project.", + "canonical": true, + "file": "api_keys.lookup_key.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 53, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "LookupKey", + "fullName": "google.api.apikeys.v2.ApiKeys.LookupKey", + "async": true, + "parameters": [ + { + "name": "key_string", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.api.apikeys.v2.LookupKeyResponse", + "client": { + "shortName": "ApiKeysClient", + "fullName": "google.api.apikeys.v2.ApiKeysClient" + }, + "method": { + "shortName": "LookupKey", + "fullName": "google.api.apikeys.v2.ApiKeys.LookupKey", + "service": { + "shortName": "ApiKeys", + "fullName": "google.api.apikeys.v2.ApiKeys" + } + } + } + } + ] +} \ No newline at end of file diff --git a/packages/google-api-apikeys/samples/package.json b/packages/google-api-apikeys/samples/package.json index fd8b8b97132..3b9f5d78537 100644 --- a/packages/google-api-apikeys/samples/package.json +++ b/packages/google-api-apikeys/samples/package.json @@ -4,7 +4,7 @@ "license": "Apache-2.0", "author": "Google LLC", "engines": { - "node": ">=12.0.0" + "node": ">=14.0.0" }, "files": [ "*.js" @@ -21,4 +21,4 @@ "chai": "^4.2.0", "mocha": "^8.0.0" } -} +} \ No newline at end of file diff --git a/packages/google-api-apikeys/src/v2/api_keys_client.ts b/packages/google-api-apikeys/src/v2/api_keys_client.ts index 28158b2dd0d..b71dffe5b00 100644 --- a/packages/google-api-apikeys/src/v2/api_keys_client.ts +++ b/packages/google-api-apikeys/src/v2/api_keys_client.ts @@ -432,9 +432,8 @@ export class ApiKeysClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.api.apikeys.v2.Key | Key}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.api.apikeys.v2.Key|Key}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v2/api_keys.get_key.js * region_tag:apikeys_v2_generated_ApiKeys_GetKey_async @@ -518,9 +517,8 @@ export class ApiKeysClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.api.apikeys.v2.GetKeyStringResponse | GetKeyStringResponse}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.api.apikeys.v2.GetKeyStringResponse|GetKeyStringResponse}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v2/api_keys.get_key_string.js * region_tag:apikeys_v2_generated_ApiKeys_GetKeyString_async @@ -605,9 +603,8 @@ export class ApiKeysClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.api.apikeys.v2.LookupKeyResponse | LookupKeyResponse}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.api.apikeys.v2.LookupKeyResponse|LookupKeyResponse}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v2/api_keys.lookup_key.js * region_tag:apikeys_v2_generated_ApiKeys_LookupKey_async @@ -705,8 +702,7 @@ export class ApiKeysClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v2/api_keys.create_key.js * region_tag:apikeys_v2_generated_ApiKeys_CreateKey_async @@ -801,8 +797,7 @@ export class ApiKeysClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v2/api_keys.create_key.js * region_tag:apikeys_v2_generated_ApiKeys_CreateKey_async @@ -854,8 +849,7 @@ export class ApiKeysClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v2/api_keys.update_key.js * region_tag:apikeys_v2_generated_ApiKeys_UpdateKey_async @@ -950,8 +944,7 @@ export class ApiKeysClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v2/api_keys.update_key.js * region_tag:apikeys_v2_generated_ApiKeys_UpdateKey_async @@ -996,8 +989,7 @@ export class ApiKeysClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v2/api_keys.delete_key.js * region_tag:apikeys_v2_generated_ApiKeys_DeleteKey_async @@ -1092,8 +1084,7 @@ export class ApiKeysClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v2/api_keys.delete_key.js * region_tag:apikeys_v2_generated_ApiKeys_DeleteKey_async @@ -1134,8 +1125,7 @@ export class ApiKeysClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v2/api_keys.undelete_key.js * region_tag:apikeys_v2_generated_ApiKeys_UndeleteKey_async @@ -1230,8 +1220,7 @@ export class ApiKeysClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v2/api_keys.undelete_key.js * region_tag:apikeys_v2_generated_ApiKeys_UndeleteKey_async @@ -1277,14 +1266,13 @@ export class ApiKeysClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.api.apikeys.v2.Key | Key}. + * The first element of the array is Array of {@link protos.google.api.apikeys.v2.Key|Key}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `listKeysAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listKeys( @@ -1370,13 +1358,12 @@ export class ApiKeysClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.api.apikeys.v2.Key | Key} on 'data' event. + * An object stream which emits an object representing {@link protos.google.api.apikeys.v2.Key|Key} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listKeysAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listKeysStream( @@ -1419,12 +1406,11 @@ export class ApiKeysClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.api.apikeys.v2.Key | Key}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.api.apikeys.v2.Key|Key}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v2/api_keys.list_keys.js * region_tag:apikeys_v2_generated_ApiKeys_ListKeys_async diff --git a/packages/google-api-apikeys/webpack.config.js b/packages/google-api-apikeys/webpack.config.js index 10e62d48d42..e07e89d745d 100644 --- a/packages/google-api-apikeys/webpack.config.js +++ b/packages/google-api-apikeys/webpack.config.js @@ -1,4 +1,4 @@ -// Copyright 2023 Google LLC +// Copyright 2021 Google LLC // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. diff --git a/packages/google-api-servicecontrol/package.json b/packages/google-api-servicecontrol/package.json index 8aa6fe9093c..1aab1ed91dd 100644 --- a/packages/google-api-servicecontrol/package.json +++ b/packages/google-api-servicecontrol/package.json @@ -46,14 +46,15 @@ "test": "c8 mocha build/test" }, "dependencies": { - "google-gax": "^3.5.8" + "google-gax": "^4.0.3" }, "devDependencies": { "@types/mocha": "^9.0.0", - "@types/node": "^18.0.0", + "@types/node": "^20.4.5", "@types/sinon": "^10.0.0", "c8": "^7.6.0", - "gts": "^3.1.0", + "gapic-tools": "^0.1.8", + "gts": "^5.0.0", "jsdoc": "^4.0.0", "jsdoc-fresh": "^2.0.0", "jsdoc-region-tag": "^2.0.0", @@ -64,12 +65,12 @@ "pack-n-play": "^1.0.0-2", "sinon": "^15.0.0", "ts-loader": "^9.0.0", - "typescript": "^4.6.4", + "typescript": "^5.1.6", "webpack": "^5.24.4", "webpack-cli": "^5.0.0" }, "engines": { - "node": ">=12.0.0" + "node": ">=14.0.0" }, "homepage": "https://github.com/googleapis/google-cloud-node/tree/main/packages/google-api-servicecontrol" } diff --git a/packages/google-api-servicecontrol/samples/generated/v1/service_controller.report.js b/packages/google-api-servicecontrol/samples/generated/v1/service_controller.report.js index da713878d02..ec8c8474f54 100644 --- a/packages/google-api-servicecontrol/samples/generated/v1/service_controller.report.js +++ b/packages/google-api-servicecontrol/samples/generated/v1/service_controller.report.js @@ -47,7 +47,7 @@ function main() { * ReportResponse.report_errors google.api.servicecontrol.v1.ReportResponse.report_errors * for partial failure behavior. */ - // const operations = 1234 + // const operations = [1,2,3,4] /** * Specifies which version of service config should be used to process the * request. diff --git a/packages/google-api-servicecontrol/samples/generated/v1/snippet_metadata_google.api.servicecontrol.v1.json b/packages/google-api-servicecontrol/samples/generated/v1/snippet_metadata_google.api.servicecontrol.v1.json new file mode 100644 index 00000000000..172d5179f72 --- /dev/null +++ b/packages/google-api-servicecontrol/samples/generated/v1/snippet_metadata_google.api.servicecontrol.v1.json @@ -0,0 +1,159 @@ +{ + "clientLibrary": { + "name": "nodejs-servicecontrol", + "version": "2.3.0", + "language": "TYPESCRIPT", + "apis": [ + { + "id": "google.api.servicecontrol.v1", + "version": "v1" + } + ] + }, + "snippets": [ + { + "regionTag": "servicecontrol_v1_generated_QuotaController_AllocateQuota_async", + "title": "QuotaController allocateQuota Sample", + "origin": "API_DEFINITION", + "description": " Attempts to allocate quota for the specified consumer. It should be called before the operation is executed. This method requires the `servicemanagement.services.quota` permission on the specified service. For more information, see [Cloud IAM](https://cloud.google.com/iam). **NOTE:** The client **must** fail-open on server errors `INTERNAL`, `UNKNOWN`, `DEADLINE_EXCEEDED`, and `UNAVAILABLE`. To ensure system reliability, the server may inject these errors to prohibit any hard dependency on the quota functionality.", + "canonical": true, + "file": "quota_controller.allocate_quota.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 64, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "AllocateQuota", + "fullName": "google.api.servicecontrol.v1.QuotaController.AllocateQuota", + "async": true, + "parameters": [ + { + "name": "service_name", + "type": "TYPE_STRING" + }, + { + "name": "allocate_operation", + "type": ".google.api.servicecontrol.v1.QuotaOperation" + }, + { + "name": "service_config_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.api.servicecontrol.v1.AllocateQuotaResponse", + "client": { + "shortName": "QuotaControllerClient", + "fullName": "google.api.servicecontrol.v1.QuotaControllerClient" + }, + "method": { + "shortName": "AllocateQuota", + "fullName": "google.api.servicecontrol.v1.QuotaController.AllocateQuota", + "service": { + "shortName": "QuotaController", + "fullName": "google.api.servicecontrol.v1.QuotaController" + } + } + } + }, + { + "regionTag": "servicecontrol_v1_generated_ServiceController_Check_async", + "title": "QuotaController check Sample", + "origin": "API_DEFINITION", + "description": " Checks whether an operation on a service should be allowed to proceed based on the configuration of the service and related policies. It must be called before the operation is executed. If feasible, the client should cache the check results and reuse them for 60 seconds. In case of any server errors, the client should rely on the cached results for much longer time to avoid outage. WARNING: There is general 60s delay for the configuration and policy propagation, therefore callers MUST NOT depend on the `Check` method having the latest policy information. NOTE: the [CheckRequest][google.api.servicecontrol.v1.CheckRequest] has the size limit (wire-format byte size) of 1MB. This method requires the `servicemanagement.services.check` permission on the specified service. For more information, see [Cloud IAM](https://cloud.google.com/iam).", + "canonical": true, + "file": "service_controller.check.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 67, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Check", + "fullName": "google.api.servicecontrol.v1.ServiceController.Check", + "async": true, + "parameters": [ + { + "name": "service_name", + "type": "TYPE_STRING" + }, + { + "name": "operation", + "type": ".google.api.servicecontrol.v1.Operation" + }, + { + "name": "service_config_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.api.servicecontrol.v1.CheckResponse", + "client": { + "shortName": "ServiceControllerClient", + "fullName": "google.api.servicecontrol.v1.ServiceControllerClient" + }, + "method": { + "shortName": "Check", + "fullName": "google.api.servicecontrol.v1.ServiceController.Check", + "service": { + "shortName": "ServiceController", + "fullName": "google.api.servicecontrol.v1.ServiceController" + } + } + } + }, + { + "regionTag": "servicecontrol_v1_generated_ServiceController_Report_async", + "title": "QuotaController report Sample", + "origin": "API_DEFINITION", + "description": " Reports operation results to Google Service Control, such as logs and metrics. It should be called after an operation is completed. If feasible, the client should aggregate reporting data for up to 5 seconds to reduce API traffic. Limiting aggregation to 5 seconds is to reduce data loss during client crashes. Clients should carefully choose the aggregation time window to avoid data loss risk more than 0.01% for business and compliance reasons. NOTE: the [ReportRequest][google.api.servicecontrol.v1.ReportRequest] has the size limit (wire-format byte size) of 1MB. This method requires the `servicemanagement.services.report` permission on the specified service. For more information, see [Google Cloud IAM](https://cloud.google.com/iam).", + "canonical": true, + "file": "service_controller.report.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 75, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Report", + "fullName": "google.api.servicecontrol.v1.ServiceController.Report", + "async": true, + "parameters": [ + { + "name": "service_name", + "type": "TYPE_STRING" + }, + { + "name": "operations", + "type": "TYPE_MESSAGE[]" + }, + { + "name": "service_config_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.api.servicecontrol.v1.ReportResponse", + "client": { + "shortName": "ServiceControllerClient", + "fullName": "google.api.servicecontrol.v1.ServiceControllerClient" + }, + "method": { + "shortName": "Report", + "fullName": "google.api.servicecontrol.v1.ServiceController.Report", + "service": { + "shortName": "ServiceController", + "fullName": "google.api.servicecontrol.v1.ServiceController" + } + } + } + } + ] +} \ No newline at end of file diff --git a/packages/google-api-servicecontrol/samples/generated/v2/service_controller.check.js b/packages/google-api-servicecontrol/samples/generated/v2/service_controller.check.js index dfe313fd29d..6297dc5d2ed 100644 --- a/packages/google-api-servicecontrol/samples/generated/v2/service_controller.check.js +++ b/packages/google-api-servicecontrol/samples/generated/v2/service_controller.check.js @@ -49,7 +49,7 @@ function main() { /** * Describes the resources and the policies applied to each resource. */ - // const resources = 1234 + // const resources = [1,2,3,4] /** * Optional. Contains a comma-separated list of flags. */ diff --git a/packages/google-api-servicecontrol/samples/generated/v2/service_controller.report.js b/packages/google-api-servicecontrol/samples/generated/v2/service_controller.report.js index cb9716d7458..d90a40bfbd5 100644 --- a/packages/google-api-servicecontrol/samples/generated/v2/service_controller.report.js +++ b/packages/google-api-servicecontrol/samples/generated/v2/service_controller.report.js @@ -47,7 +47,7 @@ function main() { * represented as an AttributeContext, and contains all attributes around an * API access. */ - // const operations = 1234 + // const operations = [1,2,3,4] // Imports the Servicecontrol library const {ServiceControllerClient} = require('@google-cloud/servicecontrol').v2; diff --git a/packages/google-api-servicecontrol/samples/generated/v2/snippet_metadata_google.api.servicecontrol.v2.json b/packages/google-api-servicecontrol/samples/generated/v2/snippet_metadata_google.api.servicecontrol.v2.json new file mode 100644 index 00000000000..cc685e80fbf --- /dev/null +++ b/packages/google-api-servicecontrol/samples/generated/v2/snippet_metadata_google.api.servicecontrol.v2.json @@ -0,0 +1,119 @@ +{ + "clientLibrary": { + "name": "nodejs-servicecontrol", + "version": "2.3.0", + "language": "TYPESCRIPT", + "apis": [ + { + "id": "google.api.servicecontrol.v2", + "version": "v2" + } + ] + }, + "snippets": [ + { + "regionTag": "servicecontrol_v2_generated_ServiceController_Check_async", + "title": "ServiceController check Sample", + "origin": "API_DEFINITION", + "description": " Private Preview. This feature is only available for approved services. This method provides admission control for services that are integrated with [Service Infrastructure](https://cloud.google.com/service-infrastructure). It checks whether an operation should be allowed based on the service configuration and relevant policies. It must be called before the operation is executed. For more information, see [Admission Control](https://cloud.google.com/service-infrastructure/docs/admission-control). NOTE: The admission control has an expected policy propagation delay of 60s. The caller **must** not depend on the most recent policy changes. NOTE: The admission control has a hard limit of 1 referenced resources per call. If an operation refers to more than 1 resources, the caller must call the Check method multiple times. This method requires the `servicemanagement.services.check` permission on the specified service. For more information, see [Service Control API Access Control](https://cloud.google.com/service-infrastructure/docs/service-control/access-control).", + "canonical": true, + "file": "service_controller.check.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 74, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Check", + "fullName": "google.api.servicecontrol.v2.ServiceController.Check", + "async": true, + "parameters": [ + { + "name": "service_name", + "type": "TYPE_STRING" + }, + { + "name": "service_config_id", + "type": "TYPE_STRING" + }, + { + "name": "attributes", + "type": ".google.rpc.context.AttributeContext" + }, + { + "name": "resources", + "type": "TYPE_MESSAGE[]" + }, + { + "name": "flags", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.api.servicecontrol.v2.CheckResponse", + "client": { + "shortName": "ServiceControllerClient", + "fullName": "google.api.servicecontrol.v2.ServiceControllerClient" + }, + "method": { + "shortName": "Check", + "fullName": "google.api.servicecontrol.v2.ServiceController.Check", + "service": { + "shortName": "ServiceController", + "fullName": "google.api.servicecontrol.v2.ServiceController" + } + } + } + }, + { + "regionTag": "servicecontrol_v2_generated_ServiceController_Report_async", + "title": "ServiceController report Sample", + "origin": "API_DEFINITION", + "description": " Private Preview. This feature is only available for approved services. This method provides telemetry reporting for services that are integrated with [Service Infrastructure](https://cloud.google.com/service-infrastructure). It reports a list of operations that have occurred on a service. It must be called after the operations have been executed. For more information, see [Telemetry Reporting](https://cloud.google.com/service-infrastructure/docs/telemetry-reporting). NOTE: The telemetry reporting has a hard limit of 1000 operations and 1MB per Report call. It is recommended to have no more than 100 operations per call. This method requires the `servicemanagement.services.report` permission on the specified service. For more information, see [Service Control API Access Control](https://cloud.google.com/service-infrastructure/docs/service-control/access-control).", + "canonical": true, + "file": "service_controller.report.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 68, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Report", + "fullName": "google.api.servicecontrol.v2.ServiceController.Report", + "async": true, + "parameters": [ + { + "name": "service_name", + "type": "TYPE_STRING" + }, + { + "name": "service_config_id", + "type": "TYPE_STRING" + }, + { + "name": "operations", + "type": "TYPE_MESSAGE[]" + } + ], + "resultType": ".google.api.servicecontrol.v2.ReportResponse", + "client": { + "shortName": "ServiceControllerClient", + "fullName": "google.api.servicecontrol.v2.ServiceControllerClient" + }, + "method": { + "shortName": "Report", + "fullName": "google.api.servicecontrol.v2.ServiceController.Report", + "service": { + "shortName": "ServiceController", + "fullName": "google.api.servicecontrol.v2.ServiceController" + } + } + } + } + ] +} \ No newline at end of file diff --git a/packages/google-api-servicecontrol/samples/package.json b/packages/google-api-servicecontrol/samples/package.json index 4827b04d7ec..2d6f07504de 100644 --- a/packages/google-api-servicecontrol/samples/package.json +++ b/packages/google-api-servicecontrol/samples/package.json @@ -4,7 +4,7 @@ "license": "Apache-2.0", "author": "Google LLC", "engines": { - "node": ">=12.0.0" + "node": ">=14.0.0" }, "files": [ "*.js" diff --git a/packages/google-api-servicecontrol/src/v1/quota_controller_client.ts b/packages/google-api-servicecontrol/src/v1/quota_controller_client.ts index fcc8fba611d..896142b92b5 100644 --- a/packages/google-api-servicecontrol/src/v1/quota_controller_client.ts +++ b/packages/google-api-servicecontrol/src/v1/quota_controller_client.ts @@ -328,7 +328,7 @@ export class QuotaControllerClient { * Name of the service as specified in the service configuration. For example, * `"pubsub.googleapis.com"`. * - * See {@link google.api.Service|google.api.Service} for the definition of a service name. + * See {@link protos.google.api.Service|google.api.Service} for the definition of a service name. * @param {google.api.servicecontrol.v1.QuotaOperation} request.allocateOperation * Operation that describes the quota allocation. * @param {string} request.serviceConfigId @@ -338,9 +338,8 @@ export class QuotaControllerClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.api.servicecontrol.v1.AllocateQuotaResponse | AllocateQuotaResponse}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.api.servicecontrol.v1.AllocateQuotaResponse|AllocateQuotaResponse}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/quota_controller.allocate_quota.js * region_tag:servicecontrol_v1_generated_QuotaController_AllocateQuota_async diff --git a/packages/google-api-servicecontrol/src/v1/service_controller_client.ts b/packages/google-api-servicecontrol/src/v1/service_controller_client.ts index d6eec8b4cf6..112d2d3df08 100644 --- a/packages/google-api-servicecontrol/src/v1/service_controller_client.ts +++ b/packages/google-api-servicecontrol/src/v1/service_controller_client.ts @@ -321,7 +321,7 @@ export class ServiceControllerClient { * propagation, therefore callers MUST NOT depend on the `Check` method having * the latest policy information. * - * NOTE: the {@link google.api.servicecontrol.v1.CheckRequest|CheckRequest} has + * NOTE: the {@link protos.google.api.servicecontrol.v1.CheckRequest|CheckRequest} has * the size limit (wire-format byte size) of 1MB. * * This method requires the `servicemanagement.services.check` permission @@ -348,9 +348,8 @@ export class ServiceControllerClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.api.servicecontrol.v1.CheckResponse | CheckResponse}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.api.servicecontrol.v1.CheckResponse|CheckResponse}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/service_controller.check.js * region_tag:servicecontrol_v1_generated_ServiceController_Check_async @@ -431,7 +430,7 @@ export class ServiceControllerClient { * the aggregation time window to avoid data loss risk more than 0.01% * for business and compliance reasons. * - * NOTE: the {@link google.api.servicecontrol.v1.ReportRequest|ReportRequest} has + * NOTE: the {@link protos.google.api.servicecontrol.v1.ReportRequest|ReportRequest} has * the size limit (wire-format byte size) of 1MB. * * This method requires the `servicemanagement.services.report` permission @@ -457,7 +456,7 @@ export class ServiceControllerClient { * * There is no limit on the number of operations in the same ReportRequest, * however the ReportRequest size should be no larger than 1MB. See - * {@link google.api.servicecontrol.v1.ReportResponse.report_errors|ReportResponse.report_errors} + * {@link protos.google.api.servicecontrol.v1.ReportResponse.report_errors|ReportResponse.report_errors} * for partial failure behavior. * @param {string} request.serviceConfigId * Specifies which version of service config should be used to process the @@ -468,9 +467,8 @@ export class ServiceControllerClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.api.servicecontrol.v1.ReportResponse | ReportResponse}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.api.servicecontrol.v1.ReportResponse|ReportResponse}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/service_controller.report.js * region_tag:servicecontrol_v1_generated_ServiceController_Report_async diff --git a/packages/google-api-servicecontrol/src/v2/service_controller_client.ts b/packages/google-api-servicecontrol/src/v2/service_controller_client.ts index 33ed80b67aa..872d3cde2be 100644 --- a/packages/google-api-servicecontrol/src/v2/service_controller_client.ts +++ b/packages/google-api-servicecontrol/src/v2/service_controller_client.ts @@ -359,9 +359,8 @@ export class ServiceControllerClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.api.servicecontrol.v2.CheckResponse | CheckResponse}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.api.servicecontrol.v2.CheckResponse|CheckResponse}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v2/service_controller.check.js * region_tag:servicecontrol_v2_generated_ServiceController_Check_async @@ -472,9 +471,8 @@ export class ServiceControllerClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.api.servicecontrol.v2.ReportResponse | ReportResponse}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.api.servicecontrol.v2.ReportResponse|ReportResponse}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v2/service_controller.report.js * region_tag:servicecontrol_v2_generated_ServiceController_Report_async diff --git a/packages/google-api-servicemanagement/package.json b/packages/google-api-servicemanagement/package.json index a8e047db606..7885b4495ed 100644 --- a/packages/google-api-servicemanagement/package.json +++ b/packages/google-api-servicemanagement/package.json @@ -45,14 +45,15 @@ "test": "c8 mocha build/test" }, "dependencies": { - "google-gax": "^3.3.0" + "google-gax": "^4.0.3" }, "devDependencies": { "@types/mocha": "^9.0.0", - "@types/node": "^18.0.0", + "@types/node": "^20.4.5", "@types/sinon": "^10.0.0", "c8": "^7.6.0", - "gts": "^3.1.0", + "gapic-tools": "^0.1.8", + "gts": "^5.0.0", "jsdoc": "^4.0.0", "jsdoc-fresh": "^2.0.0", "jsdoc-region-tag": "^2.0.0", @@ -63,12 +64,12 @@ "pack-n-play": "^1.0.0-2", "sinon": "^15.0.0", "ts-loader": "^9.0.0", - "typescript": "^4.6.4", + "typescript": "^5.1.6", "webpack": "^5.24.4", "webpack-cli": "^5.0.0" }, "engines": { - "node": ">=12.0.0" + "node": ">=14.0.0" }, "homepage": "https://github.com/googleapis/google-cloud-node/tree/main/packages/google-api-servicemanagement" } diff --git a/packages/google-api-servicemanagement/samples/generated/v1/snippet_metadata_google.api.servicemanagement.v1.json b/packages/google-api-servicemanagement/samples/generated/v1/snippet_metadata_google.api.servicemanagement.v1.json new file mode 100644 index 00000000000..70b076cee6c --- /dev/null +++ b/packages/google-api-servicemanagement/samples/generated/v1/snippet_metadata_google.api.servicemanagement.v1.json @@ -0,0 +1,599 @@ +{ + "clientLibrary": { + "name": "nodejs-servicemanagement", + "version": "1.2.2", + "language": "TYPESCRIPT", + "apis": [ + { + "id": "google.api.servicemanagement.v1", + "version": "v1" + } + ] + }, + "snippets": [ + { + "regionTag": "servicemanagement_v1_generated_ServiceManager_ListServices_async", + "title": "ServiceManager listServices Sample", + "origin": "API_DEFINITION", + "description": " Lists managed services. Returns all public services. For authenticated users, also returns all services the calling user has \"servicemanagement.services.get\" permission for.", + "canonical": true, + "file": "service_manager.list_services.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 71, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListServices", + "fullName": "google.api.servicemanagement.v1.ServiceManager.ListServices", + "async": true, + "parameters": [ + { + "name": "producer_project_id", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "consumer_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.api.servicemanagement.v1.ListServicesResponse", + "client": { + "shortName": "ServiceManagerClient", + "fullName": "google.api.servicemanagement.v1.ServiceManagerClient" + }, + "method": { + "shortName": "ListServices", + "fullName": "google.api.servicemanagement.v1.ServiceManager.ListServices", + "service": { + "shortName": "ServiceManager", + "fullName": "google.api.servicemanagement.v1.ServiceManager" + } + } + } + }, + { + "regionTag": "servicemanagement_v1_generated_ServiceManager_GetService_async", + "title": "ServiceManager getService Sample", + "origin": "API_DEFINITION", + "description": " Gets a managed service. Authentication is required unless the service is public.", + "canonical": true, + "file": "service_manager.get_service.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 54, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetService", + "fullName": "google.api.servicemanagement.v1.ServiceManager.GetService", + "async": true, + "parameters": [ + { + "name": "service_name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.api.servicemanagement.v1.ManagedService", + "client": { + "shortName": "ServiceManagerClient", + "fullName": "google.api.servicemanagement.v1.ServiceManagerClient" + }, + "method": { + "shortName": "GetService", + "fullName": "google.api.servicemanagement.v1.ServiceManager.GetService", + "service": { + "shortName": "ServiceManager", + "fullName": "google.api.servicemanagement.v1.ServiceManager" + } + } + } + }, + { + "regionTag": "servicemanagement_v1_generated_ServiceManager_CreateService_async", + "title": "ServiceManager createService Sample", + "origin": "API_DEFINITION", + "description": " Creates a new managed service. A managed service is immutable, and is subject to mandatory 30-day data retention. You cannot move a service or recreate it within 30 days after deletion. One producer project can own no more than 500 services. For security and reliability purposes, a production service should be hosted in a dedicated producer project. Operation", + "canonical": true, + "file": "service_manager.create_service.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 54, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CreateService", + "fullName": "google.api.servicemanagement.v1.ServiceManager.CreateService", + "async": true, + "parameters": [ + { + "name": "service", + "type": ".google.api.servicemanagement.v1.ManagedService" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "ServiceManagerClient", + "fullName": "google.api.servicemanagement.v1.ServiceManagerClient" + }, + "method": { + "shortName": "CreateService", + "fullName": "google.api.servicemanagement.v1.ServiceManager.CreateService", + "service": { + "shortName": "ServiceManager", + "fullName": "google.api.servicemanagement.v1.ServiceManager" + } + } + } + }, + { + "regionTag": "servicemanagement_v1_generated_ServiceManager_DeleteService_async", + "title": "ServiceManager deleteService Sample", + "origin": "API_DEFINITION", + "description": " Deletes a managed service. This method will change the service to the `Soft-Delete` state for 30 days. Within this period, service producers may call [UndeleteService][google.api.servicemanagement.v1.ServiceManager.UndeleteService] to restore the service. After 30 days, the service will be permanently deleted. Operation", + "canonical": true, + "file": "service_manager.delete_service.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 56, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeleteService", + "fullName": "google.api.servicemanagement.v1.ServiceManager.DeleteService", + "async": true, + "parameters": [ + { + "name": "service_name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "ServiceManagerClient", + "fullName": "google.api.servicemanagement.v1.ServiceManagerClient" + }, + "method": { + "shortName": "DeleteService", + "fullName": "google.api.servicemanagement.v1.ServiceManager.DeleteService", + "service": { + "shortName": "ServiceManager", + "fullName": "google.api.servicemanagement.v1.ServiceManager" + } + } + } + }, + { + "regionTag": "servicemanagement_v1_generated_ServiceManager_UndeleteService_async", + "title": "ServiceManager undeleteService Sample", + "origin": "API_DEFINITION", + "description": " Revives a previously deleted managed service. The method restores the service using the configuration at the time the service was deleted. The target service must exist and must have been deleted within the last 30 days. Operation", + "canonical": true, + "file": "service_manager.undelete_service.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 56, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "UndeleteService", + "fullName": "google.api.servicemanagement.v1.ServiceManager.UndeleteService", + "async": true, + "parameters": [ + { + "name": "service_name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "ServiceManagerClient", + "fullName": "google.api.servicemanagement.v1.ServiceManagerClient" + }, + "method": { + "shortName": "UndeleteService", + "fullName": "google.api.servicemanagement.v1.ServiceManager.UndeleteService", + "service": { + "shortName": "ServiceManager", + "fullName": "google.api.servicemanagement.v1.ServiceManager" + } + } + } + }, + { + "regionTag": "servicemanagement_v1_generated_ServiceManager_ListServiceConfigs_async", + "title": "ServiceManager listServiceConfigs Sample", + "origin": "API_DEFINITION", + "description": " Lists the history of the service configuration for a managed service, from the newest to the oldest.", + "canonical": true, + "file": "service_manager.list_service_configs.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 66, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListServiceConfigs", + "fullName": "google.api.servicemanagement.v1.ServiceManager.ListServiceConfigs", + "async": true, + "parameters": [ + { + "name": "service_name", + "type": "TYPE_STRING" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + } + ], + "resultType": ".google.api.servicemanagement.v1.ListServiceConfigsResponse", + "client": { + "shortName": "ServiceManagerClient", + "fullName": "google.api.servicemanagement.v1.ServiceManagerClient" + }, + "method": { + "shortName": "ListServiceConfigs", + "fullName": "google.api.servicemanagement.v1.ServiceManager.ListServiceConfigs", + "service": { + "shortName": "ServiceManager", + "fullName": "google.api.servicemanagement.v1.ServiceManager" + } + } + } + }, + { + "regionTag": "servicemanagement_v1_generated_ServiceManager_GetServiceConfig_async", + "title": "ServiceManager getServiceConfig Sample", + "origin": "API_DEFINITION", + "description": " Gets a service configuration (version) for a managed service.", + "canonical": true, + "file": "service_manager.get_service_config.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 67, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetServiceConfig", + "fullName": "google.api.servicemanagement.v1.ServiceManager.GetServiceConfig", + "async": true, + "parameters": [ + { + "name": "service_name", + "type": "TYPE_STRING" + }, + { + "name": "config_id", + "type": "TYPE_STRING" + }, + { + "name": "view", + "type": ".google.api.servicemanagement.v1.GetServiceConfigRequest.ConfigView" + } + ], + "resultType": ".google.api.Service", + "client": { + "shortName": "ServiceManagerClient", + "fullName": "google.api.servicemanagement.v1.ServiceManagerClient" + }, + "method": { + "shortName": "GetServiceConfig", + "fullName": "google.api.servicemanagement.v1.ServiceManager.GetServiceConfig", + "service": { + "shortName": "ServiceManager", + "fullName": "google.api.servicemanagement.v1.ServiceManager" + } + } + } + }, + { + "regionTag": "servicemanagement_v1_generated_ServiceManager_CreateServiceConfig_async", + "title": "ServiceManager createServiceConfig Sample", + "origin": "API_DEFINITION", + "description": " Creates a new service configuration (version) for a managed service. This method only stores the service configuration. To roll out the service configuration to backend systems please call [CreateServiceRollout][google.api.servicemanagement.v1.ServiceManager.CreateServiceRollout]. Only the 100 most recent service configurations and ones referenced by existing rollouts are kept for each service. The rest will be deleted eventually.", + "canonical": true, + "file": "service_manager.create_service_config.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 60, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CreateServiceConfig", + "fullName": "google.api.servicemanagement.v1.ServiceManager.CreateServiceConfig", + "async": true, + "parameters": [ + { + "name": "service_name", + "type": "TYPE_STRING" + }, + { + "name": "service_config", + "type": ".google.api.Service" + } + ], + "resultType": ".google.api.Service", + "client": { + "shortName": "ServiceManagerClient", + "fullName": "google.api.servicemanagement.v1.ServiceManagerClient" + }, + "method": { + "shortName": "CreateServiceConfig", + "fullName": "google.api.servicemanagement.v1.ServiceManager.CreateServiceConfig", + "service": { + "shortName": "ServiceManager", + "fullName": "google.api.servicemanagement.v1.ServiceManager" + } + } + } + }, + { + "regionTag": "servicemanagement_v1_generated_ServiceManager_SubmitConfigSource_async", + "title": "ServiceManager submitConfigSource Sample", + "origin": "API_DEFINITION", + "description": " Creates a new service configuration (version) for a managed service based on user-supplied configuration source files (for example: OpenAPI Specification). This method stores the source configurations as well as the generated service configuration. To rollout the service configuration to other services, please call [CreateServiceRollout][google.api.servicemanagement.v1.ServiceManager.CreateServiceRollout]. Only the 100 most recent configuration sources and ones referenced by existing service configurtions are kept for each service. The rest will be deleted eventually. Operation", + "canonical": true, + "file": "service_manager.submit_config_source.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 67, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "SubmitConfigSource", + "fullName": "google.api.servicemanagement.v1.ServiceManager.SubmitConfigSource", + "async": true, + "parameters": [ + { + "name": "service_name", + "type": "TYPE_STRING" + }, + { + "name": "config_source", + "type": ".google.api.servicemanagement.v1.ConfigSource" + }, + { + "name": "validate_only", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "ServiceManagerClient", + "fullName": "google.api.servicemanagement.v1.ServiceManagerClient" + }, + "method": { + "shortName": "SubmitConfigSource", + "fullName": "google.api.servicemanagement.v1.ServiceManager.SubmitConfigSource", + "service": { + "shortName": "ServiceManager", + "fullName": "google.api.servicemanagement.v1.ServiceManager" + } + } + } + }, + { + "regionTag": "servicemanagement_v1_generated_ServiceManager_ListServiceRollouts_async", + "title": "ServiceManager listServiceRollouts Sample", + "origin": "API_DEFINITION", + "description": " Lists the history of the service configuration rollouts for a managed service, from the newest to the oldest.", + "canonical": true, + "file": "service_manager.list_service_rollouts.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 78, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListServiceRollouts", + "fullName": "google.api.servicemanagement.v1.ServiceManager.ListServiceRollouts", + "async": true, + "parameters": [ + { + "name": "service_name", + "type": "TYPE_STRING" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "filter", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.api.servicemanagement.v1.ListServiceRolloutsResponse", + "client": { + "shortName": "ServiceManagerClient", + "fullName": "google.api.servicemanagement.v1.ServiceManagerClient" + }, + "method": { + "shortName": "ListServiceRollouts", + "fullName": "google.api.servicemanagement.v1.ServiceManager.ListServiceRollouts", + "service": { + "shortName": "ServiceManager", + "fullName": "google.api.servicemanagement.v1.ServiceManager" + } + } + } + }, + { + "regionTag": "servicemanagement_v1_generated_ServiceManager_GetServiceRollout_async", + "title": "ServiceManager getServiceRollout Sample", + "origin": "API_DEFINITION", + "description": " Gets a service configuration [rollout][google.api.servicemanagement.v1.Rollout].", + "canonical": true, + "file": "service_manager.get_service_rollout.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 60, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetServiceRollout", + "fullName": "google.api.servicemanagement.v1.ServiceManager.GetServiceRollout", + "async": true, + "parameters": [ + { + "name": "service_name", + "type": "TYPE_STRING" + }, + { + "name": "rollout_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.api.servicemanagement.v1.Rollout", + "client": { + "shortName": "ServiceManagerClient", + "fullName": "google.api.servicemanagement.v1.ServiceManagerClient" + }, + "method": { + "shortName": "GetServiceRollout", + "fullName": "google.api.servicemanagement.v1.ServiceManager.GetServiceRollout", + "service": { + "shortName": "ServiceManager", + "fullName": "google.api.servicemanagement.v1.ServiceManager" + } + } + } + }, + { + "regionTag": "servicemanagement_v1_generated_ServiceManager_CreateServiceRollout_async", + "title": "ServiceManager createServiceRollout Sample", + "origin": "API_DEFINITION", + "description": " Creates a new service configuration rollout. Based on rollout, the Google Service Management will roll out the service configurations to different backend services. For example, the logging configuration will be pushed to Google Cloud Logging. Please note that any previous pending and running Rollouts and associated Operations will be automatically cancelled so that the latest Rollout will not be blocked by previous Rollouts. Only the 100 most recent (in any state) and the last 10 successful (if not already part of the set of 100 most recent) rollouts are kept for each service. The rest will be deleted eventually. Operation", + "canonical": true, + "file": "service_manager.create_service_rollout.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 61, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CreateServiceRollout", + "fullName": "google.api.servicemanagement.v1.ServiceManager.CreateServiceRollout", + "async": true, + "parameters": [ + { + "name": "service_name", + "type": "TYPE_STRING" + }, + { + "name": "rollout", + "type": ".google.api.servicemanagement.v1.Rollout" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "ServiceManagerClient", + "fullName": "google.api.servicemanagement.v1.ServiceManagerClient" + }, + "method": { + "shortName": "CreateServiceRollout", + "fullName": "google.api.servicemanagement.v1.ServiceManager.CreateServiceRollout", + "service": { + "shortName": "ServiceManager", + "fullName": "google.api.servicemanagement.v1.ServiceManager" + } + } + } + }, + { + "regionTag": "servicemanagement_v1_generated_ServiceManager_GenerateConfigReport_async", + "title": "ServiceManager generateConfigReport Sample", + "origin": "API_DEFINITION", + "description": " Generates and returns a report (errors, warnings and changes from existing configurations) associated with GenerateConfigReportRequest.new_value If GenerateConfigReportRequest.old_value is specified, GenerateConfigReportRequest will contain a single ChangeReport based on the comparison between GenerateConfigReportRequest.new_value and GenerateConfigReportRequest.old_value. If GenerateConfigReportRequest.old_value is not specified, this method will compare GenerateConfigReportRequest.new_value with the last pushed service configuration.", + "canonical": true, + "file": "service_manager.generate_config_report.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 65, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GenerateConfigReport", + "fullName": "google.api.servicemanagement.v1.ServiceManager.GenerateConfigReport", + "async": true, + "parameters": [ + { + "name": "new_config", + "type": ".google.protobuf.Any" + }, + { + "name": "old_config", + "type": ".google.protobuf.Any" + } + ], + "resultType": ".google.api.servicemanagement.v1.GenerateConfigReportResponse", + "client": { + "shortName": "ServiceManagerClient", + "fullName": "google.api.servicemanagement.v1.ServiceManagerClient" + }, + "method": { + "shortName": "GenerateConfigReport", + "fullName": "google.api.servicemanagement.v1.ServiceManager.GenerateConfigReport", + "service": { + "shortName": "ServiceManager", + "fullName": "google.api.servicemanagement.v1.ServiceManager" + } + } + } + } + ] +} \ No newline at end of file diff --git a/packages/google-api-servicemanagement/samples/package.json b/packages/google-api-servicemanagement/samples/package.json index 82576f05578..7362919355c 100644 --- a/packages/google-api-servicemanagement/samples/package.json +++ b/packages/google-api-servicemanagement/samples/package.json @@ -4,7 +4,7 @@ "license": "Apache-2.0", "author": "Google LLC", "engines": { - "node": ">=12.0.0" + "node": ">=14.0.0" }, "files": [ "*.js" diff --git a/packages/google-api-servicemanagement/src/v1/service_manager_client.ts b/packages/google-api-servicemanagement/src/v1/service_manager_client.ts index 7ed815ba301..39d759de797 100644 --- a/packages/google-api-servicemanagement/src/v1/service_manager_client.ts +++ b/packages/google-api-servicemanagement/src/v1/service_manager_client.ts @@ -480,9 +480,8 @@ export class ServiceManagerClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.api.servicemanagement.v1.ManagedService | ManagedService}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.api.servicemanagement.v1.ManagedService|ManagedService}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/service_manager.get_service.js * region_tag:servicemanagement_v1_generated_ServiceManager_GetService_async @@ -581,9 +580,8 @@ export class ServiceManagerClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.api.Service | Service}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.api.Service|Service}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/service_manager.get_service_config.js * region_tag:servicemanagement_v1_generated_ServiceManager_GetServiceConfig_async @@ -673,7 +671,7 @@ export class ServiceManagerClient { * Creates a new service configuration (version) for a managed service. * This method only stores the service configuration. To roll out the service * configuration to backend systems please call - * {@link google.api.servicemanagement.v1.ServiceManager.CreateServiceRollout|CreateServiceRollout}. + * {@link protos.google.api.servicemanagement.v1.ServiceManager.CreateServiceRollout|CreateServiceRollout}. * * Only the 100 most recent service configurations and ones referenced by * existing rollouts are kept for each service. The rest will be deleted @@ -690,9 +688,8 @@ export class ServiceManagerClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.api.Service | Service}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.api.Service|Service}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/service_manager.create_service_config.js * region_tag:servicemanagement_v1_generated_ServiceManager_CreateServiceConfig_async @@ -779,7 +776,7 @@ export class ServiceManagerClient { } /** * Gets a service configuration - * {@link google.api.servicemanagement.v1.Rollout|rollout}. + * {@link protos.google.api.servicemanagement.v1.Rollout|rollout}. * * @param {Object} request * The request object that will be sent. @@ -792,9 +789,8 @@ export class ServiceManagerClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.api.servicemanagement.v1.Rollout | Rollout}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.api.servicemanagement.v1.Rollout|Rollout}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/service_manager.get_service_rollout.js * region_tag:servicemanagement_v1_generated_ServiceManager_GetServiceRollout_async @@ -898,21 +894,20 @@ export class ServiceManagerClient { * @param {google.protobuf.Any} request.newConfig * Required. Service configuration for which we want to generate the report. * For this version of API, the supported types are - * {@link google.api.servicemanagement.v1.ConfigRef|google.api.servicemanagement.v1.ConfigRef}, - * {@link google.api.servicemanagement.v1.ConfigSource|google.api.servicemanagement.v1.ConfigSource}, - * and {@link google.api.Service|google.api.Service} + * {@link protos.google.api.servicemanagement.v1.ConfigRef|google.api.servicemanagement.v1.ConfigRef}, + * {@link protos.google.api.servicemanagement.v1.ConfigSource|google.api.servicemanagement.v1.ConfigSource}, + * and {@link protos.google.api.Service|google.api.Service} * @param {google.protobuf.Any} [request.oldConfig] * Optional. Service configuration against which the comparison will be done. * For this version of API, the supported types are - * {@link google.api.servicemanagement.v1.ConfigRef|google.api.servicemanagement.v1.ConfigRef}, - * {@link google.api.servicemanagement.v1.ConfigSource|google.api.servicemanagement.v1.ConfigSource}, - * and {@link google.api.Service|google.api.Service} + * {@link protos.google.api.servicemanagement.v1.ConfigRef|google.api.servicemanagement.v1.ConfigRef}, + * {@link protos.google.api.servicemanagement.v1.ConfigSource|google.api.servicemanagement.v1.ConfigSource}, + * and {@link protos.google.api.Service|google.api.Service} * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.api.servicemanagement.v1.GenerateConfigReportResponse | GenerateConfigReportResponse}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.api.servicemanagement.v1.GenerateConfigReportResponse|GenerateConfigReportResponse}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/service_manager.generate_config_report.js * region_tag:servicemanagement_v1_generated_ServiceManager_GenerateConfigReport_async @@ -1017,8 +1012,7 @@ export class ServiceManagerClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/service_manager.create_service.js * region_tag:servicemanagement_v1_generated_ServiceManager_CreateService_async @@ -1109,8 +1103,7 @@ export class ServiceManagerClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/service_manager.create_service.js * region_tag:servicemanagement_v1_generated_ServiceManager_CreateService_async @@ -1142,7 +1135,7 @@ export class ServiceManagerClient { * Deletes a managed service. This method will change the service to the * `Soft-Delete` state for 30 days. Within this period, service producers may * call - * {@link google.api.servicemanagement.v1.ServiceManager.UndeleteService|UndeleteService} + * {@link protos.google.api.servicemanagement.v1.ServiceManager.UndeleteService|UndeleteService} * to restore the service. After 30 days, the service will be permanently * deleted. * @@ -1160,8 +1153,7 @@ export class ServiceManagerClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/service_manager.delete_service.js * region_tag:servicemanagement_v1_generated_ServiceManager_DeleteService_async @@ -1256,8 +1248,7 @@ export class ServiceManagerClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/service_manager.delete_service.js * region_tag:servicemanagement_v1_generated_ServiceManager_DeleteService_async @@ -1305,8 +1296,7 @@ export class ServiceManagerClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/service_manager.undelete_service.js * region_tag:servicemanagement_v1_generated_ServiceManager_UndeleteService_async @@ -1401,8 +1391,7 @@ export class ServiceManagerClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/service_manager.undelete_service.js * region_tag:servicemanagement_v1_generated_ServiceManager_UndeleteService_async @@ -1438,7 +1427,7 @@ export class ServiceManagerClient { * generated service configuration. To rollout the service configuration to * other services, * please call - * {@link google.api.servicemanagement.v1.ServiceManager.CreateServiceRollout|CreateServiceRollout}. + * {@link protos.google.api.servicemanagement.v1.ServiceManager.CreateServiceRollout|CreateServiceRollout}. * * Only the 100 most recent configuration sources and ones referenced by * existing service configurtions are kept for each service. The rest will be @@ -1464,8 +1453,7 @@ export class ServiceManagerClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/service_manager.submit_config_source.js * region_tag:servicemanagement_v1_generated_ServiceManager_SubmitConfigSource_async @@ -1560,8 +1548,7 @@ export class ServiceManagerClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/service_manager.submit_config_source.js * region_tag:servicemanagement_v1_generated_ServiceManager_SubmitConfigSource_async @@ -1619,8 +1606,7 @@ export class ServiceManagerClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/service_manager.create_service_rollout.js * region_tag:servicemanagement_v1_generated_ServiceManager_CreateServiceRollout_async @@ -1715,8 +1701,7 @@ export class ServiceManagerClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/service_manager.create_service_rollout.js * region_tag:servicemanagement_v1_generated_ServiceManager_CreateServiceRollout_async @@ -1770,14 +1755,13 @@ export class ServiceManagerClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.api.servicemanagement.v1.ManagedService | ManagedService}. + * The first element of the array is Array of {@link protos.google.api.servicemanagement.v1.ManagedService|ManagedService}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `listServicesAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listServices( @@ -1872,13 +1856,12 @@ export class ServiceManagerClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.api.servicemanagement.v1.ManagedService | ManagedService} on 'data' event. + * An object stream which emits an object representing {@link protos.google.api.servicemanagement.v1.ManagedService|ManagedService} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listServicesAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listServicesStream( @@ -1922,12 +1905,11 @@ export class ServiceManagerClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.api.servicemanagement.v1.ManagedService | ManagedService}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.api.servicemanagement.v1.ManagedService|ManagedService}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1/service_manager.list_services.js * region_tag:servicemanagement_v1_generated_ServiceManager_ListServices_async @@ -1967,14 +1949,13 @@ export class ServiceManagerClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.api.Service | Service}. + * The first element of the array is Array of {@link protos.google.api.Service|Service}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `listServiceConfigsAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listServiceConfigs( @@ -2068,13 +2049,12 @@ export class ServiceManagerClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.api.Service | Service} on 'data' event. + * An object stream which emits an object representing {@link protos.google.api.Service|Service} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listServiceConfigsAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listServiceConfigsStream( @@ -2117,12 +2097,11 @@ export class ServiceManagerClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.api.Service | Service}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.api.Service|Service}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1/service_manager.list_service_configs.js * region_tag:servicemanagement_v1_generated_ServiceManager_ListServiceConfigs_async @@ -2177,14 +2156,13 @@ export class ServiceManagerClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.api.servicemanagement.v1.Rollout | Rollout}. + * The first element of the array is Array of {@link protos.google.api.servicemanagement.v1.Rollout|Rollout}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `listServiceRolloutsAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listServiceRollouts( @@ -2289,13 +2267,12 @@ export class ServiceManagerClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.api.servicemanagement.v1.Rollout | Rollout} on 'data' event. + * An object stream which emits an object representing {@link protos.google.api.servicemanagement.v1.Rollout|Rollout} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listServiceRolloutsAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listServiceRolloutsStream( @@ -2349,12 +2326,11 @@ export class ServiceManagerClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.api.servicemanagement.v1.Rollout | Rollout}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.api.servicemanagement.v1.Rollout|Rollout}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1/service_manager.list_service_rollouts.js * region_tag:servicemanagement_v1_generated_ServiceManager_ListServiceRollouts_async @@ -2419,7 +2395,7 @@ export class ServiceManagerClient { IamProtos.google.iam.v1.GetIamPolicyRequest | null | undefined, {} | null | undefined > - ): Promise { + ): Promise<[IamProtos.google.iam.v1.Policy]> { return this.iamClient.getIamPolicy(request, options, callback); } @@ -2440,8 +2416,7 @@ export class ServiceManagerClient { * @param {string[]} request.permissions * The set of permissions to check for the `resource`. Permissions with * wildcards (such as '*' or 'storage.*') are not allowed. For more - * information see - * [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). + * information see {@link https://cloud.google.com/iam/docs/overview#permissions | IAM Overview }. * @param {Object} [options] * Optional parameters. You can override the default settings for this call, e.g, timeout, * retries, paginations, etc. See {@link https://googleapis.github.io/gax-nodejs/interfaces/CallOptions.html | gax.CallOptions} for the details. @@ -2467,7 +2442,7 @@ export class ServiceManagerClient { IamProtos.google.iam.v1.SetIamPolicyRequest | null | undefined, {} | null | undefined > - ): Promise { + ): Promise<[IamProtos.google.iam.v1.Policy]> { return this.iamClient.setIamPolicy(request, options, callback); } @@ -2488,8 +2463,7 @@ export class ServiceManagerClient { * @param {string[]} request.permissions * The set of permissions to check for the `resource`. Permissions with * wildcards (such as '*' or 'storage.*') are not allowed. For more - * information see - * [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). + * information see {@link https://cloud.google.com/iam/docs/overview#permissions | IAM Overview }. * @param {Object} [options] * Optional parameters. You can override the default settings for this call, e.g, timeout, * retries, paginations, etc. See {@link https://googleapis.github.io/gax-nodejs/interfaces/CallOptions.html | gax.CallOptions} for the details. @@ -2516,7 +2490,7 @@ export class ServiceManagerClient { IamProtos.google.iam.v1.TestIamPermissionsRequest | null | undefined, {} | null | undefined > - ): Promise { + ): Promise<[IamProtos.google.iam.v1.TestIamPermissionsResponse]> { return this.iamClient.testIamPermissions(request, options, callback); } diff --git a/packages/google-api-serviceusage/README.md b/packages/google-api-serviceusage/README.md index 87a5682bc94..3e848e0df9a 100644 --- a/packages/google-api-serviceusage/README.md +++ b/packages/google-api-serviceusage/README.md @@ -2,7 +2,7 @@ [//]: # "To regenerate it, use `python -m synthtool`." Google Cloud Platform logo -# [Service Usage: Node.js Client](https://github.com/googleapis/google-cloud-node) +# [Service Usage: Node.js Client](https://github.com/googleapis/google-cloud-node/tree/main/packages/google-api-serviceusage) [![release level](https://img.shields.io/badge/release%20level-stable-brightgreen.svg?style=flat)](https://cloud.google.com/terms/launch-stages) [![npm version](https://img.shields.io/npm/v/@google-cloud/service-usage.svg)](https://www.npmjs.org/package/@google-cloud/service-usage) @@ -81,37 +81,36 @@ listServices(); ## Samples -Samples are in the [`samples/`](https://github.com/googleapis/google-cloud-node/tree/main/samples) directory. Each sample's `README.md` has instructions for running its sample. +Samples are in the [`samples/`](https://github.com/googleapis/google-cloud-node/tree/main/packages/google-api-serviceusage/samples) directory. Each sample's `README.md` has instructions for running its sample. | Sample | Source Code | Try it | | --------------------------- | --------------------------------- | ------ | -| Service_usage.batch_enable_services | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-api-serviceusage/samples/generated/v1/service_usage.batch_enable_services.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-api-serviceusage/samples/generated/v1/service_usage.batch_enable_services.js,samples/README.md) | -| Service_usage.batch_get_services | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-api-serviceusage/samples/generated/v1/service_usage.batch_get_services.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-api-serviceusage/samples/generated/v1/service_usage.batch_get_services.js,samples/README.md) | -| Service_usage.disable_service | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-api-serviceusage/samples/generated/v1/service_usage.disable_service.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-api-serviceusage/samples/generated/v1/service_usage.disable_service.js,samples/README.md) | -| Service_usage.enable_service | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-api-serviceusage/samples/generated/v1/service_usage.enable_service.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-api-serviceusage/samples/generated/v1/service_usage.enable_service.js,samples/README.md) | -| Service_usage.get_service | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-api-serviceusage/samples/generated/v1/service_usage.get_service.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-api-serviceusage/samples/generated/v1/service_usage.get_service.js,samples/README.md) | -| Service_usage.list_services | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-api-serviceusage/samples/generated/v1/service_usage.list_services.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-api-serviceusage/samples/generated/v1/service_usage.list_services.js,samples/README.md) | -| Service_usage.batch_enable_services | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-api-serviceusage/samples/generated/v1beta1/service_usage.batch_enable_services.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-api-serviceusage/samples/generated/v1beta1/service_usage.batch_enable_services.js,samples/README.md) | -| Service_usage.create_admin_override | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-api-serviceusage/samples/generated/v1beta1/service_usage.create_admin_override.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-api-serviceusage/samples/generated/v1beta1/service_usage.create_admin_override.js,samples/README.md) | -| Service_usage.create_consumer_override | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-api-serviceusage/samples/generated/v1beta1/service_usage.create_consumer_override.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-api-serviceusage/samples/generated/v1beta1/service_usage.create_consumer_override.js,samples/README.md) | -| Service_usage.delete_admin_override | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-api-serviceusage/samples/generated/v1beta1/service_usage.delete_admin_override.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-api-serviceusage/samples/generated/v1beta1/service_usage.delete_admin_override.js,samples/README.md) | -| Service_usage.delete_consumer_override | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-api-serviceusage/samples/generated/v1beta1/service_usage.delete_consumer_override.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-api-serviceusage/samples/generated/v1beta1/service_usage.delete_consumer_override.js,samples/README.md) | -| Service_usage.disable_service | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-api-serviceusage/samples/generated/v1beta1/service_usage.disable_service.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-api-serviceusage/samples/generated/v1beta1/service_usage.disable_service.js,samples/README.md) | -| Service_usage.enable_service | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-api-serviceusage/samples/generated/v1beta1/service_usage.enable_service.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-api-serviceusage/samples/generated/v1beta1/service_usage.enable_service.js,samples/README.md) | -| Service_usage.generate_service_identity | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-api-serviceusage/samples/generated/v1beta1/service_usage.generate_service_identity.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-api-serviceusage/samples/generated/v1beta1/service_usage.generate_service_identity.js,samples/README.md) | -| Service_usage.get_consumer_quota_limit | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-api-serviceusage/samples/generated/v1beta1/service_usage.get_consumer_quota_limit.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-api-serviceusage/samples/generated/v1beta1/service_usage.get_consumer_quota_limit.js,samples/README.md) | -| Service_usage.get_consumer_quota_metric | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-api-serviceusage/samples/generated/v1beta1/service_usage.get_consumer_quota_metric.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-api-serviceusage/samples/generated/v1beta1/service_usage.get_consumer_quota_metric.js,samples/README.md) | -| Service_usage.get_service | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-api-serviceusage/samples/generated/v1beta1/service_usage.get_service.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-api-serviceusage/samples/generated/v1beta1/service_usage.get_service.js,samples/README.md) | -| Service_usage.import_admin_overrides | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-api-serviceusage/samples/generated/v1beta1/service_usage.import_admin_overrides.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-api-serviceusage/samples/generated/v1beta1/service_usage.import_admin_overrides.js,samples/README.md) | -| Service_usage.import_consumer_overrides | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-api-serviceusage/samples/generated/v1beta1/service_usage.import_consumer_overrides.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-api-serviceusage/samples/generated/v1beta1/service_usage.import_consumer_overrides.js,samples/README.md) | -| Service_usage.list_admin_overrides | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-api-serviceusage/samples/generated/v1beta1/service_usage.list_admin_overrides.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-api-serviceusage/samples/generated/v1beta1/service_usage.list_admin_overrides.js,samples/README.md) | -| Service_usage.list_consumer_overrides | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-api-serviceusage/samples/generated/v1beta1/service_usage.list_consumer_overrides.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-api-serviceusage/samples/generated/v1beta1/service_usage.list_consumer_overrides.js,samples/README.md) | -| Service_usage.list_consumer_quota_metrics | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-api-serviceusage/samples/generated/v1beta1/service_usage.list_consumer_quota_metrics.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-api-serviceusage/samples/generated/v1beta1/service_usage.list_consumer_quota_metrics.js,samples/README.md) | -| Service_usage.list_services | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-api-serviceusage/samples/generated/v1beta1/service_usage.list_services.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-api-serviceusage/samples/generated/v1beta1/service_usage.list_services.js,samples/README.md) | -| Service_usage.update_admin_override | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-api-serviceusage/samples/generated/v1beta1/service_usage.update_admin_override.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-api-serviceusage/samples/generated/v1beta1/service_usage.update_admin_override.js,samples/README.md) | -| Service_usage.update_consumer_override | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-api-serviceusage/samples/generated/v1beta1/service_usage.update_consumer_override.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-api-serviceusage/samples/generated/v1beta1/service_usage.update_consumer_override.js,samples/README.md) | -| Quickstart | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-api-serviceusage/samples/quickstart.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-api-serviceusage/samples/quickstart.js,samples/README.md) | -| Quickstart | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-api-serviceusage/samples/test/quickstart.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-api-serviceusage/samples/test/quickstart.js,samples/README.md) | +| Service_usage.batch_enable_services | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-api-serviceusage/samples/generated/v1/service_usage.batch_enable_services.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-api-serviceusage/samples/generated/v1/service_usage.batch_enable_services.js,packages/google-api-serviceusage/samples/README.md) | +| Service_usage.batch_get_services | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-api-serviceusage/samples/generated/v1/service_usage.batch_get_services.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-api-serviceusage/samples/generated/v1/service_usage.batch_get_services.js,packages/google-api-serviceusage/samples/README.md) | +| Service_usage.disable_service | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-api-serviceusage/samples/generated/v1/service_usage.disable_service.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-api-serviceusage/samples/generated/v1/service_usage.disable_service.js,packages/google-api-serviceusage/samples/README.md) | +| Service_usage.enable_service | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-api-serviceusage/samples/generated/v1/service_usage.enable_service.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-api-serviceusage/samples/generated/v1/service_usage.enable_service.js,packages/google-api-serviceusage/samples/README.md) | +| Service_usage.get_service | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-api-serviceusage/samples/generated/v1/service_usage.get_service.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-api-serviceusage/samples/generated/v1/service_usage.get_service.js,packages/google-api-serviceusage/samples/README.md) | +| Service_usage.list_services | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-api-serviceusage/samples/generated/v1/service_usage.list_services.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-api-serviceusage/samples/generated/v1/service_usage.list_services.js,packages/google-api-serviceusage/samples/README.md) | +| Service_usage.batch_enable_services | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-api-serviceusage/samples/generated/v1beta1/service_usage.batch_enable_services.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-api-serviceusage/samples/generated/v1beta1/service_usage.batch_enable_services.js,packages/google-api-serviceusage/samples/README.md) | +| Service_usage.create_admin_override | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-api-serviceusage/samples/generated/v1beta1/service_usage.create_admin_override.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-api-serviceusage/samples/generated/v1beta1/service_usage.create_admin_override.js,packages/google-api-serviceusage/samples/README.md) | +| Service_usage.create_consumer_override | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-api-serviceusage/samples/generated/v1beta1/service_usage.create_consumer_override.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-api-serviceusage/samples/generated/v1beta1/service_usage.create_consumer_override.js,packages/google-api-serviceusage/samples/README.md) | +| Service_usage.delete_admin_override | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-api-serviceusage/samples/generated/v1beta1/service_usage.delete_admin_override.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-api-serviceusage/samples/generated/v1beta1/service_usage.delete_admin_override.js,packages/google-api-serviceusage/samples/README.md) | +| Service_usage.delete_consumer_override | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-api-serviceusage/samples/generated/v1beta1/service_usage.delete_consumer_override.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-api-serviceusage/samples/generated/v1beta1/service_usage.delete_consumer_override.js,packages/google-api-serviceusage/samples/README.md) | +| Service_usage.disable_service | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-api-serviceusage/samples/generated/v1beta1/service_usage.disable_service.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-api-serviceusage/samples/generated/v1beta1/service_usage.disable_service.js,packages/google-api-serviceusage/samples/README.md) | +| Service_usage.enable_service | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-api-serviceusage/samples/generated/v1beta1/service_usage.enable_service.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-api-serviceusage/samples/generated/v1beta1/service_usage.enable_service.js,packages/google-api-serviceusage/samples/README.md) | +| Service_usage.generate_service_identity | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-api-serviceusage/samples/generated/v1beta1/service_usage.generate_service_identity.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-api-serviceusage/samples/generated/v1beta1/service_usage.generate_service_identity.js,packages/google-api-serviceusage/samples/README.md) | +| Service_usage.get_consumer_quota_limit | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-api-serviceusage/samples/generated/v1beta1/service_usage.get_consumer_quota_limit.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-api-serviceusage/samples/generated/v1beta1/service_usage.get_consumer_quota_limit.js,packages/google-api-serviceusage/samples/README.md) | +| Service_usage.get_consumer_quota_metric | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-api-serviceusage/samples/generated/v1beta1/service_usage.get_consumer_quota_metric.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-api-serviceusage/samples/generated/v1beta1/service_usage.get_consumer_quota_metric.js,packages/google-api-serviceusage/samples/README.md) | +| Service_usage.get_service | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-api-serviceusage/samples/generated/v1beta1/service_usage.get_service.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-api-serviceusage/samples/generated/v1beta1/service_usage.get_service.js,packages/google-api-serviceusage/samples/README.md) | +| Service_usage.import_admin_overrides | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-api-serviceusage/samples/generated/v1beta1/service_usage.import_admin_overrides.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-api-serviceusage/samples/generated/v1beta1/service_usage.import_admin_overrides.js,packages/google-api-serviceusage/samples/README.md) | +| Service_usage.import_consumer_overrides | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-api-serviceusage/samples/generated/v1beta1/service_usage.import_consumer_overrides.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-api-serviceusage/samples/generated/v1beta1/service_usage.import_consumer_overrides.js,packages/google-api-serviceusage/samples/README.md) | +| Service_usage.list_admin_overrides | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-api-serviceusage/samples/generated/v1beta1/service_usage.list_admin_overrides.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-api-serviceusage/samples/generated/v1beta1/service_usage.list_admin_overrides.js,packages/google-api-serviceusage/samples/README.md) | +| Service_usage.list_consumer_overrides | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-api-serviceusage/samples/generated/v1beta1/service_usage.list_consumer_overrides.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-api-serviceusage/samples/generated/v1beta1/service_usage.list_consumer_overrides.js,packages/google-api-serviceusage/samples/README.md) | +| Service_usage.list_consumer_quota_metrics | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-api-serviceusage/samples/generated/v1beta1/service_usage.list_consumer_quota_metrics.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-api-serviceusage/samples/generated/v1beta1/service_usage.list_consumer_quota_metrics.js,packages/google-api-serviceusage/samples/README.md) | +| Service_usage.list_services | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-api-serviceusage/samples/generated/v1beta1/service_usage.list_services.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-api-serviceusage/samples/generated/v1beta1/service_usage.list_services.js,packages/google-api-serviceusage/samples/README.md) | +| Service_usage.update_admin_override | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-api-serviceusage/samples/generated/v1beta1/service_usage.update_admin_override.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-api-serviceusage/samples/generated/v1beta1/service_usage.update_admin_override.js,packages/google-api-serviceusage/samples/README.md) | +| Service_usage.update_consumer_override | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-api-serviceusage/samples/generated/v1beta1/service_usage.update_consumer_override.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-api-serviceusage/samples/generated/v1beta1/service_usage.update_consumer_override.js,packages/google-api-serviceusage/samples/README.md) | +| Quickstart | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-api-serviceusage/samples/quickstart.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-api-serviceusage/samples/quickstart.js,packages/google-api-serviceusage/samples/README.md) | diff --git a/packages/google-api-serviceusage/package.json b/packages/google-api-serviceusage/package.json index 052d670243b..6506d138ed0 100644 --- a/packages/google-api-serviceusage/package.json +++ b/packages/google-api-serviceusage/package.json @@ -45,14 +45,15 @@ "test": "c8 mocha build/test" }, "dependencies": { - "google-gax": "^3.5.8" + "google-gax": "^4.0.3" }, "devDependencies": { "@types/mocha": "^9.0.0", - "@types/node": "^18.0.0", + "@types/node": "^20.4.5", "@types/sinon": "^10.0.0", "c8": "^7.7.2", - "gts": "^3.1.0", + "gapic-tools": "^0.1.8", + "gts": "^5.0.0", "jsdoc": "^4.0.0", "jsdoc-fresh": "^2.0.0", "jsdoc-region-tag": "^2.0.0", @@ -63,12 +64,12 @@ "pack-n-play": "^1.0.0-2", "sinon": "^15.0.0", "ts-loader": "^9.1.2", - "typescript": "^4.6.4", + "typescript": "^5.1.6", "webpack": "^5.36.2", "webpack-cli": "^5.0.0" }, "engines": { - "node": ">=12.0.0" + "node": ">=14.0.0" }, "homepage": "https://github.com/googleapis/google-cloud-node/tree/main/packages/google-api-serviceusage" } diff --git a/packages/google-api-serviceusage/samples/README.md b/packages/google-api-serviceusage/samples/README.md index c0e5b27eef2..95a1a07b196 100644 --- a/packages/google-api-serviceusage/samples/README.md +++ b/packages/google-api-serviceusage/samples/README.md @@ -38,7 +38,6 @@ * [Service_usage.update_admin_override](#service_usage.update_admin_override) * [Service_usage.update_consumer_override](#service_usage.update_consumer_override) * [Quickstart](#quickstart) - * [Quickstart](#quickstart) ## Before you begin @@ -492,23 +491,6 @@ __Usage:__ `node packages/google-api-serviceusage/samples/quickstart.js` ------ - - - - -### Quickstart - -View the [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-api-serviceusage/samples/test/quickstart.js). - -[![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-api-serviceusage/samples/test/quickstart.js,samples/README.md) - -__Usage:__ - - -`node packages/google-api-serviceusage/samples/test/quickstart.js` - - diff --git a/packages/google-api-serviceusage/samples/generated/v1/service_usage.batch_enable_services.js b/packages/google-api-serviceusage/samples/generated/v1/service_usage.batch_enable_services.js index 16b82fcaccd..07429622652 100644 --- a/packages/google-api-serviceusage/samples/generated/v1/service_usage.batch_enable_services.js +++ b/packages/google-api-serviceusage/samples/generated/v1/service_usage.batch_enable_services.js @@ -45,7 +45,7 @@ function main() { * than 20 services are specified, the request will fail, and no state changes * will occur. */ - // const serviceIds = 'abc123' + // const serviceIds = ['abc','def'] // Imports the Serviceusage library const {ServiceUsageClient} = require('@google-cloud/service-usage').v1; diff --git a/packages/google-api-serviceusage/samples/generated/v1/service_usage.batch_get_services.js b/packages/google-api-serviceusage/samples/generated/v1/service_usage.batch_get_services.js index 2be2e5de93d..a1779ada834 100644 --- a/packages/google-api-serviceusage/samples/generated/v1/service_usage.batch_get_services.js +++ b/packages/google-api-serviceusage/samples/generated/v1/service_usage.batch_get_services.js @@ -43,7 +43,7 @@ function main() { * project number. * A single request can get a maximum of 30 services at a time. */ - // const names = 'abc123' + // const names = ['abc','def'] // Imports the Serviceusage library const {ServiceUsageClient} = require('@google-cloud/service-usage').v1; diff --git a/packages/google-api-serviceusage/samples/generated/v1/snippet_metadata.google.api.serviceusage.v1.json b/packages/google-api-serviceusage/samples/generated/v1/snippet_metadata.google.api.serviceusage.v1.json index 19145b9406f..a15352b3a9b 100644 --- a/packages/google-api-serviceusage/samples/generated/v1/snippet_metadata.google.api.serviceusage.v1.json +++ b/packages/google-api-serviceusage/samples/generated/v1/snippet_metadata.google.api.serviceusage.v1.json @@ -1,7 +1,7 @@ { "clientLibrary": { "name": "nodejs-serviceusage", - "version": "2.2.1", + "version": "2.2.2", "language": "TYPESCRIPT", "apis": [ { diff --git a/packages/google-api-serviceusage/samples/generated/v1/snippet_metadata_google.api.serviceusage.v1.json b/packages/google-api-serviceusage/samples/generated/v1/snippet_metadata_google.api.serviceusage.v1.json new file mode 100644 index 00000000000..a15352b3a9b --- /dev/null +++ b/packages/google-api-serviceusage/samples/generated/v1/snippet_metadata_google.api.serviceusage.v1.json @@ -0,0 +1,283 @@ +{ + "clientLibrary": { + "name": "nodejs-serviceusage", + "version": "2.2.2", + "language": "TYPESCRIPT", + "apis": [ + { + "id": "google.api.serviceusage.v1", + "version": "v1" + } + ] + }, + "snippets": [ + { + "regionTag": "serviceusage_v1_generated_ServiceUsage_EnableService_async", + "title": "ServiceUsage enableService Sample", + "origin": "API_DEFINITION", + "description": " Enable a service so that it can be used with a project.", + "canonical": true, + "file": "service_usage.enable_service.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 60, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "EnableService", + "fullName": "google.api.serviceusage.v1.ServiceUsage.EnableService", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "ServiceUsageClient", + "fullName": "google.api.serviceusage.v1.ServiceUsageClient" + }, + "method": { + "shortName": "EnableService", + "fullName": "google.api.serviceusage.v1.ServiceUsage.EnableService", + "service": { + "shortName": "ServiceUsage", + "fullName": "google.api.serviceusage.v1.ServiceUsage" + } + } + } + }, + { + "regionTag": "serviceusage_v1_generated_ServiceUsage_DisableService_async", + "title": "ServiceUsage disableService Sample", + "origin": "API_DEFINITION", + "description": " Disable a service so that it can no longer be used with a project. This prevents unintended usage that may cause unexpected billing charges or security leaks. It is not valid to call the disable method on a service that is not currently enabled. Callers will receive a `FAILED_PRECONDITION` status if the target service is not currently enabled.", + "canonical": true, + "file": "service_usage.disable_service.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 69, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DisableService", + "fullName": "google.api.serviceusage.v1.ServiceUsage.DisableService", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + }, + { + "name": "disable_dependent_services", + "type": "TYPE_BOOL" + }, + { + "name": "check_if_service_has_usage", + "type": ".google.api.serviceusage.v1.DisableServiceRequest.CheckIfServiceHasUsage" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "ServiceUsageClient", + "fullName": "google.api.serviceusage.v1.ServiceUsageClient" + }, + "method": { + "shortName": "DisableService", + "fullName": "google.api.serviceusage.v1.ServiceUsage.DisableService", + "service": { + "shortName": "ServiceUsage", + "fullName": "google.api.serviceusage.v1.ServiceUsage" + } + } + } + }, + { + "regionTag": "serviceusage_v1_generated_ServiceUsage_GetService_async", + "title": "ServiceUsage getService Sample", + "origin": "API_DEFINITION", + "description": " Returns the service configuration and enabled state for a given service.", + "canonical": true, + "file": "service_usage.get_service.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 55, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetService", + "fullName": "google.api.serviceusage.v1.ServiceUsage.GetService", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.api.serviceusage.v1.Service", + "client": { + "shortName": "ServiceUsageClient", + "fullName": "google.api.serviceusage.v1.ServiceUsageClient" + }, + "method": { + "shortName": "GetService", + "fullName": "google.api.serviceusage.v1.ServiceUsage.GetService", + "service": { + "shortName": "ServiceUsage", + "fullName": "google.api.serviceusage.v1.ServiceUsage" + } + } + } + }, + { + "regionTag": "serviceusage_v1_generated_ServiceUsage_ListServices_async", + "title": "ServiceUsage listServices Sample", + "origin": "API_DEFINITION", + "description": " List all services available to the specified project, and the current state of those services with respect to the project. The list includes all public services, all services for which the calling user has the `servicemanagement.services.bind` permission, and all services that have already been enabled on the project. The list can be filtered to only include services in a specific state, for example to only include services enabled on the project. WARNING: If you need to query enabled services frequently or across an organization, you should use [Cloud Asset Inventory API](https://cloud.google.com/asset-inventory/docs/apis), which provides higher throughput and richer filtering capability.", + "canonical": true, + "file": "service_usage.list_services.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 72, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListServices", + "fullName": "google.api.serviceusage.v1.ServiceUsage.ListServices", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "filter", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.api.serviceusage.v1.ListServicesResponse", + "client": { + "shortName": "ServiceUsageClient", + "fullName": "google.api.serviceusage.v1.ServiceUsageClient" + }, + "method": { + "shortName": "ListServices", + "fullName": "google.api.serviceusage.v1.ServiceUsage.ListServices", + "service": { + "shortName": "ServiceUsage", + "fullName": "google.api.serviceusage.v1.ServiceUsage" + } + } + } + }, + { + "regionTag": "serviceusage_v1_generated_ServiceUsage_BatchEnableServices_async", + "title": "ServiceUsage batchEnableServices Sample", + "origin": "API_DEFINITION", + "description": " Enable multiple services on a project. The operation is atomic: if enabling any service fails, then the entire batch fails, and no state changes occur. To enable a single service, use the `EnableService` method instead.", + "canonical": true, + "file": "service_usage.batch_enable_services.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 67, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "BatchEnableServices", + "fullName": "google.api.serviceusage.v1.ServiceUsage.BatchEnableServices", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "service_ids", + "type": "TYPE_STRING[]" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "ServiceUsageClient", + "fullName": "google.api.serviceusage.v1.ServiceUsageClient" + }, + "method": { + "shortName": "BatchEnableServices", + "fullName": "google.api.serviceusage.v1.ServiceUsage.BatchEnableServices", + "service": { + "shortName": "ServiceUsage", + "fullName": "google.api.serviceusage.v1.ServiceUsage" + } + } + } + }, + { + "regionTag": "serviceusage_v1_generated_ServiceUsage_BatchGetServices_async", + "title": "ServiceUsage batchGetServices Sample", + "origin": "API_DEFINITION", + "description": " Returns the service configurations and enabled states for a given list of services.", + "canonical": true, + "file": "service_usage.batch_get_services.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 64, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "BatchGetServices", + "fullName": "google.api.serviceusage.v1.ServiceUsage.BatchGetServices", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "names", + "type": "TYPE_STRING[]" + } + ], + "resultType": ".google.api.serviceusage.v1.BatchGetServicesResponse", + "client": { + "shortName": "ServiceUsageClient", + "fullName": "google.api.serviceusage.v1.ServiceUsageClient" + }, + "method": { + "shortName": "BatchGetServices", + "fullName": "google.api.serviceusage.v1.ServiceUsage.BatchGetServices", + "service": { + "shortName": "ServiceUsage", + "fullName": "google.api.serviceusage.v1.ServiceUsage" + } + } + } + } + ] +} \ No newline at end of file diff --git a/packages/google-api-serviceusage/samples/generated/v1beta1/service_usage.batch_enable_services.js b/packages/google-api-serviceusage/samples/generated/v1beta1/service_usage.batch_enable_services.js index 6d80ca26fde..fa233909ba7 100644 --- a/packages/google-api-serviceusage/samples/generated/v1beta1/service_usage.batch_enable_services.js +++ b/packages/google-api-serviceusage/samples/generated/v1beta1/service_usage.batch_enable_services.js @@ -48,7 +48,7 @@ function main() { * than 20 services are specified, the request will fail, and no state changes * will occur. */ - // const serviceIds = 'abc123' + // const serviceIds = ['abc','def'] // Imports the Serviceusage library const {ServiceUsageClient} = require('@google-cloud/service-usage').v1beta1; diff --git a/packages/google-api-serviceusage/samples/generated/v1beta1/service_usage.create_admin_override.js b/packages/google-api-serviceusage/samples/generated/v1beta1/service_usage.create_admin_override.js index e33bc33dd4d..7899e5c9c7b 100644 --- a/packages/google-api-serviceusage/samples/generated/v1beta1/service_usage.create_admin_override.js +++ b/packages/google-api-serviceusage/samples/generated/v1beta1/service_usage.create_admin_override.js @@ -51,7 +51,7 @@ function main() { * 'force_only' field ignores only the specified checks; other checks are * still enforced. The 'force' and 'force_only' fields cannot both be set. */ - // const forceOnly = 1234 + // const forceOnly = [1,2,3,4] // Imports the Serviceusage library const {ServiceUsageClient} = require('@google-cloud/service-usage').v1beta1; diff --git a/packages/google-api-serviceusage/samples/generated/v1beta1/service_usage.create_consumer_override.js b/packages/google-api-serviceusage/samples/generated/v1beta1/service_usage.create_consumer_override.js index a8d42b0c9a2..fe7bcfcd6cb 100644 --- a/packages/google-api-serviceusage/samples/generated/v1beta1/service_usage.create_consumer_override.js +++ b/packages/google-api-serviceusage/samples/generated/v1beta1/service_usage.create_consumer_override.js @@ -51,7 +51,7 @@ function main() { * 'force_only' field ignores only the specified checks; other checks are * still enforced. The 'force' and 'force_only' fields cannot both be set. */ - // const forceOnly = 1234 + // const forceOnly = [1,2,3,4] // Imports the Serviceusage library const {ServiceUsageClient} = require('@google-cloud/service-usage').v1beta1; diff --git a/packages/google-api-serviceusage/samples/generated/v1beta1/service_usage.delete_admin_override.js b/packages/google-api-serviceusage/samples/generated/v1beta1/service_usage.delete_admin_override.js index 1b7c5c2d9fe..9ccd518918b 100644 --- a/packages/google-api-serviceusage/samples/generated/v1beta1/service_usage.delete_admin_override.js +++ b/packages/google-api-serviceusage/samples/generated/v1beta1/service_usage.delete_admin_override.js @@ -46,7 +46,7 @@ function main() { * 'force_only' field ignores only the specified checks; other checks are * still enforced. The 'force' and 'force_only' fields cannot both be set. */ - // const forceOnly = 1234 + // const forceOnly = [1,2,3,4] // Imports the Serviceusage library const {ServiceUsageClient} = require('@google-cloud/service-usage').v1beta1; diff --git a/packages/google-api-serviceusage/samples/generated/v1beta1/service_usage.delete_consumer_override.js b/packages/google-api-serviceusage/samples/generated/v1beta1/service_usage.delete_consumer_override.js index 62ade9ed87c..97b813ebb2a 100644 --- a/packages/google-api-serviceusage/samples/generated/v1beta1/service_usage.delete_consumer_override.js +++ b/packages/google-api-serviceusage/samples/generated/v1beta1/service_usage.delete_consumer_override.js @@ -46,7 +46,7 @@ function main() { * 'force_only' field ignores only the specified checks; other checks are * still enforced. The 'force' and 'force_only' fields cannot both be set. */ - // const forceOnly = 1234 + // const forceOnly = [1,2,3,4] // Imports the Serviceusage library const {ServiceUsageClient} = require('@google-cloud/service-usage').v1beta1; diff --git a/packages/google-api-serviceusage/samples/generated/v1beta1/service_usage.import_admin_overrides.js b/packages/google-api-serviceusage/samples/generated/v1beta1/service_usage.import_admin_overrides.js index 8247ab8e07d..a1d8459256f 100644 --- a/packages/google-api-serviceusage/samples/generated/v1beta1/service_usage.import_admin_overrides.js +++ b/packages/google-api-serviceusage/samples/generated/v1beta1/service_usage.import_admin_overrides.js @@ -50,7 +50,7 @@ function main() { * 'force_only' field ignores only the specified checks; other checks are * still enforced. The 'force' and 'force_only' fields cannot both be set. */ - // const forceOnly = 1234 + // const forceOnly = [1,2,3,4] // Imports the Serviceusage library const {ServiceUsageClient} = require('@google-cloud/service-usage').v1beta1; diff --git a/packages/google-api-serviceusage/samples/generated/v1beta1/service_usage.import_consumer_overrides.js b/packages/google-api-serviceusage/samples/generated/v1beta1/service_usage.import_consumer_overrides.js index 8fc0742fac5..810777caa20 100644 --- a/packages/google-api-serviceusage/samples/generated/v1beta1/service_usage.import_consumer_overrides.js +++ b/packages/google-api-serviceusage/samples/generated/v1beta1/service_usage.import_consumer_overrides.js @@ -50,7 +50,7 @@ function main() { * 'force_only' field ignores only the specified checks; other checks are * still enforced. The 'force' and 'force_only' fields cannot both be set. */ - // const forceOnly = 1234 + // const forceOnly = [1,2,3,4] // Imports the Serviceusage library const {ServiceUsageClient} = require('@google-cloud/service-usage').v1beta1; diff --git a/packages/google-api-serviceusage/samples/generated/v1beta1/service_usage.update_admin_override.js b/packages/google-api-serviceusage/samples/generated/v1beta1/service_usage.update_admin_override.js index 5789e720fd7..9a890ab1698 100644 --- a/packages/google-api-serviceusage/samples/generated/v1beta1/service_usage.update_admin_override.js +++ b/packages/google-api-serviceusage/samples/generated/v1beta1/service_usage.update_admin_override.js @@ -56,7 +56,7 @@ function main() { * 'force_only' field ignores only the specified checks; other checks are * still enforced. The 'force' and 'force_only' fields cannot both be set. */ - // const forceOnly = 1234 + // const forceOnly = [1,2,3,4] // Imports the Serviceusage library const {ServiceUsageClient} = require('@google-cloud/service-usage').v1beta1; diff --git a/packages/google-api-serviceusage/samples/generated/v1beta1/service_usage.update_consumer_override.js b/packages/google-api-serviceusage/samples/generated/v1beta1/service_usage.update_consumer_override.js index 3760a10f039..35107c2af4c 100644 --- a/packages/google-api-serviceusage/samples/generated/v1beta1/service_usage.update_consumer_override.js +++ b/packages/google-api-serviceusage/samples/generated/v1beta1/service_usage.update_consumer_override.js @@ -56,7 +56,7 @@ function main() { * 'force_only' field ignores only the specified checks; other checks are * still enforced. The 'force' and 'force_only' fields cannot both be set. */ - // const forceOnly = 1234 + // const forceOnly = [1,2,3,4] // Imports the Serviceusage library const {ServiceUsageClient} = require('@google-cloud/service-usage').v1beta1; diff --git a/packages/google-api-serviceusage/samples/generated/v1beta1/snippet_metadata.google.api.serviceusage.v1beta1.json b/packages/google-api-serviceusage/samples/generated/v1beta1/snippet_metadata.google.api.serviceusage.v1beta1.json index 32597a6c552..d61c3822f43 100644 --- a/packages/google-api-serviceusage/samples/generated/v1beta1/snippet_metadata.google.api.serviceusage.v1beta1.json +++ b/packages/google-api-serviceusage/samples/generated/v1beta1/snippet_metadata.google.api.serviceusage.v1beta1.json @@ -1,7 +1,7 @@ { "clientLibrary": { "name": "nodejs-serviceusage", - "version": "2.2.1", + "version": "2.2.2", "language": "TYPESCRIPT", "apis": [ { diff --git a/packages/google-api-serviceusage/samples/generated/v1beta1/snippet_metadata_google.api.serviceusage.v1beta1.json b/packages/google-api-serviceusage/samples/generated/v1beta1/snippet_metadata_google.api.serviceusage.v1beta1.json new file mode 100644 index 00000000000..d61c3822f43 --- /dev/null +++ b/packages/google-api-serviceusage/samples/generated/v1beta1/snippet_metadata_google.api.serviceusage.v1beta1.json @@ -0,0 +1,923 @@ +{ + "clientLibrary": { + "name": "nodejs-serviceusage", + "version": "2.2.2", + "language": "TYPESCRIPT", + "apis": [ + { + "id": "google.api.serviceusage.v1beta1", + "version": "v1beta1" + } + ] + }, + "snippets": [ + { + "regionTag": "serviceusage_v1beta1_generated_ServiceUsage_EnableService_async", + "title": "ServiceUsage enableService Sample", + "origin": "API_DEFINITION", + "description": " Enables a service so that it can be used with a project. Operation response type: `google.protobuf.Empty`", + "canonical": true, + "file": "service_usage.enable_service.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 60, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "EnableService", + "fullName": "google.api.serviceusage.v1beta1.ServiceUsage.EnableService", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "ServiceUsageClient", + "fullName": "google.api.serviceusage.v1beta1.ServiceUsageClient" + }, + "method": { + "shortName": "EnableService", + "fullName": "google.api.serviceusage.v1beta1.ServiceUsage.EnableService", + "service": { + "shortName": "ServiceUsage", + "fullName": "google.api.serviceusage.v1beta1.ServiceUsage" + } + } + } + }, + { + "regionTag": "serviceusage_v1beta1_generated_ServiceUsage_DisableService_async", + "title": "ServiceUsage disableService Sample", + "origin": "API_DEFINITION", + "description": " Disables a service so that it can no longer be used with a project. This prevents unintended usage that may cause unexpected billing charges or security leaks. It is not valid to call the disable method on a service that is not currently enabled. Callers will receive a `FAILED_PRECONDITION` status if the target service is not currently enabled. Operation response type: `google.protobuf.Empty`", + "canonical": true, + "file": "service_usage.disable_service.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 57, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DisableService", + "fullName": "google.api.serviceusage.v1beta1.ServiceUsage.DisableService", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "ServiceUsageClient", + "fullName": "google.api.serviceusage.v1beta1.ServiceUsageClient" + }, + "method": { + "shortName": "DisableService", + "fullName": "google.api.serviceusage.v1beta1.ServiceUsage.DisableService", + "service": { + "shortName": "ServiceUsage", + "fullName": "google.api.serviceusage.v1beta1.ServiceUsage" + } + } + } + }, + { + "regionTag": "serviceusage_v1beta1_generated_ServiceUsage_GetService_async", + "title": "ServiceUsage getService Sample", + "origin": "API_DEFINITION", + "description": " Returns the service configuration and enabled state for a given service.", + "canonical": true, + "file": "service_usage.get_service.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 55, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetService", + "fullName": "google.api.serviceusage.v1beta1.ServiceUsage.GetService", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.api.serviceusage.v1beta1.Service", + "client": { + "shortName": "ServiceUsageClient", + "fullName": "google.api.serviceusage.v1beta1.ServiceUsageClient" + }, + "method": { + "shortName": "GetService", + "fullName": "google.api.serviceusage.v1beta1.ServiceUsage.GetService", + "service": { + "shortName": "ServiceUsage", + "fullName": "google.api.serviceusage.v1beta1.ServiceUsage" + } + } + } + }, + { + "regionTag": "serviceusage_v1beta1_generated_ServiceUsage_ListServices_async", + "title": "ServiceUsage listServices Sample", + "origin": "API_DEFINITION", + "description": " Lists all services available to the specified project, and the current state of those services with respect to the project. The list includes all public services, all services for which the calling user has the `servicemanagement.services.bind` permission, and all services that have already been enabled on the project. The list can be filtered to only include services in a specific state, for example to only include services enabled on the project.", + "canonical": true, + "file": "service_usage.list_services.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 73, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListServices", + "fullName": "google.api.serviceusage.v1beta1.ServiceUsage.ListServices", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "filter", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.api.serviceusage.v1beta1.ListServicesResponse", + "client": { + "shortName": "ServiceUsageClient", + "fullName": "google.api.serviceusage.v1beta1.ServiceUsageClient" + }, + "method": { + "shortName": "ListServices", + "fullName": "google.api.serviceusage.v1beta1.ServiceUsage.ListServices", + "service": { + "shortName": "ServiceUsage", + "fullName": "google.api.serviceusage.v1beta1.ServiceUsage" + } + } + } + }, + { + "regionTag": "serviceusage_v1beta1_generated_ServiceUsage_BatchEnableServices_async", + "title": "ServiceUsage batchEnableServices Sample", + "origin": "API_DEFINITION", + "description": " Enables multiple services on a project. The operation is atomic: if enabling any service fails, then the entire batch fails, and no state changes occur. Operation response type: `google.protobuf.Empty`", + "canonical": true, + "file": "service_usage.batch_enable_services.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 70, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "BatchEnableServices", + "fullName": "google.api.serviceusage.v1beta1.ServiceUsage.BatchEnableServices", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "service_ids", + "type": "TYPE_STRING[]" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "ServiceUsageClient", + "fullName": "google.api.serviceusage.v1beta1.ServiceUsageClient" + }, + "method": { + "shortName": "BatchEnableServices", + "fullName": "google.api.serviceusage.v1beta1.ServiceUsage.BatchEnableServices", + "service": { + "shortName": "ServiceUsage", + "fullName": "google.api.serviceusage.v1beta1.ServiceUsage" + } + } + } + }, + { + "regionTag": "serviceusage_v1beta1_generated_ServiceUsage_ListConsumerQuotaMetrics_async", + "title": "ServiceUsage listConsumerQuotaMetrics Sample", + "origin": "API_DEFINITION", + "description": " Retrieves a summary of all quota information visible to the service consumer, organized by service metric. Each metric includes information about all of its defined limits. Each limit includes the limit configuration (quota unit, preciseness, default value), the current effective limit value, and all of the overrides applied to the limit.", + "canonical": true, + "file": "service_usage.list_consumer_quota_metrics.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 71, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListConsumerQuotaMetrics", + "fullName": "google.api.serviceusage.v1beta1.ServiceUsage.ListConsumerQuotaMetrics", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "view", + "type": ".google.api.serviceusage.v1beta1.QuotaView" + } + ], + "resultType": ".google.api.serviceusage.v1beta1.ListConsumerQuotaMetricsResponse", + "client": { + "shortName": "ServiceUsageClient", + "fullName": "google.api.serviceusage.v1beta1.ServiceUsageClient" + }, + "method": { + "shortName": "ListConsumerQuotaMetrics", + "fullName": "google.api.serviceusage.v1beta1.ServiceUsage.ListConsumerQuotaMetrics", + "service": { + "shortName": "ServiceUsage", + "fullName": "google.api.serviceusage.v1beta1.ServiceUsage" + } + } + } + }, + { + "regionTag": "serviceusage_v1beta1_generated_ServiceUsage_GetConsumerQuotaMetric_async", + "title": "ServiceUsage getConsumerQuotaMetric Sample", + "origin": "API_DEFINITION", + "description": " Retrieves a summary of quota information for a specific quota metric", + "canonical": true, + "file": "service_usage.get_consumer_quota_metric.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 58, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetConsumerQuotaMetric", + "fullName": "google.api.serviceusage.v1beta1.ServiceUsage.GetConsumerQuotaMetric", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + }, + { + "name": "view", + "type": ".google.api.serviceusage.v1beta1.QuotaView" + } + ], + "resultType": ".google.api.serviceusage.v1beta1.ConsumerQuotaMetric", + "client": { + "shortName": "ServiceUsageClient", + "fullName": "google.api.serviceusage.v1beta1.ServiceUsageClient" + }, + "method": { + "shortName": "GetConsumerQuotaMetric", + "fullName": "google.api.serviceusage.v1beta1.ServiceUsage.GetConsumerQuotaMetric", + "service": { + "shortName": "ServiceUsage", + "fullName": "google.api.serviceusage.v1beta1.ServiceUsage" + } + } + } + }, + { + "regionTag": "serviceusage_v1beta1_generated_ServiceUsage_GetConsumerQuotaLimit_async", + "title": "ServiceUsage getConsumerQuotaLimit Sample", + "origin": "API_DEFINITION", + "description": " Retrieves a summary of quota information for a specific quota limit.", + "canonical": true, + "file": "service_usage.get_consumer_quota_limit.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 58, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetConsumerQuotaLimit", + "fullName": "google.api.serviceusage.v1beta1.ServiceUsage.GetConsumerQuotaLimit", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + }, + { + "name": "view", + "type": ".google.api.serviceusage.v1beta1.QuotaView" + } + ], + "resultType": ".google.api.serviceusage.v1beta1.ConsumerQuotaLimit", + "client": { + "shortName": "ServiceUsageClient", + "fullName": "google.api.serviceusage.v1beta1.ServiceUsageClient" + }, + "method": { + "shortName": "GetConsumerQuotaLimit", + "fullName": "google.api.serviceusage.v1beta1.ServiceUsage.GetConsumerQuotaLimit", + "service": { + "shortName": "ServiceUsage", + "fullName": "google.api.serviceusage.v1beta1.ServiceUsage" + } + } + } + }, + { + "regionTag": "serviceusage_v1beta1_generated_ServiceUsage_CreateAdminOverride_async", + "title": "ServiceUsage createAdminOverride Sample", + "origin": "API_DEFINITION", + "description": " Creates an admin override. An admin override is applied by an administrator of a parent folder or parent organization of the consumer receiving the override. An admin override is intended to limit the amount of quota the consumer can use out of the total quota pool allocated to all children of the folder or organization.", + "canonical": true, + "file": "service_usage.create_admin_override.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 73, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CreateAdminOverride", + "fullName": "google.api.serviceusage.v1beta1.ServiceUsage.CreateAdminOverride", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "override", + "type": ".google.api.serviceusage.v1beta1.QuotaOverride" + }, + { + "name": "force", + "type": "TYPE_BOOL" + }, + { + "name": "force_only", + "type": "TYPE_ENUM[]" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "ServiceUsageClient", + "fullName": "google.api.serviceusage.v1beta1.ServiceUsageClient" + }, + "method": { + "shortName": "CreateAdminOverride", + "fullName": "google.api.serviceusage.v1beta1.ServiceUsage.CreateAdminOverride", + "service": { + "shortName": "ServiceUsage", + "fullName": "google.api.serviceusage.v1beta1.ServiceUsage" + } + } + } + }, + { + "regionTag": "serviceusage_v1beta1_generated_ServiceUsage_UpdateAdminOverride_async", + "title": "ServiceUsage updateAdminOverride Sample", + "origin": "API_DEFINITION", + "description": " Updates an admin override.", + "canonical": true, + "file": "service_usage.update_admin_override.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 78, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "UpdateAdminOverride", + "fullName": "google.api.serviceusage.v1beta1.ServiceUsage.UpdateAdminOverride", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + }, + { + "name": "override", + "type": ".google.api.serviceusage.v1beta1.QuotaOverride" + }, + { + "name": "force", + "type": "TYPE_BOOL" + }, + { + "name": "update_mask", + "type": ".google.protobuf.FieldMask" + }, + { + "name": "force_only", + "type": "TYPE_ENUM[]" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "ServiceUsageClient", + "fullName": "google.api.serviceusage.v1beta1.ServiceUsageClient" + }, + "method": { + "shortName": "UpdateAdminOverride", + "fullName": "google.api.serviceusage.v1beta1.ServiceUsage.UpdateAdminOverride", + "service": { + "shortName": "ServiceUsage", + "fullName": "google.api.serviceusage.v1beta1.ServiceUsage" + } + } + } + }, + { + "regionTag": "serviceusage_v1beta1_generated_ServiceUsage_DeleteAdminOverride_async", + "title": "ServiceUsage deleteAdminOverride Sample", + "origin": "API_DEFINITION", + "description": " Deletes an admin override.", + "canonical": true, + "file": "service_usage.delete_admin_override.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 68, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeleteAdminOverride", + "fullName": "google.api.serviceusage.v1beta1.ServiceUsage.DeleteAdminOverride", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + }, + { + "name": "force", + "type": "TYPE_BOOL" + }, + { + "name": "force_only", + "type": "TYPE_ENUM[]" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "ServiceUsageClient", + "fullName": "google.api.serviceusage.v1beta1.ServiceUsageClient" + }, + "method": { + "shortName": "DeleteAdminOverride", + "fullName": "google.api.serviceusage.v1beta1.ServiceUsage.DeleteAdminOverride", + "service": { + "shortName": "ServiceUsage", + "fullName": "google.api.serviceusage.v1beta1.ServiceUsage" + } + } + } + }, + { + "regionTag": "serviceusage_v1beta1_generated_ServiceUsage_ListAdminOverrides_async", + "title": "ServiceUsage listAdminOverrides Sample", + "origin": "API_DEFINITION", + "description": " Lists all admin overrides on this limit.", + "canonical": true, + "file": "service_usage.list_admin_overrides.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 66, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListAdminOverrides", + "fullName": "google.api.serviceusage.v1beta1.ServiceUsage.ListAdminOverrides", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.api.serviceusage.v1beta1.ListAdminOverridesResponse", + "client": { + "shortName": "ServiceUsageClient", + "fullName": "google.api.serviceusage.v1beta1.ServiceUsageClient" + }, + "method": { + "shortName": "ListAdminOverrides", + "fullName": "google.api.serviceusage.v1beta1.ServiceUsage.ListAdminOverrides", + "service": { + "shortName": "ServiceUsage", + "fullName": "google.api.serviceusage.v1beta1.ServiceUsage" + } + } + } + }, + { + "regionTag": "serviceusage_v1beta1_generated_ServiceUsage_ImportAdminOverrides_async", + "title": "ServiceUsage importAdminOverrides Sample", + "origin": "API_DEFINITION", + "description": " Creates or updates multiple admin overrides atomically, all on the same consumer, but on many different metrics or limits. The name field in the quota override message should not be set.", + "canonical": true, + "file": "service_usage.import_admin_overrides.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 72, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ImportAdminOverrides", + "fullName": "google.api.serviceusage.v1beta1.ServiceUsage.ImportAdminOverrides", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "inline_source", + "type": ".google.api.serviceusage.v1beta1.OverrideInlineSource" + }, + { + "name": "force", + "type": "TYPE_BOOL" + }, + { + "name": "force_only", + "type": "TYPE_ENUM[]" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "ServiceUsageClient", + "fullName": "google.api.serviceusage.v1beta1.ServiceUsageClient" + }, + "method": { + "shortName": "ImportAdminOverrides", + "fullName": "google.api.serviceusage.v1beta1.ServiceUsage.ImportAdminOverrides", + "service": { + "shortName": "ServiceUsage", + "fullName": "google.api.serviceusage.v1beta1.ServiceUsage" + } + } + } + }, + { + "regionTag": "serviceusage_v1beta1_generated_ServiceUsage_CreateConsumerOverride_async", + "title": "ServiceUsage createConsumerOverride Sample", + "origin": "API_DEFINITION", + "description": " Creates a consumer override. A consumer override is applied to the consumer on its own authority to limit its own quota usage. Consumer overrides cannot be used to grant more quota than would be allowed by admin overrides, producer overrides, or the default limit of the service.", + "canonical": true, + "file": "service_usage.create_consumer_override.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 73, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CreateConsumerOverride", + "fullName": "google.api.serviceusage.v1beta1.ServiceUsage.CreateConsumerOverride", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "override", + "type": ".google.api.serviceusage.v1beta1.QuotaOverride" + }, + { + "name": "force", + "type": "TYPE_BOOL" + }, + { + "name": "force_only", + "type": "TYPE_ENUM[]" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "ServiceUsageClient", + "fullName": "google.api.serviceusage.v1beta1.ServiceUsageClient" + }, + "method": { + "shortName": "CreateConsumerOverride", + "fullName": "google.api.serviceusage.v1beta1.ServiceUsage.CreateConsumerOverride", + "service": { + "shortName": "ServiceUsage", + "fullName": "google.api.serviceusage.v1beta1.ServiceUsage" + } + } + } + }, + { + "regionTag": "serviceusage_v1beta1_generated_ServiceUsage_UpdateConsumerOverride_async", + "title": "ServiceUsage updateConsumerOverride Sample", + "origin": "API_DEFINITION", + "description": " Updates a consumer override.", + "canonical": true, + "file": "service_usage.update_consumer_override.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 78, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "UpdateConsumerOverride", + "fullName": "google.api.serviceusage.v1beta1.ServiceUsage.UpdateConsumerOverride", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + }, + { + "name": "override", + "type": ".google.api.serviceusage.v1beta1.QuotaOverride" + }, + { + "name": "force", + "type": "TYPE_BOOL" + }, + { + "name": "update_mask", + "type": ".google.protobuf.FieldMask" + }, + { + "name": "force_only", + "type": "TYPE_ENUM[]" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "ServiceUsageClient", + "fullName": "google.api.serviceusage.v1beta1.ServiceUsageClient" + }, + "method": { + "shortName": "UpdateConsumerOverride", + "fullName": "google.api.serviceusage.v1beta1.ServiceUsage.UpdateConsumerOverride", + "service": { + "shortName": "ServiceUsage", + "fullName": "google.api.serviceusage.v1beta1.ServiceUsage" + } + } + } + }, + { + "regionTag": "serviceusage_v1beta1_generated_ServiceUsage_DeleteConsumerOverride_async", + "title": "ServiceUsage deleteConsumerOverride Sample", + "origin": "API_DEFINITION", + "description": " Deletes a consumer override.", + "canonical": true, + "file": "service_usage.delete_consumer_override.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 68, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeleteConsumerOverride", + "fullName": "google.api.serviceusage.v1beta1.ServiceUsage.DeleteConsumerOverride", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + }, + { + "name": "force", + "type": "TYPE_BOOL" + }, + { + "name": "force_only", + "type": "TYPE_ENUM[]" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "ServiceUsageClient", + "fullName": "google.api.serviceusage.v1beta1.ServiceUsageClient" + }, + "method": { + "shortName": "DeleteConsumerOverride", + "fullName": "google.api.serviceusage.v1beta1.ServiceUsage.DeleteConsumerOverride", + "service": { + "shortName": "ServiceUsage", + "fullName": "google.api.serviceusage.v1beta1.ServiceUsage" + } + } + } + }, + { + "regionTag": "serviceusage_v1beta1_generated_ServiceUsage_ListConsumerOverrides_async", + "title": "ServiceUsage listConsumerOverrides Sample", + "origin": "API_DEFINITION", + "description": " Lists all consumer overrides on this limit.", + "canonical": true, + "file": "service_usage.list_consumer_overrides.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 66, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListConsumerOverrides", + "fullName": "google.api.serviceusage.v1beta1.ServiceUsage.ListConsumerOverrides", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.api.serviceusage.v1beta1.ListConsumerOverridesResponse", + "client": { + "shortName": "ServiceUsageClient", + "fullName": "google.api.serviceusage.v1beta1.ServiceUsageClient" + }, + "method": { + "shortName": "ListConsumerOverrides", + "fullName": "google.api.serviceusage.v1beta1.ServiceUsage.ListConsumerOverrides", + "service": { + "shortName": "ServiceUsage", + "fullName": "google.api.serviceusage.v1beta1.ServiceUsage" + } + } + } + }, + { + "regionTag": "serviceusage_v1beta1_generated_ServiceUsage_ImportConsumerOverrides_async", + "title": "ServiceUsage importConsumerOverrides Sample", + "origin": "API_DEFINITION", + "description": " Creates or updates multiple consumer overrides atomically, all on the same consumer, but on many different metrics or limits. The name field in the quota override message should not be set.", + "canonical": true, + "file": "service_usage.import_consumer_overrides.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 72, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ImportConsumerOverrides", + "fullName": "google.api.serviceusage.v1beta1.ServiceUsage.ImportConsumerOverrides", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "inline_source", + "type": ".google.api.serviceusage.v1beta1.OverrideInlineSource" + }, + { + "name": "force", + "type": "TYPE_BOOL" + }, + { + "name": "force_only", + "type": "TYPE_ENUM[]" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "ServiceUsageClient", + "fullName": "google.api.serviceusage.v1beta1.ServiceUsageClient" + }, + "method": { + "shortName": "ImportConsumerOverrides", + "fullName": "google.api.serviceusage.v1beta1.ServiceUsage.ImportConsumerOverrides", + "service": { + "shortName": "ServiceUsage", + "fullName": "google.api.serviceusage.v1beta1.ServiceUsage" + } + } + } + }, + { + "regionTag": "serviceusage_v1beta1_generated_ServiceUsage_GenerateServiceIdentity_async", + "title": "ServiceUsage generateServiceIdentity Sample", + "origin": "API_DEFINITION", + "description": " Generates service identity for service.", + "canonical": true, + "file": "service_usage.generate_service_identity.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 57, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GenerateServiceIdentity", + "fullName": "google.api.serviceusage.v1beta1.ServiceUsage.GenerateServiceIdentity", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "ServiceUsageClient", + "fullName": "google.api.serviceusage.v1beta1.ServiceUsageClient" + }, + "method": { + "shortName": "GenerateServiceIdentity", + "fullName": "google.api.serviceusage.v1beta1.ServiceUsage.GenerateServiceIdentity", + "service": { + "shortName": "ServiceUsage", + "fullName": "google.api.serviceusage.v1beta1.ServiceUsage" + } + } + } + } + ] +} \ No newline at end of file diff --git a/packages/google-api-serviceusage/samples/package.json b/packages/google-api-serviceusage/samples/package.json index 62273263f3c..8f8a7ae3fee 100644 --- a/packages/google-api-serviceusage/samples/package.json +++ b/packages/google-api-serviceusage/samples/package.json @@ -4,7 +4,7 @@ "license": "Apache-2.0", "author": "Google LLC", "engines": { - "node": ">=12.0.0" + "node": ">=14.0.0" }, "files": [ "*.js" diff --git a/packages/google-api-serviceusage/src/v1/service_usage_client.ts b/packages/google-api-serviceusage/src/v1/service_usage_client.ts index 18d126410ac..789fe0cce30 100644 --- a/packages/google-api-serviceusage/src/v1/service_usage_client.ts +++ b/packages/google-api-serviceusage/src/v1/service_usage_client.ts @@ -412,9 +412,8 @@ export class ServiceUsageClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.api.serviceusage.v1.Service | Service}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.api.serviceusage.v1.Service|Service}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/service_usage.get_service.js * region_tag:serviceusage_v1_generated_ServiceUsage_GetService_async @@ -509,9 +508,8 @@ export class ServiceUsageClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.api.serviceusage.v1.BatchGetServicesResponse | BatchGetServicesResponse}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.api.serviceusage.v1.BatchGetServicesResponse|BatchGetServicesResponse}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/service_usage.batch_get_services.js * region_tag:serviceusage_v1_generated_ServiceUsage_BatchGetServices_async @@ -614,8 +612,7 @@ export class ServiceUsageClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/service_usage.enable_service.js * region_tag:serviceusage_v1_generated_ServiceUsage_EnableService_async @@ -710,8 +707,7 @@ export class ServiceUsageClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/service_usage.enable_service.js * region_tag:serviceusage_v1_generated_ServiceUsage_EnableService_async @@ -772,8 +768,7 @@ export class ServiceUsageClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/service_usage.disable_service.js * region_tag:serviceusage_v1_generated_ServiceUsage_DisableService_async @@ -868,8 +863,7 @@ export class ServiceUsageClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/service_usage.disable_service.js * region_tag:serviceusage_v1_generated_ServiceUsage_DisableService_async @@ -929,8 +923,7 @@ export class ServiceUsageClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/service_usage.batch_enable_services.js * region_tag:serviceusage_v1_generated_ServiceUsage_BatchEnableServices_async @@ -1025,8 +1018,7 @@ export class ServiceUsageClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/service_usage.batch_enable_services.js * region_tag:serviceusage_v1_generated_ServiceUsage_BatchEnableServices_async @@ -1089,14 +1081,13 @@ export class ServiceUsageClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.api.serviceusage.v1.Service | Service}. + * The first element of the array is Array of {@link protos.google.api.serviceusage.v1.Service|Service}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `listServicesAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listServices( @@ -1196,13 +1187,12 @@ export class ServiceUsageClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.api.serviceusage.v1.Service | Service} on 'data' event. + * An object stream which emits an object representing {@link protos.google.api.serviceusage.v1.Service|Service} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listServicesAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listServicesStream( @@ -1251,12 +1241,11 @@ export class ServiceUsageClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.api.serviceusage.v1.Service | Service}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.api.serviceusage.v1.Service|Service}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1/service_usage.list_services.js * region_tag:serviceusage_v1_generated_ServiceUsage_ListServices_async diff --git a/packages/google-api-serviceusage/src/v1beta1/service_usage_client.ts b/packages/google-api-serviceusage/src/v1beta1/service_usage_client.ts index b5f6a56c91e..e37e03b2969 100644 --- a/packages/google-api-serviceusage/src/v1beta1/service_usage_client.ts +++ b/packages/google-api-serviceusage/src/v1beta1/service_usage_client.ts @@ -555,9 +555,8 @@ export class ServiceUsageClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.api.serviceusage.v1beta1.Service | Service}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.api.serviceusage.v1beta1.Service|Service}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/service_usage.get_service.js * region_tag:serviceusage_v1beta1_generated_ServiceUsage_GetService_async @@ -657,9 +656,8 @@ export class ServiceUsageClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.api.serviceusage.v1beta1.ConsumerQuotaMetric | ConsumerQuotaMetric}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.api.serviceusage.v1beta1.ConsumerQuotaMetric|ConsumerQuotaMetric}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/service_usage.get_consumer_quota_metric.js * region_tag:serviceusage_v1beta1_generated_ServiceUsage_GetConsumerQuotaMetric_async @@ -763,9 +761,8 @@ export class ServiceUsageClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.api.serviceusage.v1beta1.ConsumerQuotaLimit | ConsumerQuotaLimit}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.api.serviceusage.v1beta1.ConsumerQuotaLimit|ConsumerQuotaLimit}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/service_usage.get_consumer_quota_limit.js * region_tag:serviceusage_v1beta1_generated_ServiceUsage_GetConsumerQuotaLimit_async @@ -876,8 +873,7 @@ export class ServiceUsageClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/service_usage.enable_service.js * region_tag:serviceusage_v1beta1_generated_ServiceUsage_EnableService_async @@ -978,8 +974,7 @@ export class ServiceUsageClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/service_usage.enable_service.js * region_tag:serviceusage_v1beta1_generated_ServiceUsage_EnableService_async @@ -1040,8 +1035,7 @@ export class ServiceUsageClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/service_usage.disable_service.js * region_tag:serviceusage_v1beta1_generated_ServiceUsage_DisableService_async @@ -1142,8 +1136,7 @@ export class ServiceUsageClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/service_usage.disable_service.js * region_tag:serviceusage_v1beta1_generated_ServiceUsage_DisableService_async @@ -1215,8 +1208,7 @@ export class ServiceUsageClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/service_usage.batch_enable_services.js * region_tag:serviceusage_v1beta1_generated_ServiceUsage_BatchEnableServices_async @@ -1317,8 +1309,7 @@ export class ServiceUsageClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/service_usage.batch_enable_services.js * region_tag:serviceusage_v1beta1_generated_ServiceUsage_BatchEnableServices_async @@ -1385,8 +1376,7 @@ export class ServiceUsageClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/service_usage.create_admin_override.js * region_tag:serviceusage_v1beta1_generated_ServiceUsage_CreateAdminOverride_async @@ -1481,8 +1471,7 @@ export class ServiceUsageClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/service_usage.create_admin_override.js * region_tag:serviceusage_v1beta1_generated_ServiceUsage_CreateAdminOverride_async @@ -1541,8 +1530,7 @@ export class ServiceUsageClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/service_usage.update_admin_override.js * region_tag:serviceusage_v1beta1_generated_ServiceUsage_UpdateAdminOverride_async @@ -1637,8 +1625,7 @@ export class ServiceUsageClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/service_usage.update_admin_override.js * region_tag:serviceusage_v1beta1_generated_ServiceUsage_UpdateAdminOverride_async @@ -1691,8 +1678,7 @@ export class ServiceUsageClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/service_usage.delete_admin_override.js * region_tag:serviceusage_v1beta1_generated_ServiceUsage_DeleteAdminOverride_async @@ -1787,8 +1773,7 @@ export class ServiceUsageClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/service_usage.delete_admin_override.js * region_tag:serviceusage_v1beta1_generated_ServiceUsage_DeleteAdminOverride_async @@ -1845,8 +1830,7 @@ export class ServiceUsageClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/service_usage.import_admin_overrides.js * region_tag:serviceusage_v1beta1_generated_ServiceUsage_ImportAdminOverrides_async @@ -1941,8 +1925,7 @@ export class ServiceUsageClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/service_usage.import_admin_overrides.js * region_tag:serviceusage_v1beta1_generated_ServiceUsage_ImportAdminOverrides_async @@ -2002,8 +1985,7 @@ export class ServiceUsageClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/service_usage.create_consumer_override.js * region_tag:serviceusage_v1beta1_generated_ServiceUsage_CreateConsumerOverride_async @@ -2102,8 +2084,7 @@ export class ServiceUsageClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/service_usage.create_consumer_override.js * region_tag:serviceusage_v1beta1_generated_ServiceUsage_CreateConsumerOverride_async @@ -2162,8 +2143,7 @@ export class ServiceUsageClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/service_usage.update_consumer_override.js * region_tag:serviceusage_v1beta1_generated_ServiceUsage_UpdateConsumerOverride_async @@ -2262,8 +2242,7 @@ export class ServiceUsageClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/service_usage.update_consumer_override.js * region_tag:serviceusage_v1beta1_generated_ServiceUsage_UpdateConsumerOverride_async @@ -2316,8 +2295,7 @@ export class ServiceUsageClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/service_usage.delete_consumer_override.js * region_tag:serviceusage_v1beta1_generated_ServiceUsage_DeleteConsumerOverride_async @@ -2416,8 +2394,7 @@ export class ServiceUsageClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/service_usage.delete_consumer_override.js * region_tag:serviceusage_v1beta1_generated_ServiceUsage_DeleteConsumerOverride_async @@ -2474,8 +2451,7 @@ export class ServiceUsageClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/service_usage.import_consumer_overrides.js * region_tag:serviceusage_v1beta1_generated_ServiceUsage_ImportConsumerOverrides_async @@ -2574,8 +2550,7 @@ export class ServiceUsageClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/service_usage.import_consumer_overrides.js * region_tag:serviceusage_v1beta1_generated_ServiceUsage_ImportConsumerOverrides_async @@ -2622,8 +2597,7 @@ export class ServiceUsageClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/service_usage.generate_service_identity.js * region_tag:serviceusage_v1beta1_generated_ServiceUsage_GenerateServiceIdentity_async @@ -2722,8 +2696,7 @@ export class ServiceUsageClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/service_usage.generate_service_identity.js * region_tag:serviceusage_v1beta1_generated_ServiceUsage_GenerateServiceIdentity_async @@ -2781,14 +2754,13 @@ export class ServiceUsageClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.api.serviceusage.v1beta1.Service | Service}. + * The first element of the array is Array of {@link protos.google.api.serviceusage.v1beta1.Service|Service}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `listServicesAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @deprecated ListServices is deprecated and may be removed in a future version. */ @@ -2895,13 +2867,12 @@ export class ServiceUsageClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.api.serviceusage.v1beta1.Service | Service} on 'data' event. + * An object stream which emits an object representing {@link protos.google.api.serviceusage.v1beta1.Service|Service} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listServicesAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @deprecated ListServices is deprecated and may be removed in a future version. */ @@ -2957,12 +2928,11 @@ export class ServiceUsageClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.api.serviceusage.v1beta1.Service | Service}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.api.serviceusage.v1beta1.Service|Service}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/service_usage.list_services.js * region_tag:serviceusage_v1beta1_generated_ServiceUsage_ListServices_async @@ -3020,14 +2990,13 @@ export class ServiceUsageClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.api.serviceusage.v1beta1.ConsumerQuotaMetric | ConsumerQuotaMetric}. + * The first element of the array is Array of {@link protos.google.api.serviceusage.v1beta1.ConsumerQuotaMetric|ConsumerQuotaMetric}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `listConsumerQuotaMetricsAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listConsumerQuotaMetrics( @@ -3130,13 +3099,12 @@ export class ServiceUsageClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.api.serviceusage.v1beta1.ConsumerQuotaMetric | ConsumerQuotaMetric} on 'data' event. + * An object stream which emits an object representing {@link protos.google.api.serviceusage.v1beta1.ConsumerQuotaMetric|ConsumerQuotaMetric} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listConsumerQuotaMetricsAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listConsumerQuotaMetricsStream( @@ -3184,12 +3152,11 @@ export class ServiceUsageClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.api.serviceusage.v1beta1.ConsumerQuotaMetric | ConsumerQuotaMetric}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.api.serviceusage.v1beta1.ConsumerQuotaMetric|ConsumerQuotaMetric}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/service_usage.list_consumer_quota_metrics.js * region_tag:serviceusage_v1beta1_generated_ServiceUsage_ListConsumerQuotaMetrics_async @@ -3234,14 +3201,13 @@ export class ServiceUsageClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.api.serviceusage.v1beta1.QuotaOverride | QuotaOverride}. + * The first element of the array is Array of {@link protos.google.api.serviceusage.v1beta1.QuotaOverride|QuotaOverride}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `listAdminOverridesAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listAdminOverrides( @@ -3337,13 +3303,12 @@ export class ServiceUsageClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.api.serviceusage.v1beta1.QuotaOverride | QuotaOverride} on 'data' event. + * An object stream which emits an object representing {@link protos.google.api.serviceusage.v1beta1.QuotaOverride|QuotaOverride} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listAdminOverridesAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listAdminOverridesStream( @@ -3388,12 +3353,11 @@ export class ServiceUsageClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.api.serviceusage.v1beta1.QuotaOverride | QuotaOverride}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.api.serviceusage.v1beta1.QuotaOverride|QuotaOverride}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/service_usage.list_admin_overrides.js * region_tag:serviceusage_v1beta1_generated_ServiceUsage_ListAdminOverrides_async @@ -3438,14 +3402,13 @@ export class ServiceUsageClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.api.serviceusage.v1beta1.QuotaOverride | QuotaOverride}. + * The first element of the array is Array of {@link protos.google.api.serviceusage.v1beta1.QuotaOverride|QuotaOverride}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `listConsumerOverridesAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listConsumerOverrides( @@ -3541,13 +3504,12 @@ export class ServiceUsageClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.api.serviceusage.v1beta1.QuotaOverride | QuotaOverride} on 'data' event. + * An object stream which emits an object representing {@link protos.google.api.serviceusage.v1beta1.QuotaOverride|QuotaOverride} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listConsumerOverridesAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listConsumerOverridesStream( @@ -3592,12 +3554,11 @@ export class ServiceUsageClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.api.serviceusage.v1beta1.QuotaOverride | QuotaOverride}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.api.serviceusage.v1beta1.QuotaOverride|QuotaOverride}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/service_usage.list_consumer_overrides.js * region_tag:serviceusage_v1beta1_generated_ServiceUsage_ListConsumerOverrides_async diff --git a/packages/google-api-serviceusage/webpack.config.js b/packages/google-api-serviceusage/webpack.config.js index 7e07d610fe1..8aac6597e89 100644 --- a/packages/google-api-serviceusage/webpack.config.js +++ b/packages/google-api-serviceusage/webpack.config.js @@ -1,4 +1,4 @@ -// Copyright 2023 Google LLC +// Copyright 2021 Google LLC // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. diff --git a/packages/google-appengine/README.md b/packages/google-appengine/README.md index 92cb001dd92..c599ccb4720 100644 --- a/packages/google-appengine/README.md +++ b/packages/google-appengine/README.md @@ -2,7 +2,7 @@ [//]: # "To regenerate it, use `python -m synthtool`." Google Cloud Platform logo -# [App Engine Admin API: Node.js Client](https://github.com/googleapis/google-cloud-node) +# [App Engine Admin API: Node.js Client](https://github.com/googleapis/google-cloud-node/tree/main/packages/google-appengine) [![release level](https://img.shields.io/badge/release%20level-stable-brightgreen.svg?style=flat)](https://cloud.google.com/terms/launch-stages) [![npm version](https://img.shields.io/npm/v/@google-cloud/appengine-admin.svg)](https://www.npmjs.org/package/@google-cloud/appengine-admin) @@ -81,46 +81,45 @@ listVersions(); ## Samples -Samples are in the [`samples/`](https://github.com/googleapis/google-cloud-node/tree/main/samples) directory. Each sample's `README.md` has instructions for running its sample. +Samples are in the [`samples/`](https://github.com/googleapis/google-cloud-node/tree/main/packages/google-appengine/samples) directory. Each sample's `README.md` has instructions for running its sample. | Sample | Source Code | Try it | | --------------------------- | --------------------------------- | ------ | -| Applications.create_application | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-appengine/samples/generated/v1/applications.create_application.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-appengine/samples/generated/v1/applications.create_application.js,samples/README.md) | -| Applications.get_application | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-appengine/samples/generated/v1/applications.get_application.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-appengine/samples/generated/v1/applications.get_application.js,samples/README.md) | -| Applications.repair_application | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-appengine/samples/generated/v1/applications.repair_application.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-appengine/samples/generated/v1/applications.repair_application.js,samples/README.md) | -| Applications.update_application | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-appengine/samples/generated/v1/applications.update_application.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-appengine/samples/generated/v1/applications.update_application.js,samples/README.md) | -| Authorized_certificates.create_authorized_certificate | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-appengine/samples/generated/v1/authorized_certificates.create_authorized_certificate.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-appengine/samples/generated/v1/authorized_certificates.create_authorized_certificate.js,samples/README.md) | -| Authorized_certificates.delete_authorized_certificate | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-appengine/samples/generated/v1/authorized_certificates.delete_authorized_certificate.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-appengine/samples/generated/v1/authorized_certificates.delete_authorized_certificate.js,samples/README.md) | -| Authorized_certificates.get_authorized_certificate | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-appengine/samples/generated/v1/authorized_certificates.get_authorized_certificate.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-appengine/samples/generated/v1/authorized_certificates.get_authorized_certificate.js,samples/README.md) | -| Authorized_certificates.list_authorized_certificates | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-appengine/samples/generated/v1/authorized_certificates.list_authorized_certificates.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-appengine/samples/generated/v1/authorized_certificates.list_authorized_certificates.js,samples/README.md) | -| Authorized_certificates.update_authorized_certificate | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-appengine/samples/generated/v1/authorized_certificates.update_authorized_certificate.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-appengine/samples/generated/v1/authorized_certificates.update_authorized_certificate.js,samples/README.md) | -| Authorized_domains.list_authorized_domains | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-appengine/samples/generated/v1/authorized_domains.list_authorized_domains.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-appengine/samples/generated/v1/authorized_domains.list_authorized_domains.js,samples/README.md) | -| Domain_mappings.create_domain_mapping | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-appengine/samples/generated/v1/domain_mappings.create_domain_mapping.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-appengine/samples/generated/v1/domain_mappings.create_domain_mapping.js,samples/README.md) | -| Domain_mappings.delete_domain_mapping | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-appengine/samples/generated/v1/domain_mappings.delete_domain_mapping.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-appengine/samples/generated/v1/domain_mappings.delete_domain_mapping.js,samples/README.md) | -| Domain_mappings.get_domain_mapping | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-appengine/samples/generated/v1/domain_mappings.get_domain_mapping.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-appengine/samples/generated/v1/domain_mappings.get_domain_mapping.js,samples/README.md) | -| Domain_mappings.list_domain_mappings | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-appengine/samples/generated/v1/domain_mappings.list_domain_mappings.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-appengine/samples/generated/v1/domain_mappings.list_domain_mappings.js,samples/README.md) | -| Domain_mappings.update_domain_mapping | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-appengine/samples/generated/v1/domain_mappings.update_domain_mapping.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-appengine/samples/generated/v1/domain_mappings.update_domain_mapping.js,samples/README.md) | -| Firewall.batch_update_ingress_rules | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-appengine/samples/generated/v1/firewall.batch_update_ingress_rules.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-appengine/samples/generated/v1/firewall.batch_update_ingress_rules.js,samples/README.md) | -| Firewall.create_ingress_rule | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-appengine/samples/generated/v1/firewall.create_ingress_rule.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-appengine/samples/generated/v1/firewall.create_ingress_rule.js,samples/README.md) | -| Firewall.delete_ingress_rule | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-appengine/samples/generated/v1/firewall.delete_ingress_rule.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-appengine/samples/generated/v1/firewall.delete_ingress_rule.js,samples/README.md) | -| Firewall.get_ingress_rule | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-appengine/samples/generated/v1/firewall.get_ingress_rule.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-appengine/samples/generated/v1/firewall.get_ingress_rule.js,samples/README.md) | -| Firewall.list_ingress_rules | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-appengine/samples/generated/v1/firewall.list_ingress_rules.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-appengine/samples/generated/v1/firewall.list_ingress_rules.js,samples/README.md) | -| Firewall.update_ingress_rule | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-appengine/samples/generated/v1/firewall.update_ingress_rule.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-appengine/samples/generated/v1/firewall.update_ingress_rule.js,samples/README.md) | -| Instances.debug_instance | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-appengine/samples/generated/v1/instances.debug_instance.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-appengine/samples/generated/v1/instances.debug_instance.js,samples/README.md) | -| Instances.delete_instance | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-appengine/samples/generated/v1/instances.delete_instance.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-appengine/samples/generated/v1/instances.delete_instance.js,samples/README.md) | -| Instances.get_instance | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-appengine/samples/generated/v1/instances.get_instance.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-appengine/samples/generated/v1/instances.get_instance.js,samples/README.md) | -| Instances.list_instances | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-appengine/samples/generated/v1/instances.list_instances.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-appengine/samples/generated/v1/instances.list_instances.js,samples/README.md) | -| Services.delete_service | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-appengine/samples/generated/v1/services.delete_service.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-appengine/samples/generated/v1/services.delete_service.js,samples/README.md) | -| Services.get_service | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-appengine/samples/generated/v1/services.get_service.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-appengine/samples/generated/v1/services.get_service.js,samples/README.md) | -| Services.list_services | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-appengine/samples/generated/v1/services.list_services.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-appengine/samples/generated/v1/services.list_services.js,samples/README.md) | -| Services.update_service | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-appengine/samples/generated/v1/services.update_service.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-appengine/samples/generated/v1/services.update_service.js,samples/README.md) | -| Versions.create_version | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-appengine/samples/generated/v1/versions.create_version.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-appengine/samples/generated/v1/versions.create_version.js,samples/README.md) | -| Versions.delete_version | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-appengine/samples/generated/v1/versions.delete_version.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-appengine/samples/generated/v1/versions.delete_version.js,samples/README.md) | -| Versions.get_version | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-appengine/samples/generated/v1/versions.get_version.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-appengine/samples/generated/v1/versions.get_version.js,samples/README.md) | -| Versions.list_versions | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-appengine/samples/generated/v1/versions.list_versions.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-appengine/samples/generated/v1/versions.list_versions.js,samples/README.md) | -| Versions.update_version | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-appengine/samples/generated/v1/versions.update_version.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-appengine/samples/generated/v1/versions.update_version.js,samples/README.md) | -| Quickstart | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-appengine/samples/quickstart.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-appengine/samples/quickstart.js,samples/README.md) | -| Quickstart | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-appengine/samples/test/quickstart.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-appengine/samples/test/quickstart.js,samples/README.md) | +| Applications.create_application | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-appengine/samples/generated/v1/applications.create_application.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-appengine/samples/generated/v1/applications.create_application.js,packages/google-appengine/samples/README.md) | +| Applications.get_application | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-appengine/samples/generated/v1/applications.get_application.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-appengine/samples/generated/v1/applications.get_application.js,packages/google-appengine/samples/README.md) | +| Applications.repair_application | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-appengine/samples/generated/v1/applications.repair_application.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-appengine/samples/generated/v1/applications.repair_application.js,packages/google-appengine/samples/README.md) | +| Applications.update_application | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-appengine/samples/generated/v1/applications.update_application.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-appengine/samples/generated/v1/applications.update_application.js,packages/google-appengine/samples/README.md) | +| Authorized_certificates.create_authorized_certificate | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-appengine/samples/generated/v1/authorized_certificates.create_authorized_certificate.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-appengine/samples/generated/v1/authorized_certificates.create_authorized_certificate.js,packages/google-appengine/samples/README.md) | +| Authorized_certificates.delete_authorized_certificate | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-appengine/samples/generated/v1/authorized_certificates.delete_authorized_certificate.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-appengine/samples/generated/v1/authorized_certificates.delete_authorized_certificate.js,packages/google-appengine/samples/README.md) | +| Authorized_certificates.get_authorized_certificate | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-appengine/samples/generated/v1/authorized_certificates.get_authorized_certificate.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-appengine/samples/generated/v1/authorized_certificates.get_authorized_certificate.js,packages/google-appengine/samples/README.md) | +| Authorized_certificates.list_authorized_certificates | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-appengine/samples/generated/v1/authorized_certificates.list_authorized_certificates.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-appengine/samples/generated/v1/authorized_certificates.list_authorized_certificates.js,packages/google-appengine/samples/README.md) | +| Authorized_certificates.update_authorized_certificate | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-appengine/samples/generated/v1/authorized_certificates.update_authorized_certificate.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-appengine/samples/generated/v1/authorized_certificates.update_authorized_certificate.js,packages/google-appengine/samples/README.md) | +| Authorized_domains.list_authorized_domains | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-appengine/samples/generated/v1/authorized_domains.list_authorized_domains.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-appengine/samples/generated/v1/authorized_domains.list_authorized_domains.js,packages/google-appengine/samples/README.md) | +| Domain_mappings.create_domain_mapping | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-appengine/samples/generated/v1/domain_mappings.create_domain_mapping.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-appengine/samples/generated/v1/domain_mappings.create_domain_mapping.js,packages/google-appengine/samples/README.md) | +| Domain_mappings.delete_domain_mapping | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-appengine/samples/generated/v1/domain_mappings.delete_domain_mapping.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-appengine/samples/generated/v1/domain_mappings.delete_domain_mapping.js,packages/google-appengine/samples/README.md) | +| Domain_mappings.get_domain_mapping | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-appengine/samples/generated/v1/domain_mappings.get_domain_mapping.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-appengine/samples/generated/v1/domain_mappings.get_domain_mapping.js,packages/google-appengine/samples/README.md) | +| Domain_mappings.list_domain_mappings | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-appengine/samples/generated/v1/domain_mappings.list_domain_mappings.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-appengine/samples/generated/v1/domain_mappings.list_domain_mappings.js,packages/google-appengine/samples/README.md) | +| Domain_mappings.update_domain_mapping | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-appengine/samples/generated/v1/domain_mappings.update_domain_mapping.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-appengine/samples/generated/v1/domain_mappings.update_domain_mapping.js,packages/google-appengine/samples/README.md) | +| Firewall.batch_update_ingress_rules | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-appengine/samples/generated/v1/firewall.batch_update_ingress_rules.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-appengine/samples/generated/v1/firewall.batch_update_ingress_rules.js,packages/google-appengine/samples/README.md) | +| Firewall.create_ingress_rule | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-appengine/samples/generated/v1/firewall.create_ingress_rule.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-appengine/samples/generated/v1/firewall.create_ingress_rule.js,packages/google-appengine/samples/README.md) | +| Firewall.delete_ingress_rule | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-appengine/samples/generated/v1/firewall.delete_ingress_rule.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-appengine/samples/generated/v1/firewall.delete_ingress_rule.js,packages/google-appengine/samples/README.md) | +| Firewall.get_ingress_rule | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-appengine/samples/generated/v1/firewall.get_ingress_rule.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-appengine/samples/generated/v1/firewall.get_ingress_rule.js,packages/google-appengine/samples/README.md) | +| Firewall.list_ingress_rules | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-appengine/samples/generated/v1/firewall.list_ingress_rules.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-appengine/samples/generated/v1/firewall.list_ingress_rules.js,packages/google-appengine/samples/README.md) | +| Firewall.update_ingress_rule | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-appengine/samples/generated/v1/firewall.update_ingress_rule.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-appengine/samples/generated/v1/firewall.update_ingress_rule.js,packages/google-appengine/samples/README.md) | +| Instances.debug_instance | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-appengine/samples/generated/v1/instances.debug_instance.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-appengine/samples/generated/v1/instances.debug_instance.js,packages/google-appengine/samples/README.md) | +| Instances.delete_instance | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-appengine/samples/generated/v1/instances.delete_instance.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-appengine/samples/generated/v1/instances.delete_instance.js,packages/google-appengine/samples/README.md) | +| Instances.get_instance | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-appengine/samples/generated/v1/instances.get_instance.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-appengine/samples/generated/v1/instances.get_instance.js,packages/google-appengine/samples/README.md) | +| Instances.list_instances | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-appengine/samples/generated/v1/instances.list_instances.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-appengine/samples/generated/v1/instances.list_instances.js,packages/google-appengine/samples/README.md) | +| Services.delete_service | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-appengine/samples/generated/v1/services.delete_service.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-appengine/samples/generated/v1/services.delete_service.js,packages/google-appengine/samples/README.md) | +| Services.get_service | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-appengine/samples/generated/v1/services.get_service.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-appengine/samples/generated/v1/services.get_service.js,packages/google-appengine/samples/README.md) | +| Services.list_services | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-appengine/samples/generated/v1/services.list_services.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-appengine/samples/generated/v1/services.list_services.js,packages/google-appengine/samples/README.md) | +| Services.update_service | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-appengine/samples/generated/v1/services.update_service.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-appengine/samples/generated/v1/services.update_service.js,packages/google-appengine/samples/README.md) | +| Versions.create_version | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-appengine/samples/generated/v1/versions.create_version.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-appengine/samples/generated/v1/versions.create_version.js,packages/google-appengine/samples/README.md) | +| Versions.delete_version | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-appengine/samples/generated/v1/versions.delete_version.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-appengine/samples/generated/v1/versions.delete_version.js,packages/google-appengine/samples/README.md) | +| Versions.get_version | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-appengine/samples/generated/v1/versions.get_version.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-appengine/samples/generated/v1/versions.get_version.js,packages/google-appengine/samples/README.md) | +| Versions.list_versions | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-appengine/samples/generated/v1/versions.list_versions.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-appengine/samples/generated/v1/versions.list_versions.js,packages/google-appengine/samples/README.md) | +| Versions.update_version | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-appengine/samples/generated/v1/versions.update_version.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-appengine/samples/generated/v1/versions.update_version.js,packages/google-appengine/samples/README.md) | +| Quickstart | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-appengine/samples/quickstart.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-appengine/samples/quickstart.js,packages/google-appengine/samples/README.md) | diff --git a/packages/google-appengine/package.json b/packages/google-appengine/package.json index e0c996050fc..59b4efcc982 100644 --- a/packages/google-appengine/package.json +++ b/packages/google-appengine/package.json @@ -52,14 +52,15 @@ "test": "c8 mocha build/test" }, "dependencies": { - "google-gax": "^3.5.8" + "google-gax": "^4.0.3" }, "devDependencies": { "@types/mocha": "^9.0.0", - "@types/node": "^18.0.0", + "@types/node": "^20.4.5", "@types/sinon": "^10.0.0", "c8": "^7.6.0", - "gts": "^3.1.0", + "gapic-tools": "^0.1.8", + "gts": "^5.0.0", "jsdoc": "^4.0.0", "jsdoc-fresh": "^2.0.0", "jsdoc-region-tag": "^2.0.0", @@ -70,12 +71,12 @@ "pack-n-play": "^1.0.0-2", "sinon": "^15.0.0", "ts-loader": "^9.0.0", - "typescript": "^4.6.4", + "typescript": "^5.1.6", "webpack": "^5.24.4", "webpack-cli": "^5.0.0" }, "engines": { - "node": ">=12.0.0" + "node": ">=14.0.0" }, "homepage": "https://github.com/googleapis/google-cloud-node/tree/main/packages/google-appengine" } diff --git a/packages/google-appengine/samples/README.md b/packages/google-appengine/samples/README.md index 0a6ef549e2f..8f89050afee 100644 --- a/packages/google-appengine/samples/README.md +++ b/packages/google-appengine/samples/README.md @@ -47,7 +47,6 @@ * [Versions.list_versions](#versions.list_versions) * [Versions.update_version](#versions.update_version) * [Quickstart](#quickstart) - * [Quickstart](#quickstart) ## Before you begin @@ -654,23 +653,6 @@ __Usage:__ `node packages/google-appengine/samples/quickstart.js` ------ - - - - -### Quickstart - -View the [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-appengine/samples/test/quickstart.js). - -[![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-appengine/samples/test/quickstart.js,samples/README.md) - -__Usage:__ - - -`node packages/google-appengine/samples/test/quickstart.js` - - diff --git a/packages/google-appengine/samples/generated/v1/firewall.batch_update_ingress_rules.js b/packages/google-appengine/samples/generated/v1/firewall.batch_update_ingress_rules.js index 8fafee4c9d1..3f2f54e641b 100644 --- a/packages/google-appengine/samples/generated/v1/firewall.batch_update_ingress_rules.js +++ b/packages/google-appengine/samples/generated/v1/firewall.batch_update_ingress_rules.js @@ -36,7 +36,7 @@ function main() { /** * A list of FirewallRules to replace the existing set. */ - // const ingressRules = 1234 + // const ingressRules = [1,2,3,4] // Imports the Appengine library const {FirewallClient} = require('@google-cloud/appengine-admin').v1; diff --git a/packages/google-appengine/samples/generated/v1/snippet_metadata.google.appengine.v1.json b/packages/google-appengine/samples/generated/v1/snippet_metadata.google.appengine.v1.json index 2c6ad633469..8f9a8e01932 100644 --- a/packages/google-appengine/samples/generated/v1/snippet_metadata.google.appengine.v1.json +++ b/packages/google-appengine/samples/generated/v1/snippet_metadata.google.appengine.v1.json @@ -1,7 +1,7 @@ { "clientLibrary": { "name": "nodejs-appengine", - "version": "2.2.1", + "version": "2.2.2", "language": "TYPESCRIPT", "apis": [ { diff --git a/packages/google-appengine/samples/generated/v1/snippet_metadata_google.appengine.v1.json b/packages/google-appengine/samples/generated/v1/snippet_metadata_google.appengine.v1.json new file mode 100644 index 00000000000..8f9a8e01932 --- /dev/null +++ b/packages/google-appengine/samples/generated/v1/snippet_metadata_google.appengine.v1.json @@ -0,0 +1,1531 @@ +{ + "clientLibrary": { + "name": "nodejs-appengine", + "version": "2.2.2", + "language": "TYPESCRIPT", + "apis": [ + { + "id": "google.appengine.v1", + "version": "v1" + } + ] + }, + "snippets": [ + { + "regionTag": "appengine_v1_generated_Applications_GetApplication_async", + "title": "Applications getApplication Sample", + "origin": "API_DEFINITION", + "description": " Gets information about an application.", + "canonical": true, + "file": "applications.get_application.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 52, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetApplication", + "fullName": "google.appengine.v1.Applications.GetApplication", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.appengine.v1.Application", + "client": { + "shortName": "ApplicationsClient", + "fullName": "google.appengine.v1.ApplicationsClient" + }, + "method": { + "shortName": "GetApplication", + "fullName": "google.appengine.v1.Applications.GetApplication", + "service": { + "shortName": "Applications", + "fullName": "google.appengine.v1.Applications" + } + } + } + }, + { + "regionTag": "appengine_v1_generated_Applications_CreateApplication_async", + "title": "Applications createApplication Sample", + "origin": "API_DEFINITION", + "description": " Creates an App Engine application for a Google Cloud Platform project. Required fields: * `id` - The ID of the target Cloud Platform project. * *location* - The [region](https://cloud.google.com/appengine/docs/locations) where you want the App Engine application located. For more information about App Engine applications, see [Managing Projects, Applications, and Billing](https://cloud.google.com/appengine/docs/standard/python/console/).", + "canonical": true, + "file": "applications.create_application.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 53, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CreateApplication", + "fullName": "google.appengine.v1.Applications.CreateApplication", + "async": true, + "parameters": [ + { + "name": "application", + "type": ".google.appengine.v1.Application" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "ApplicationsClient", + "fullName": "google.appengine.v1.ApplicationsClient" + }, + "method": { + "shortName": "CreateApplication", + "fullName": "google.appengine.v1.Applications.CreateApplication", + "service": { + "shortName": "Applications", + "fullName": "google.appengine.v1.Applications" + } + } + } + }, + { + "regionTag": "appengine_v1_generated_Applications_UpdateApplication_async", + "title": "Applications updateApplication Sample", + "origin": "API_DEFINITION", + "description": " Updates the specified Application resource. You can update the following fields: * `auth_domain` - Google authentication domain for controlling user access to the application. * `default_cookie_expiration` - Cookie expiration policy for the application. * `iap` - Identity-Aware Proxy properties for the application.", + "canonical": true, + "file": "applications.update_application.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 61, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "UpdateApplication", + "fullName": "google.appengine.v1.Applications.UpdateApplication", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + }, + { + "name": "application", + "type": ".google.appengine.v1.Application" + }, + { + "name": "update_mask", + "type": ".google.protobuf.FieldMask" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "ApplicationsClient", + "fullName": "google.appengine.v1.ApplicationsClient" + }, + "method": { + "shortName": "UpdateApplication", + "fullName": "google.appengine.v1.Applications.UpdateApplication", + "service": { + "shortName": "Applications", + "fullName": "google.appengine.v1.Applications" + } + } + } + }, + { + "regionTag": "appengine_v1_generated_Applications_RepairApplication_async", + "title": "Applications repairApplication Sample", + "origin": "API_DEFINITION", + "description": " Recreates the required App Engine features for the specified App Engine application, for example a Cloud Storage bucket or App Engine service account. Use this method if you receive an error message about a missing feature, for example, *Error retrieving the App Engine service account*. If you have deleted your App Engine service account, this will not be able to recreate it. Instead, you should attempt to use the IAM undelete API if possible at https://cloud.google.com/iam/reference/rest/v1/projects.serviceAccounts/undelete?apix_params=%7B\"name\"%3A\"projects%2F-%2FserviceAccounts%2Funique_id\"%2C\"resource\"%3A%7B%7D%7D . If the deletion was recent, the numeric ID can be found in the Cloud Console Activity Log.", + "canonical": true, + "file": "applications.repair_application.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 53, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "RepairApplication", + "fullName": "google.appengine.v1.Applications.RepairApplication", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "ApplicationsClient", + "fullName": "google.appengine.v1.ApplicationsClient" + }, + "method": { + "shortName": "RepairApplication", + "fullName": "google.appengine.v1.Applications.RepairApplication", + "service": { + "shortName": "Applications", + "fullName": "google.appengine.v1.Applications" + } + } + } + }, + { + "regionTag": "appengine_v1_generated_AuthorizedCertificates_ListAuthorizedCertificates_async", + "title": "Applications listAuthorizedCertificates Sample", + "origin": "API_DEFINITION", + "description": " Lists all SSL certificates the user is authorized to administer.", + "canonical": true, + "file": "authorized_certificates.list_authorized_certificates.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 66, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListAuthorizedCertificates", + "fullName": "google.appengine.v1.AuthorizedCertificates.ListAuthorizedCertificates", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "view", + "type": ".google.appengine.v1.AuthorizedCertificateView" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.appengine.v1.ListAuthorizedCertificatesResponse", + "client": { + "shortName": "AuthorizedCertificatesClient", + "fullName": "google.appengine.v1.AuthorizedCertificatesClient" + }, + "method": { + "shortName": "ListAuthorizedCertificates", + "fullName": "google.appengine.v1.AuthorizedCertificates.ListAuthorizedCertificates", + "service": { + "shortName": "AuthorizedCertificates", + "fullName": "google.appengine.v1.AuthorizedCertificates" + } + } + } + }, + { + "regionTag": "appengine_v1_generated_AuthorizedCertificates_GetAuthorizedCertificate_async", + "title": "Applications getAuthorizedCertificate Sample", + "origin": "API_DEFINITION", + "description": " Gets the specified SSL certificate.", + "canonical": true, + "file": "authorized_certificates.get_authorized_certificate.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 57, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetAuthorizedCertificate", + "fullName": "google.appengine.v1.AuthorizedCertificates.GetAuthorizedCertificate", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + }, + { + "name": "view", + "type": ".google.appengine.v1.AuthorizedCertificateView" + } + ], + "resultType": ".google.appengine.v1.AuthorizedCertificate", + "client": { + "shortName": "AuthorizedCertificatesClient", + "fullName": "google.appengine.v1.AuthorizedCertificatesClient" + }, + "method": { + "shortName": "GetAuthorizedCertificate", + "fullName": "google.appengine.v1.AuthorizedCertificates.GetAuthorizedCertificate", + "service": { + "shortName": "AuthorizedCertificates", + "fullName": "google.appengine.v1.AuthorizedCertificates" + } + } + } + }, + { + "regionTag": "appengine_v1_generated_AuthorizedCertificates_CreateAuthorizedCertificate_async", + "title": "Applications createAuthorizedCertificate Sample", + "origin": "API_DEFINITION", + "description": " Uploads the specified SSL certificate.", + "canonical": true, + "file": "authorized_certificates.create_authorized_certificate.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 56, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CreateAuthorizedCertificate", + "fullName": "google.appengine.v1.AuthorizedCertificates.CreateAuthorizedCertificate", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "certificate", + "type": ".google.appengine.v1.AuthorizedCertificate" + } + ], + "resultType": ".google.appengine.v1.AuthorizedCertificate", + "client": { + "shortName": "AuthorizedCertificatesClient", + "fullName": "google.appengine.v1.AuthorizedCertificatesClient" + }, + "method": { + "shortName": "CreateAuthorizedCertificate", + "fullName": "google.appengine.v1.AuthorizedCertificates.CreateAuthorizedCertificate", + "service": { + "shortName": "AuthorizedCertificates", + "fullName": "google.appengine.v1.AuthorizedCertificates" + } + } + } + }, + { + "regionTag": "appengine_v1_generated_AuthorizedCertificates_UpdateAuthorizedCertificate_async", + "title": "Applications updateAuthorizedCertificate Sample", + "origin": "API_DEFINITION", + "description": " Updates the specified SSL certificate. To renew a certificate and maintain its existing domain mappings, update `certificate_data` with a new certificate. The new certificate must be applicable to the same domains as the original certificate. The certificate `display_name` may also be updated.", + "canonical": true, + "file": "authorized_certificates.update_authorized_certificate.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 63, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "UpdateAuthorizedCertificate", + "fullName": "google.appengine.v1.AuthorizedCertificates.UpdateAuthorizedCertificate", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + }, + { + "name": "certificate", + "type": ".google.appengine.v1.AuthorizedCertificate" + }, + { + "name": "update_mask", + "type": ".google.protobuf.FieldMask" + } + ], + "resultType": ".google.appengine.v1.AuthorizedCertificate", + "client": { + "shortName": "AuthorizedCertificatesClient", + "fullName": "google.appengine.v1.AuthorizedCertificatesClient" + }, + "method": { + "shortName": "UpdateAuthorizedCertificate", + "fullName": "google.appengine.v1.AuthorizedCertificates.UpdateAuthorizedCertificate", + "service": { + "shortName": "AuthorizedCertificates", + "fullName": "google.appengine.v1.AuthorizedCertificates" + } + } + } + }, + { + "regionTag": "appengine_v1_generated_AuthorizedCertificates_DeleteAuthorizedCertificate_async", + "title": "Applications deleteAuthorizedCertificate Sample", + "origin": "API_DEFINITION", + "description": " Deletes the specified SSL certificate.", + "canonical": true, + "file": "authorized_certificates.delete_authorized_certificate.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 53, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeleteAuthorizedCertificate", + "fullName": "google.appengine.v1.AuthorizedCertificates.DeleteAuthorizedCertificate", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.protobuf.Empty", + "client": { + "shortName": "AuthorizedCertificatesClient", + "fullName": "google.appengine.v1.AuthorizedCertificatesClient" + }, + "method": { + "shortName": "DeleteAuthorizedCertificate", + "fullName": "google.appengine.v1.AuthorizedCertificates.DeleteAuthorizedCertificate", + "service": { + "shortName": "AuthorizedCertificates", + "fullName": "google.appengine.v1.AuthorizedCertificates" + } + } + } + }, + { + "regionTag": "appengine_v1_generated_AuthorizedDomains_ListAuthorizedDomains_async", + "title": "Applications listAuthorizedDomains Sample", + "origin": "API_DEFINITION", + "description": " Lists all domains the user is authorized to administer.", + "canonical": true, + "file": "authorized_domains.list_authorized_domains.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 62, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListAuthorizedDomains", + "fullName": "google.appengine.v1.AuthorizedDomains.ListAuthorizedDomains", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.appengine.v1.ListAuthorizedDomainsResponse", + "client": { + "shortName": "AuthorizedDomainsClient", + "fullName": "google.appengine.v1.AuthorizedDomainsClient" + }, + "method": { + "shortName": "ListAuthorizedDomains", + "fullName": "google.appengine.v1.AuthorizedDomains.ListAuthorizedDomains", + "service": { + "shortName": "AuthorizedDomains", + "fullName": "google.appengine.v1.AuthorizedDomains" + } + } + } + }, + { + "regionTag": "appengine_v1_generated_DomainMappings_ListDomainMappings_async", + "title": "Applications listDomainMappings Sample", + "origin": "API_DEFINITION", + "description": " Lists the domain mappings on an application.", + "canonical": true, + "file": "domain_mappings.list_domain_mappings.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 62, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListDomainMappings", + "fullName": "google.appengine.v1.DomainMappings.ListDomainMappings", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.appengine.v1.ListDomainMappingsResponse", + "client": { + "shortName": "DomainMappingsClient", + "fullName": "google.appengine.v1.DomainMappingsClient" + }, + "method": { + "shortName": "ListDomainMappings", + "fullName": "google.appengine.v1.DomainMappings.ListDomainMappings", + "service": { + "shortName": "DomainMappings", + "fullName": "google.appengine.v1.DomainMappings" + } + } + } + }, + { + "regionTag": "appengine_v1_generated_DomainMappings_GetDomainMapping_async", + "title": "Applications getDomainMapping Sample", + "origin": "API_DEFINITION", + "description": " Gets the specified domain mapping.", + "canonical": true, + "file": "domain_mappings.get_domain_mapping.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 53, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetDomainMapping", + "fullName": "google.appengine.v1.DomainMappings.GetDomainMapping", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.appengine.v1.DomainMapping", + "client": { + "shortName": "DomainMappingsClient", + "fullName": "google.appengine.v1.DomainMappingsClient" + }, + "method": { + "shortName": "GetDomainMapping", + "fullName": "google.appengine.v1.DomainMappings.GetDomainMapping", + "service": { + "shortName": "DomainMappings", + "fullName": "google.appengine.v1.DomainMappings" + } + } + } + }, + { + "regionTag": "appengine_v1_generated_DomainMappings_CreateDomainMapping_async", + "title": "Applications createDomainMapping Sample", + "origin": "API_DEFINITION", + "description": " Maps a domain to an application. A user must be authorized to administer a domain in order to map it to an application. For a list of available authorized domains, see [`AuthorizedDomains.ListAuthorizedDomains`]().", + "canonical": true, + "file": "domain_mappings.create_domain_mapping.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 62, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CreateDomainMapping", + "fullName": "google.appengine.v1.DomainMappings.CreateDomainMapping", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "domain_mapping", + "type": ".google.appengine.v1.DomainMapping" + }, + { + "name": "override_strategy", + "type": ".google.appengine.v1.DomainOverrideStrategy" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "DomainMappingsClient", + "fullName": "google.appengine.v1.DomainMappingsClient" + }, + "method": { + "shortName": "CreateDomainMapping", + "fullName": "google.appengine.v1.DomainMappings.CreateDomainMapping", + "service": { + "shortName": "DomainMappings", + "fullName": "google.appengine.v1.DomainMappings" + } + } + } + }, + { + "regionTag": "appengine_v1_generated_DomainMappings_UpdateDomainMapping_async", + "title": "Applications updateDomainMapping Sample", + "origin": "API_DEFINITION", + "description": " Updates the specified domain mapping. To map an SSL certificate to a domain mapping, update `certificate_id` to point to an `AuthorizedCertificate` resource. A user must be authorized to administer the associated domain in order to update a `DomainMapping` resource.", + "canonical": true, + "file": "domain_mappings.update_domain_mapping.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 63, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "UpdateDomainMapping", + "fullName": "google.appengine.v1.DomainMappings.UpdateDomainMapping", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + }, + { + "name": "domain_mapping", + "type": ".google.appengine.v1.DomainMapping" + }, + { + "name": "update_mask", + "type": ".google.protobuf.FieldMask" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "DomainMappingsClient", + "fullName": "google.appengine.v1.DomainMappingsClient" + }, + "method": { + "shortName": "UpdateDomainMapping", + "fullName": "google.appengine.v1.DomainMappings.UpdateDomainMapping", + "service": { + "shortName": "DomainMappings", + "fullName": "google.appengine.v1.DomainMappings" + } + } + } + }, + { + "regionTag": "appengine_v1_generated_DomainMappings_DeleteDomainMapping_async", + "title": "Applications deleteDomainMapping Sample", + "origin": "API_DEFINITION", + "description": " Deletes the specified domain mapping. A user must be authorized to administer the associated domain in order to delete a `DomainMapping` resource.", + "canonical": true, + "file": "domain_mappings.delete_domain_mapping.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 54, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeleteDomainMapping", + "fullName": "google.appengine.v1.DomainMappings.DeleteDomainMapping", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "DomainMappingsClient", + "fullName": "google.appengine.v1.DomainMappingsClient" + }, + "method": { + "shortName": "DeleteDomainMapping", + "fullName": "google.appengine.v1.DomainMappings.DeleteDomainMapping", + "service": { + "shortName": "DomainMappings", + "fullName": "google.appengine.v1.DomainMappings" + } + } + } + }, + { + "regionTag": "appengine_v1_generated_Firewall_ListIngressRules_async", + "title": "Applications listIngressRules Sample", + "origin": "API_DEFINITION", + "description": " Lists the firewall rules of an application.", + "canonical": true, + "file": "firewall.list_ingress_rules.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 69, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListIngressRules", + "fullName": "google.appengine.v1.Firewall.ListIngressRules", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "matching_address", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.appengine.v1.ListIngressRulesResponse", + "client": { + "shortName": "FirewallClient", + "fullName": "google.appengine.v1.FirewallClient" + }, + "method": { + "shortName": "ListIngressRules", + "fullName": "google.appengine.v1.Firewall.ListIngressRules", + "service": { + "shortName": "Firewall", + "fullName": "google.appengine.v1.Firewall" + } + } + } + }, + { + "regionTag": "appengine_v1_generated_Firewall_BatchUpdateIngressRules_async", + "title": "Applications batchUpdateIngressRules Sample", + "origin": "API_DEFINITION", + "description": " Replaces the entire firewall ruleset in one bulk operation. This overrides and replaces the rules of an existing firewall with the new rules. If the final rule does not match traffic with the '*' wildcard IP range, then an \"allow all\" rule is explicitly added to the end of the list.", + "canonical": true, + "file": "firewall.batch_update_ingress_rules.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 57, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "BatchUpdateIngressRules", + "fullName": "google.appengine.v1.Firewall.BatchUpdateIngressRules", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + }, + { + "name": "ingress_rules", + "type": "TYPE_MESSAGE[]" + } + ], + "resultType": ".google.appengine.v1.BatchUpdateIngressRulesResponse", + "client": { + "shortName": "FirewallClient", + "fullName": "google.appengine.v1.FirewallClient" + }, + "method": { + "shortName": "BatchUpdateIngressRules", + "fullName": "google.appengine.v1.Firewall.BatchUpdateIngressRules", + "service": { + "shortName": "Firewall", + "fullName": "google.appengine.v1.Firewall" + } + } + } + }, + { + "regionTag": "appengine_v1_generated_Firewall_CreateIngressRule_async", + "title": "Applications createIngressRule Sample", + "origin": "API_DEFINITION", + "description": " Creates a firewall rule for the application.", + "canonical": true, + "file": "firewall.create_ingress_rule.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 64, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CreateIngressRule", + "fullName": "google.appengine.v1.Firewall.CreateIngressRule", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "rule", + "type": ".google.appengine.v1.FirewallRule" + } + ], + "resultType": ".google.appengine.v1.FirewallRule", + "client": { + "shortName": "FirewallClient", + "fullName": "google.appengine.v1.FirewallClient" + }, + "method": { + "shortName": "CreateIngressRule", + "fullName": "google.appengine.v1.Firewall.CreateIngressRule", + "service": { + "shortName": "Firewall", + "fullName": "google.appengine.v1.Firewall" + } + } + } + }, + { + "regionTag": "appengine_v1_generated_Firewall_GetIngressRule_async", + "title": "Applications getIngressRule Sample", + "origin": "API_DEFINITION", + "description": " Gets the specified firewall rule.", + "canonical": true, + "file": "firewall.get_ingress_rule.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 53, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetIngressRule", + "fullName": "google.appengine.v1.Firewall.GetIngressRule", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.appengine.v1.FirewallRule", + "client": { + "shortName": "FirewallClient", + "fullName": "google.appengine.v1.FirewallClient" + }, + "method": { + "shortName": "GetIngressRule", + "fullName": "google.appengine.v1.Firewall.GetIngressRule", + "service": { + "shortName": "Firewall", + "fullName": "google.appengine.v1.Firewall" + } + } + } + }, + { + "regionTag": "appengine_v1_generated_Firewall_UpdateIngressRule_async", + "title": "Applications updateIngressRule Sample", + "origin": "API_DEFINITION", + "description": " Updates the specified firewall rule.", + "canonical": true, + "file": "firewall.update_ingress_rule.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 61, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "UpdateIngressRule", + "fullName": "google.appengine.v1.Firewall.UpdateIngressRule", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + }, + { + "name": "rule", + "type": ".google.appengine.v1.FirewallRule" + }, + { + "name": "update_mask", + "type": ".google.protobuf.FieldMask" + } + ], + "resultType": ".google.appengine.v1.FirewallRule", + "client": { + "shortName": "FirewallClient", + "fullName": "google.appengine.v1.FirewallClient" + }, + "method": { + "shortName": "UpdateIngressRule", + "fullName": "google.appengine.v1.Firewall.UpdateIngressRule", + "service": { + "shortName": "Firewall", + "fullName": "google.appengine.v1.Firewall" + } + } + } + }, + { + "regionTag": "appengine_v1_generated_Firewall_DeleteIngressRule_async", + "title": "Applications deleteIngressRule Sample", + "origin": "API_DEFINITION", + "description": " Deletes the specified firewall rule.", + "canonical": true, + "file": "firewall.delete_ingress_rule.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 53, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeleteIngressRule", + "fullName": "google.appengine.v1.Firewall.DeleteIngressRule", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.protobuf.Empty", + "client": { + "shortName": "FirewallClient", + "fullName": "google.appengine.v1.FirewallClient" + }, + "method": { + "shortName": "DeleteIngressRule", + "fullName": "google.appengine.v1.Firewall.DeleteIngressRule", + "service": { + "shortName": "Firewall", + "fullName": "google.appengine.v1.Firewall" + } + } + } + }, + { + "regionTag": "appengine_v1_generated_Instances_ListInstances_async", + "title": "Applications listInstances Sample", + "origin": "API_DEFINITION", + "description": " Lists the instances of a version. Tip: To aggregate details about instances over time, see the [Stackdriver Monitoring API](https://cloud.google.com/monitoring/api/ref_v3/rest/v3/projects.timeSeries/list).", + "canonical": true, + "file": "instances.list_instances.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 63, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListInstances", + "fullName": "google.appengine.v1.Instances.ListInstances", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.appengine.v1.ListInstancesResponse", + "client": { + "shortName": "InstancesClient", + "fullName": "google.appengine.v1.InstancesClient" + }, + "method": { + "shortName": "ListInstances", + "fullName": "google.appengine.v1.Instances.ListInstances", + "service": { + "shortName": "Instances", + "fullName": "google.appengine.v1.Instances" + } + } + } + }, + { + "regionTag": "appengine_v1_generated_Instances_GetInstance_async", + "title": "Applications getInstance Sample", + "origin": "API_DEFINITION", + "description": " Gets instance information.", + "canonical": true, + "file": "instances.get_instance.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 53, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetInstance", + "fullName": "google.appengine.v1.Instances.GetInstance", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.appengine.v1.Instance", + "client": { + "shortName": "InstancesClient", + "fullName": "google.appengine.v1.InstancesClient" + }, + "method": { + "shortName": "GetInstance", + "fullName": "google.appengine.v1.Instances.GetInstance", + "service": { + "shortName": "Instances", + "fullName": "google.appengine.v1.Instances" + } + } + } + }, + { + "regionTag": "appengine_v1_generated_Instances_DeleteInstance_async", + "title": "Applications deleteInstance Sample", + "origin": "API_DEFINITION", + "description": " Stops a running instance. The instance might be automatically recreated based on the scaling settings of the version. For more information, see \"How Instances are Managed\" ([standard environment](https://cloud.google.com/appengine/docs/standard/python/how-instances-are-managed) | [flexible environment](https://cloud.google.com/appengine/docs/flexible/python/how-instances-are-managed)). To ensure that instances are not re-created and avoid getting billed, you can stop all instances within the target version by changing the serving status of the version to `STOPPED` with the [`apps.services.versions.patch`](https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions/patch) method.", + "canonical": true, + "file": "instances.delete_instance.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 54, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeleteInstance", + "fullName": "google.appengine.v1.Instances.DeleteInstance", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "InstancesClient", + "fullName": "google.appengine.v1.InstancesClient" + }, + "method": { + "shortName": "DeleteInstance", + "fullName": "google.appengine.v1.Instances.DeleteInstance", + "service": { + "shortName": "Instances", + "fullName": "google.appengine.v1.Instances" + } + } + } + }, + { + "regionTag": "appengine_v1_generated_Instances_DebugInstance_async", + "title": "Applications debugInstance Sample", + "origin": "API_DEFINITION", + "description": " Enables debugging on a VM instance. This allows you to use the SSH command to connect to the virtual machine where the instance lives. While in \"debug mode\", the instance continues to serve live traffic. You should delete the instance when you are done debugging and then allow the system to take over and determine if another instance should be started. Only applicable for instances in App Engine flexible environment.", + "canonical": true, + "file": "instances.debug_instance.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 62, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DebugInstance", + "fullName": "google.appengine.v1.Instances.DebugInstance", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + }, + { + "name": "ssh_key", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "InstancesClient", + "fullName": "google.appengine.v1.InstancesClient" + }, + "method": { + "shortName": "DebugInstance", + "fullName": "google.appengine.v1.Instances.DebugInstance", + "service": { + "shortName": "Instances", + "fullName": "google.appengine.v1.Instances" + } + } + } + }, + { + "regionTag": "appengine_v1_generated_Services_ListServices_async", + "title": "Applications listServices Sample", + "origin": "API_DEFINITION", + "description": " Lists all the services in the application.", + "canonical": true, + "file": "services.list_services.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 62, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListServices", + "fullName": "google.appengine.v1.Services.ListServices", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.appengine.v1.ListServicesResponse", + "client": { + "shortName": "ServicesClient", + "fullName": "google.appengine.v1.ServicesClient" + }, + "method": { + "shortName": "ListServices", + "fullName": "google.appengine.v1.Services.ListServices", + "service": { + "shortName": "Services", + "fullName": "google.appengine.v1.Services" + } + } + } + }, + { + "regionTag": "appengine_v1_generated_Services_GetService_async", + "title": "Applications getService Sample", + "origin": "API_DEFINITION", + "description": " Gets the current configuration of the specified service.", + "canonical": true, + "file": "services.get_service.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 52, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetService", + "fullName": "google.appengine.v1.Services.GetService", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.appengine.v1.Service", + "client": { + "shortName": "ServicesClient", + "fullName": "google.appengine.v1.ServicesClient" + }, + "method": { + "shortName": "GetService", + "fullName": "google.appengine.v1.Services.GetService", + "service": { + "shortName": "Services", + "fullName": "google.appengine.v1.Services" + } + } + } + }, + { + "regionTag": "appengine_v1_generated_Services_UpdateService_async", + "title": "Applications updateService Sample", + "origin": "API_DEFINITION", + "description": " Updates the configuration of the specified service.", + "canonical": true, + "file": "services.update_service.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 77, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "UpdateService", + "fullName": "google.appengine.v1.Services.UpdateService", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + }, + { + "name": "service", + "type": ".google.appengine.v1.Service" + }, + { + "name": "update_mask", + "type": ".google.protobuf.FieldMask" + }, + { + "name": "migrate_traffic", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "ServicesClient", + "fullName": "google.appengine.v1.ServicesClient" + }, + "method": { + "shortName": "UpdateService", + "fullName": "google.appengine.v1.Services.UpdateService", + "service": { + "shortName": "Services", + "fullName": "google.appengine.v1.Services" + } + } + } + }, + { + "regionTag": "appengine_v1_generated_Services_DeleteService_async", + "title": "Applications deleteService Sample", + "origin": "API_DEFINITION", + "description": " Deletes the specified service and all enclosed versions.", + "canonical": true, + "file": "services.delete_service.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 53, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeleteService", + "fullName": "google.appengine.v1.Services.DeleteService", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "ServicesClient", + "fullName": "google.appengine.v1.ServicesClient" + }, + "method": { + "shortName": "DeleteService", + "fullName": "google.appengine.v1.Services.DeleteService", + "service": { + "shortName": "Services", + "fullName": "google.appengine.v1.Services" + } + } + } + }, + { + "regionTag": "appengine_v1_generated_Versions_ListVersions_async", + "title": "Applications listVersions Sample", + "origin": "API_DEFINITION", + "description": " Lists the versions of a service.", + "canonical": true, + "file": "versions.list_versions.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 67, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListVersions", + "fullName": "google.appengine.v1.Versions.ListVersions", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "view", + "type": ".google.appengine.v1.VersionView" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.appengine.v1.ListVersionsResponse", + "client": { + "shortName": "VersionsClient", + "fullName": "google.appengine.v1.VersionsClient" + }, + "method": { + "shortName": "ListVersions", + "fullName": "google.appengine.v1.Versions.ListVersions", + "service": { + "shortName": "Versions", + "fullName": "google.appengine.v1.Versions" + } + } + } + }, + { + "regionTag": "appengine_v1_generated_Versions_GetVersion_async", + "title": "Applications getVersion Sample", + "origin": "API_DEFINITION", + "description": " Gets the specified Version resource. By default, only a `BASIC_VIEW` will be returned. Specify the `FULL_VIEW` parameter to get the full resource.", + "canonical": true, + "file": "versions.get_version.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 57, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetVersion", + "fullName": "google.appengine.v1.Versions.GetVersion", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + }, + { + "name": "view", + "type": ".google.appengine.v1.VersionView" + } + ], + "resultType": ".google.appengine.v1.Version", + "client": { + "shortName": "VersionsClient", + "fullName": "google.appengine.v1.VersionsClient" + }, + "method": { + "shortName": "GetVersion", + "fullName": "google.appengine.v1.Versions.GetVersion", + "service": { + "shortName": "Versions", + "fullName": "google.appengine.v1.Versions" + } + } + } + }, + { + "regionTag": "appengine_v1_generated_Versions_CreateVersion_async", + "title": "Applications createVersion Sample", + "origin": "API_DEFINITION", + "description": " Deploys code and resource files to a new version.", + "canonical": true, + "file": "versions.create_version.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 58, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CreateVersion", + "fullName": "google.appengine.v1.Versions.CreateVersion", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "version", + "type": ".google.appengine.v1.Version" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "VersionsClient", + "fullName": "google.appengine.v1.VersionsClient" + }, + "method": { + "shortName": "CreateVersion", + "fullName": "google.appengine.v1.Versions.CreateVersion", + "service": { + "shortName": "Versions", + "fullName": "google.appengine.v1.Versions" + } + } + } + }, + { + "regionTag": "appengine_v1_generated_Versions_UpdateVersion_async", + "title": "Applications updateVersion Sample", + "origin": "API_DEFINITION", + "description": " Updates the specified Version resource. You can specify the following fields depending on the App Engine environment and type of scaling that the version resource uses: **Standard environment** * [`instance_class`](https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.instance_class) *automatic scaling* in the standard environment: * [`automatic_scaling.min_idle_instances`](https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.automatic_scaling) * [`automatic_scaling.max_idle_instances`](https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.automatic_scaling) * [`automaticScaling.standard_scheduler_settings.max_instances`](https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#StandardSchedulerSettings) * [`automaticScaling.standard_scheduler_settings.min_instances`](https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#StandardSchedulerSettings) * [`automaticScaling.standard_scheduler_settings.target_cpu_utilization`](https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#StandardSchedulerSettings) * [`automaticScaling.standard_scheduler_settings.target_throughput_utilization`](https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#StandardSchedulerSettings) *basic scaling* or *manual scaling* in the standard environment: * [`serving_status`](https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.serving_status) * [`manual_scaling.instances`](https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#manualscaling) **Flexible environment** * [`serving_status`](https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.serving_status) *automatic scaling* in the flexible environment: * [`automatic_scaling.min_total_instances`](https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.automatic_scaling) * [`automatic_scaling.max_total_instances`](https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.automatic_scaling) * [`automatic_scaling.cool_down_period_sec`](https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.automatic_scaling) * [`automatic_scaling.cpu_utilization.target_utilization`](https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.automatic_scaling) *manual scaling* in the flexible environment: * [`manual_scaling.instances`](https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#manualscaling)", + "canonical": true, + "file": "versions.update_version.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 63, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "UpdateVersion", + "fullName": "google.appengine.v1.Versions.UpdateVersion", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + }, + { + "name": "version", + "type": ".google.appengine.v1.Version" + }, + { + "name": "update_mask", + "type": ".google.protobuf.FieldMask" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "VersionsClient", + "fullName": "google.appengine.v1.VersionsClient" + }, + "method": { + "shortName": "UpdateVersion", + "fullName": "google.appengine.v1.Versions.UpdateVersion", + "service": { + "shortName": "Versions", + "fullName": "google.appengine.v1.Versions" + } + } + } + }, + { + "regionTag": "appengine_v1_generated_Versions_DeleteVersion_async", + "title": "Applications deleteVersion Sample", + "origin": "API_DEFINITION", + "description": " Deletes an existing Version resource.", + "canonical": true, + "file": "versions.delete_version.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 54, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeleteVersion", + "fullName": "google.appengine.v1.Versions.DeleteVersion", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "VersionsClient", + "fullName": "google.appengine.v1.VersionsClient" + }, + "method": { + "shortName": "DeleteVersion", + "fullName": "google.appengine.v1.Versions.DeleteVersion", + "service": { + "shortName": "Versions", + "fullName": "google.appengine.v1.Versions" + } + } + } + } + ] +} \ No newline at end of file diff --git a/packages/google-appengine/samples/package.json b/packages/google-appengine/samples/package.json index 8c1fd35b468..a1e42e8b655 100644 --- a/packages/google-appengine/samples/package.json +++ b/packages/google-appengine/samples/package.json @@ -4,7 +4,7 @@ "license": "Apache-2.0", "author": "Google LLC", "engines": { - "node": ">=12.0.0" + "node": ">=14.0.0" }, "files": [ "*.js" diff --git a/packages/google-appengine/src/v1/applications_client.ts b/packages/google-appengine/src/v1/applications_client.ts index 0f8432b4ae2..d3035ca31ac 100644 --- a/packages/google-appengine/src/v1/applications_client.ts +++ b/packages/google-appengine/src/v1/applications_client.ts @@ -404,9 +404,8 @@ export class ApplicationsClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.appengine.v1.Application | Application}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.appengine.v1.Application|Application}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/applications.get_application.js * region_tag:appengine_v1_generated_Applications_GetApplication_async @@ -497,8 +496,7 @@ export class ApplicationsClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/applications.create_application.js * region_tag:appengine_v1_generated_Applications_CreateApplication_async @@ -589,8 +587,7 @@ export class ApplicationsClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/applications.create_application.js * region_tag:appengine_v1_generated_Applications_CreateApplication_async @@ -640,8 +637,7 @@ export class ApplicationsClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/applications.update_application.js * region_tag:appengine_v1_generated_Applications_UpdateApplication_async @@ -736,8 +732,7 @@ export class ApplicationsClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/applications.update_application.js * region_tag:appengine_v1_generated_Applications_UpdateApplication_async @@ -787,8 +782,7 @@ export class ApplicationsClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/applications.repair_application.js * region_tag:appengine_v1_generated_Applications_RepairApplication_async @@ -883,8 +877,7 @@ export class ApplicationsClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/applications.repair_application.js * region_tag:appengine_v1_generated_Applications_RepairApplication_async diff --git a/packages/google-appengine/src/v1/authorized_certificates_client.ts b/packages/google-appengine/src/v1/authorized_certificates_client.ts index 64f388452c9..4aaa77fd42d 100644 --- a/packages/google-appengine/src/v1/authorized_certificates_client.ts +++ b/packages/google-appengine/src/v1/authorized_certificates_client.ts @@ -351,9 +351,8 @@ export class AuthorizedCertificatesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.appengine.v1.AuthorizedCertificate | AuthorizedCertificate}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.appengine.v1.AuthorizedCertificate|AuthorizedCertificate}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/authorized_certificates.get_authorized_certificate.js * region_tag:appengine_v1_generated_AuthorizedCertificates_GetAuthorizedCertificate_async @@ -448,9 +447,8 @@ export class AuthorizedCertificatesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.appengine.v1.AuthorizedCertificate | AuthorizedCertificate}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.appengine.v1.AuthorizedCertificate|AuthorizedCertificate}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/authorized_certificates.create_authorized_certificate.js * region_tag:appengine_v1_generated_AuthorizedCertificates_CreateAuthorizedCertificate_async @@ -560,9 +558,8 @@ export class AuthorizedCertificatesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.appengine.v1.AuthorizedCertificate | AuthorizedCertificate}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.appengine.v1.AuthorizedCertificate|AuthorizedCertificate}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/authorized_certificates.update_authorized_certificate.js * region_tag:appengine_v1_generated_AuthorizedCertificates_UpdateAuthorizedCertificate_async @@ -662,9 +659,8 @@ export class AuthorizedCertificatesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.protobuf.Empty | Empty}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.protobuf.Empty|Empty}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/authorized_certificates.delete_authorized_certificate.js * region_tag:appengine_v1_generated_AuthorizedCertificates_DeleteAuthorizedCertificate_async @@ -770,14 +766,13 @@ export class AuthorizedCertificatesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.appengine.v1.AuthorizedCertificate | AuthorizedCertificate}. + * The first element of the array is Array of {@link protos.google.appengine.v1.AuthorizedCertificate|AuthorizedCertificate}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `listAuthorizedCertificatesAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listAuthorizedCertificates( @@ -874,13 +869,12 @@ export class AuthorizedCertificatesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.appengine.v1.AuthorizedCertificate | AuthorizedCertificate} on 'data' event. + * An object stream which emits an object representing {@link protos.google.appengine.v1.AuthorizedCertificate|AuthorizedCertificate} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listAuthorizedCertificatesAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listAuthorizedCertificatesStream( @@ -922,12 +916,11 @@ export class AuthorizedCertificatesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.appengine.v1.AuthorizedCertificate | AuthorizedCertificate}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.appengine.v1.AuthorizedCertificate|AuthorizedCertificate}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1/authorized_certificates.list_authorized_certificates.js * region_tag:appengine_v1_generated_AuthorizedCertificates_ListAuthorizedCertificates_async diff --git a/packages/google-appengine/src/v1/authorized_domains_client.ts b/packages/google-appengine/src/v1/authorized_domains_client.ts index 49c54245e2f..74fb75052f5 100644 --- a/packages/google-appengine/src/v1/authorized_domains_client.ts +++ b/packages/google-appengine/src/v1/authorized_domains_client.ts @@ -347,14 +347,13 @@ export class AuthorizedDomainsClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.appengine.v1.AuthorizedDomain | AuthorizedDomain}. + * The first element of the array is Array of {@link protos.google.appengine.v1.AuthorizedDomain|AuthorizedDomain}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `listAuthorizedDomainsAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listAuthorizedDomains( @@ -445,13 +444,12 @@ export class AuthorizedDomainsClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.appengine.v1.AuthorizedDomain | AuthorizedDomain} on 'data' event. + * An object stream which emits an object representing {@link protos.google.appengine.v1.AuthorizedDomain|AuthorizedDomain} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listAuthorizedDomainsAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listAuthorizedDomainsStream( @@ -491,12 +489,11 @@ export class AuthorizedDomainsClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.appengine.v1.AuthorizedDomain | AuthorizedDomain}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.appengine.v1.AuthorizedDomain|AuthorizedDomain}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1/authorized_domains.list_authorized_domains.js * region_tag:appengine_v1_generated_AuthorizedDomains_ListAuthorizedDomains_async diff --git a/packages/google-appengine/src/v1/domain_mappings_client.ts b/packages/google-appengine/src/v1/domain_mappings_client.ts index a4f78af5635..553807b40d6 100644 --- a/packages/google-appengine/src/v1/domain_mappings_client.ts +++ b/packages/google-appengine/src/v1/domain_mappings_client.ts @@ -422,9 +422,8 @@ export class DomainMappingsClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.appengine.v1.DomainMapping | DomainMapping}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.appengine.v1.DomainMapping|DomainMapping}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/domain_mappings.get_domain_mapping.js * region_tag:appengine_v1_generated_DomainMappings_GetDomainMapping_async @@ -518,8 +517,7 @@ export class DomainMappingsClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/domain_mappings.create_domain_mapping.js * region_tag:appengine_v1_generated_DomainMappings_CreateDomainMapping_async @@ -614,8 +612,7 @@ export class DomainMappingsClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/domain_mappings.create_domain_mapping.js * region_tag:appengine_v1_generated_DomainMappings_CreateDomainMapping_async @@ -665,8 +662,7 @@ export class DomainMappingsClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/domain_mappings.update_domain_mapping.js * region_tag:appengine_v1_generated_DomainMappings_UpdateDomainMapping_async @@ -761,8 +757,7 @@ export class DomainMappingsClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/domain_mappings.update_domain_mapping.js * region_tag:appengine_v1_generated_DomainMappings_UpdateDomainMapping_async @@ -806,8 +801,7 @@ export class DomainMappingsClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/domain_mappings.delete_domain_mapping.js * region_tag:appengine_v1_generated_DomainMappings_DeleteDomainMapping_async @@ -902,8 +896,7 @@ export class DomainMappingsClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/domain_mappings.delete_domain_mapping.js * region_tag:appengine_v1_generated_DomainMappings_DeleteDomainMapping_async @@ -945,14 +938,13 @@ export class DomainMappingsClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.appengine.v1.DomainMapping | DomainMapping}. + * The first element of the array is Array of {@link protos.google.appengine.v1.DomainMapping|DomainMapping}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `listDomainMappingsAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listDomainMappings( @@ -1037,13 +1029,12 @@ export class DomainMappingsClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.appengine.v1.DomainMapping | DomainMapping} on 'data' event. + * An object stream which emits an object representing {@link protos.google.appengine.v1.DomainMapping|DomainMapping} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listDomainMappingsAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listDomainMappingsStream( @@ -1083,12 +1074,11 @@ export class DomainMappingsClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.appengine.v1.DomainMapping | DomainMapping}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.appengine.v1.DomainMapping|DomainMapping}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1/domain_mappings.list_domain_mappings.js * region_tag:appengine_v1_generated_DomainMappings_ListDomainMappings_async diff --git a/packages/google-appengine/src/v1/firewall_client.ts b/packages/google-appengine/src/v1/firewall_client.ts index d1620a97b74..8892bd16c61 100644 --- a/packages/google-appengine/src/v1/firewall_client.ts +++ b/packages/google-appengine/src/v1/firewall_client.ts @@ -363,9 +363,8 @@ export class FirewallClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.appengine.v1.BatchUpdateIngressRulesResponse | BatchUpdateIngressRulesResponse}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.appengine.v1.BatchUpdateIngressRulesResponse|BatchUpdateIngressRulesResponse}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/firewall.batch_update_ingress_rules.js * region_tag:appengine_v1_generated_Firewall_BatchUpdateIngressRules_async @@ -470,9 +469,8 @@ export class FirewallClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.appengine.v1.FirewallRule | FirewallRule}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.appengine.v1.FirewallRule|FirewallRule}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/firewall.create_ingress_rule.js * region_tag:appengine_v1_generated_Firewall_CreateIngressRule_async @@ -556,9 +554,8 @@ export class FirewallClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.appengine.v1.FirewallRule | FirewallRule}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.appengine.v1.FirewallRule|FirewallRule}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/firewall.get_ingress_rule.js * region_tag:appengine_v1_generated_Firewall_GetIngressRule_async @@ -644,9 +641,8 @@ export class FirewallClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.appengine.v1.FirewallRule | FirewallRule}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.appengine.v1.FirewallRule|FirewallRule}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/firewall.update_ingress_rule.js * region_tag:appengine_v1_generated_Firewall_UpdateIngressRule_async @@ -730,9 +726,8 @@ export class FirewallClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.protobuf.Empty | Empty}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.protobuf.Empty|Empty}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/firewall.delete_ingress_rule.js * region_tag:appengine_v1_generated_Firewall_DeleteIngressRule_async @@ -825,14 +820,13 @@ export class FirewallClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.appengine.v1.FirewallRule | FirewallRule}. + * The first element of the array is Array of {@link protos.google.appengine.v1.FirewallRule|FirewallRule}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `listIngressRulesAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listIngressRules( @@ -922,13 +916,12 @@ export class FirewallClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.appengine.v1.FirewallRule | FirewallRule} on 'data' event. + * An object stream which emits an object representing {@link protos.google.appengine.v1.FirewallRule|FirewallRule} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listIngressRulesAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listIngressRulesStream( @@ -973,12 +966,11 @@ export class FirewallClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.appengine.v1.FirewallRule | FirewallRule}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.appengine.v1.FirewallRule|FirewallRule}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1/firewall.list_ingress_rules.js * region_tag:appengine_v1_generated_Firewall_ListIngressRules_async diff --git a/packages/google-appengine/src/v1/instances_client.ts b/packages/google-appengine/src/v1/instances_client.ts index e190f86a100..8ad4b1d37b7 100644 --- a/packages/google-appengine/src/v1/instances_client.ts +++ b/packages/google-appengine/src/v1/instances_client.ts @@ -410,9 +410,8 @@ export class InstancesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.appengine.v1.Instance | Instance}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.appengine.v1.Instance|Instance}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/instances.get_instance.js * region_tag:appengine_v1_generated_Instances_GetInstance_async @@ -509,8 +508,7 @@ export class InstancesClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/instances.delete_instance.js * region_tag:appengine_v1_generated_Instances_DeleteInstance_async @@ -605,8 +603,7 @@ export class InstancesClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/instances.delete_instance.js * region_tag:appengine_v1_generated_Instances_DeleteInstance_async @@ -663,8 +660,7 @@ export class InstancesClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/instances.debug_instance.js * region_tag:appengine_v1_generated_Instances_DebugInstance_async @@ -759,8 +755,7 @@ export class InstancesClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/instances.debug_instance.js * region_tag:appengine_v1_generated_Instances_DebugInstance_async @@ -806,14 +801,13 @@ export class InstancesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.appengine.v1.Instance | Instance}. + * The first element of the array is Array of {@link protos.google.appengine.v1.Instance|Instance}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `listInstancesAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listInstances( @@ -897,13 +891,12 @@ export class InstancesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.appengine.v1.Instance | Instance} on 'data' event. + * An object stream which emits an object representing {@link protos.google.appengine.v1.Instance|Instance} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listInstancesAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listInstancesStream( @@ -944,12 +937,11 @@ export class InstancesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.appengine.v1.Instance | Instance}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.appengine.v1.Instance|Instance}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1/instances.list_instances.js * region_tag:appengine_v1_generated_Instances_ListInstances_async diff --git a/packages/google-appengine/src/v1/services_client.ts b/packages/google-appengine/src/v1/services_client.ts index c795fbb8416..359c321f302 100644 --- a/packages/google-appengine/src/v1/services_client.ts +++ b/packages/google-appengine/src/v1/services_client.ts @@ -409,9 +409,8 @@ export class ServicesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.appengine.v1.Service | Service}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.appengine.v1.Service|Service}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/services.get_service.js * region_tag:appengine_v1_generated_Services_GetService_async @@ -514,8 +513,7 @@ export class ServicesClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/services.update_service.js * region_tag:appengine_v1_generated_Services_UpdateService_async @@ -610,8 +608,7 @@ export class ServicesClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/services.update_service.js * region_tag:appengine_v1_generated_Services_UpdateService_async @@ -652,8 +649,7 @@ export class ServicesClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/services.delete_service.js * region_tag:appengine_v1_generated_Services_DeleteService_async @@ -748,8 +744,7 @@ export class ServicesClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/services.delete_service.js * region_tag:appengine_v1_generated_Services_DeleteService_async @@ -791,14 +786,13 @@ export class ServicesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.appengine.v1.Service | Service}. + * The first element of the array is Array of {@link protos.google.appengine.v1.Service|Service}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `listServicesAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listServices( @@ -881,13 +875,12 @@ export class ServicesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.appengine.v1.Service | Service} on 'data' event. + * An object stream which emits an object representing {@link protos.google.appengine.v1.Service|Service} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listServicesAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listServicesStream( @@ -927,12 +920,11 @@ export class ServicesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.appengine.v1.Service | Service}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.appengine.v1.Service|Service}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1/services.list_services.js * region_tag:appengine_v1_generated_Services_ListServices_async diff --git a/packages/google-appengine/src/v1/versions_client.ts b/packages/google-appengine/src/v1/versions_client.ts index 772e534c4bd..bb800826fe9 100644 --- a/packages/google-appengine/src/v1/versions_client.ts +++ b/packages/google-appengine/src/v1/versions_client.ts @@ -426,9 +426,8 @@ export class VersionsClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.appengine.v1.Version | Version}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.appengine.v1.Version|Version}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/versions.get_version.js * region_tag:appengine_v1_generated_Versions_GetVersion_async @@ -516,8 +515,7 @@ export class VersionsClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/versions.create_version.js * region_tag:appengine_v1_generated_Versions_CreateVersion_async @@ -612,8 +610,7 @@ export class VersionsClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/versions.create_version.js * region_tag:appengine_v1_generated_Versions_CreateVersion_async @@ -695,8 +692,7 @@ export class VersionsClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/versions.update_version.js * region_tag:appengine_v1_generated_Versions_UpdateVersion_async @@ -791,8 +787,7 @@ export class VersionsClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/versions.update_version.js * region_tag:appengine_v1_generated_Versions_UpdateVersion_async @@ -834,8 +829,7 @@ export class VersionsClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/versions.delete_version.js * region_tag:appengine_v1_generated_Versions_DeleteVersion_async @@ -930,8 +924,7 @@ export class VersionsClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/versions.delete_version.js * region_tag:appengine_v1_generated_Versions_DeleteVersion_async @@ -976,14 +969,13 @@ export class VersionsClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.appengine.v1.Version | Version}. + * The first element of the array is Array of {@link protos.google.appengine.v1.Version|Version}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `listVersionsAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listVersions( @@ -1069,13 +1061,12 @@ export class VersionsClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.appengine.v1.Version | Version} on 'data' event. + * An object stream which emits an object representing {@link protos.google.appengine.v1.Version|Version} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listVersionsAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listVersionsStream( @@ -1118,12 +1109,11 @@ export class VersionsClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.appengine.v1.Version | Version}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.appengine.v1.Version|Version}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1/versions.list_versions.js * region_tag:appengine_v1_generated_Versions_ListVersions_async diff --git a/packages/google-appengine/webpack.config.js b/packages/google-appengine/webpack.config.js index 31c649fda68..f9afe383f73 100644 --- a/packages/google-appengine/webpack.config.js +++ b/packages/google-appengine/webpack.config.js @@ -1,4 +1,4 @@ -// Copyright 2023 Google LLC +// Copyright 2021 Google LLC // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. diff --git a/packages/google-area120-tables/README.md b/packages/google-area120-tables/README.md index 38a0da5acc7..195a676a9c5 100644 --- a/packages/google-area120-tables/README.md +++ b/packages/google-area120-tables/README.md @@ -2,7 +2,7 @@ [//]: # "To regenerate it, use `python -m synthtool`." Google Cloud Platform logo -# [Area120 Tables API: Node.js Client](https://github.com/googleapis/google-cloud-node) +# [Area120 Tables API: Node.js Client](https://github.com/googleapis/google-cloud-node/tree/main/packages/google-area120-tables) [![release level](https://img.shields.io/badge/release%20level-preview-yellow.svg?style=flat)](https://cloud.google.com/terms/launch-stages) [![npm version](https://img.shields.io/npm/v/@google/area120-tables.svg)](https://www.npmjs.org/package/@google/area120-tables) @@ -80,24 +80,23 @@ listTables(); ## Samples -Samples are in the [`samples/`](https://github.com/googleapis/google-cloud-node/tree/main/samples) directory. Each sample's `README.md` has instructions for running its sample. +Samples are in the [`samples/`](https://github.com/googleapis/google-cloud-node/tree/main/packages/google-area120-tables/samples) directory. Each sample's `README.md` has instructions for running its sample. | Sample | Source Code | Try it | | --------------------------- | --------------------------------- | ------ | -| Tables_service.batch_create_rows | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-area120-tables/samples/generated/v1alpha1/tables_service.batch_create_rows.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-area120-tables/samples/generated/v1alpha1/tables_service.batch_create_rows.js,samples/README.md) | -| Tables_service.batch_delete_rows | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-area120-tables/samples/generated/v1alpha1/tables_service.batch_delete_rows.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-area120-tables/samples/generated/v1alpha1/tables_service.batch_delete_rows.js,samples/README.md) | -| Tables_service.batch_update_rows | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-area120-tables/samples/generated/v1alpha1/tables_service.batch_update_rows.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-area120-tables/samples/generated/v1alpha1/tables_service.batch_update_rows.js,samples/README.md) | -| Tables_service.create_row | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-area120-tables/samples/generated/v1alpha1/tables_service.create_row.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-area120-tables/samples/generated/v1alpha1/tables_service.create_row.js,samples/README.md) | -| Tables_service.delete_row | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-area120-tables/samples/generated/v1alpha1/tables_service.delete_row.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-area120-tables/samples/generated/v1alpha1/tables_service.delete_row.js,samples/README.md) | -| Tables_service.get_row | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-area120-tables/samples/generated/v1alpha1/tables_service.get_row.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-area120-tables/samples/generated/v1alpha1/tables_service.get_row.js,samples/README.md) | -| Tables_service.get_table | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-area120-tables/samples/generated/v1alpha1/tables_service.get_table.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-area120-tables/samples/generated/v1alpha1/tables_service.get_table.js,samples/README.md) | -| Tables_service.get_workspace | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-area120-tables/samples/generated/v1alpha1/tables_service.get_workspace.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-area120-tables/samples/generated/v1alpha1/tables_service.get_workspace.js,samples/README.md) | -| Tables_service.list_rows | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-area120-tables/samples/generated/v1alpha1/tables_service.list_rows.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-area120-tables/samples/generated/v1alpha1/tables_service.list_rows.js,samples/README.md) | -| Tables_service.list_tables | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-area120-tables/samples/generated/v1alpha1/tables_service.list_tables.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-area120-tables/samples/generated/v1alpha1/tables_service.list_tables.js,samples/README.md) | -| Tables_service.list_workspaces | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-area120-tables/samples/generated/v1alpha1/tables_service.list_workspaces.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-area120-tables/samples/generated/v1alpha1/tables_service.list_workspaces.js,samples/README.md) | -| Tables_service.update_row | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-area120-tables/samples/generated/v1alpha1/tables_service.update_row.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-area120-tables/samples/generated/v1alpha1/tables_service.update_row.js,samples/README.md) | -| Quickstart | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-area120-tables/samples/quickstart.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-area120-tables/samples/quickstart.js,samples/README.md) | -| Quickstart.test | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-area120-tables/samples/test/quickstart.test.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-area120-tables/samples/test/quickstart.test.js,samples/README.md) | +| Tables_service.batch_create_rows | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-area120-tables/samples/generated/v1alpha1/tables_service.batch_create_rows.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-area120-tables/samples/generated/v1alpha1/tables_service.batch_create_rows.js,packages/google-area120-tables/samples/README.md) | +| Tables_service.batch_delete_rows | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-area120-tables/samples/generated/v1alpha1/tables_service.batch_delete_rows.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-area120-tables/samples/generated/v1alpha1/tables_service.batch_delete_rows.js,packages/google-area120-tables/samples/README.md) | +| Tables_service.batch_update_rows | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-area120-tables/samples/generated/v1alpha1/tables_service.batch_update_rows.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-area120-tables/samples/generated/v1alpha1/tables_service.batch_update_rows.js,packages/google-area120-tables/samples/README.md) | +| Tables_service.create_row | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-area120-tables/samples/generated/v1alpha1/tables_service.create_row.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-area120-tables/samples/generated/v1alpha1/tables_service.create_row.js,packages/google-area120-tables/samples/README.md) | +| Tables_service.delete_row | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-area120-tables/samples/generated/v1alpha1/tables_service.delete_row.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-area120-tables/samples/generated/v1alpha1/tables_service.delete_row.js,packages/google-area120-tables/samples/README.md) | +| Tables_service.get_row | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-area120-tables/samples/generated/v1alpha1/tables_service.get_row.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-area120-tables/samples/generated/v1alpha1/tables_service.get_row.js,packages/google-area120-tables/samples/README.md) | +| Tables_service.get_table | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-area120-tables/samples/generated/v1alpha1/tables_service.get_table.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-area120-tables/samples/generated/v1alpha1/tables_service.get_table.js,packages/google-area120-tables/samples/README.md) | +| Tables_service.get_workspace | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-area120-tables/samples/generated/v1alpha1/tables_service.get_workspace.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-area120-tables/samples/generated/v1alpha1/tables_service.get_workspace.js,packages/google-area120-tables/samples/README.md) | +| Tables_service.list_rows | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-area120-tables/samples/generated/v1alpha1/tables_service.list_rows.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-area120-tables/samples/generated/v1alpha1/tables_service.list_rows.js,packages/google-area120-tables/samples/README.md) | +| Tables_service.list_tables | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-area120-tables/samples/generated/v1alpha1/tables_service.list_tables.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-area120-tables/samples/generated/v1alpha1/tables_service.list_tables.js,packages/google-area120-tables/samples/README.md) | +| Tables_service.list_workspaces | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-area120-tables/samples/generated/v1alpha1/tables_service.list_workspaces.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-area120-tables/samples/generated/v1alpha1/tables_service.list_workspaces.js,packages/google-area120-tables/samples/README.md) | +| Tables_service.update_row | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-area120-tables/samples/generated/v1alpha1/tables_service.update_row.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-area120-tables/samples/generated/v1alpha1/tables_service.update_row.js,packages/google-area120-tables/samples/README.md) | +| Quickstart | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-area120-tables/samples/quickstart.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-area120-tables/samples/quickstart.js,packages/google-area120-tables/samples/README.md) | diff --git a/packages/google-area120-tables/package.json b/packages/google-area120-tables/package.json index 120bd7da064..feecd5d76d4 100644 --- a/packages/google-area120-tables/package.json +++ b/packages/google-area120-tables/package.json @@ -45,14 +45,15 @@ "test": "c8 mocha build/test" }, "dependencies": { - "google-gax": "^3.5.8" + "google-gax": "^4.0.3" }, "devDependencies": { "@types/mocha": "^9.0.0", - "@types/node": "^18.0.0", + "@types/node": "^20.4.5", "@types/sinon": "^10.0.0", "c8": "^7.3.0", - "gts": "^3.1.0", + "gapic-tools": "^0.1.8", + "gts": "^5.0.0", "jsdoc": "^4.0.0", "jsdoc-fresh": "^2.0.0", "jsdoc-region-tag": "^2.0.0", @@ -63,12 +64,12 @@ "pack-n-play": "^1.0.0-2", "sinon": "^15.0.0", "ts-loader": "^9.0.0", - "typescript": "^4.6.4", + "typescript": "^5.1.6", "webpack": "^5.0.0", "webpack-cli": "^5.0.0" }, "engines": { - "node": ">=12.0.0" + "node": ">=14.0.0" }, "homepage": "https://github.com/googleapis/google-cloud-node/tree/main/packages/google-area120-tables" } diff --git a/packages/google-area120-tables/samples/README.md b/packages/google-area120-tables/samples/README.md index 7d14a8e3ea0..db981657cc0 100644 --- a/packages/google-area120-tables/samples/README.md +++ b/packages/google-area120-tables/samples/README.md @@ -25,7 +25,6 @@ * [Tables_service.list_workspaces](#tables_service.list_workspaces) * [Tables_service.update_row](#tables_service.update_row) * [Quickstart](#quickstart) - * [Quickstart.test](#quickstart.test) ## Before you begin @@ -258,23 +257,6 @@ __Usage:__ `node packages/google-area120-tables/samples/quickstart.js` ------ - - - - -### Quickstart.test - -View the [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-area120-tables/samples/test/quickstart.test.js). - -[![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-area120-tables/samples/test/quickstart.test.js,samples/README.md) - -__Usage:__ - - -`node packages/google-area120-tables/samples/test/quickstart.test.js` - - diff --git a/packages/google-area120-tables/samples/generated/v1alpha1/snippet_metadata.google.area120.tables.v1alpha1.json b/packages/google-area120-tables/samples/generated/v1alpha1/snippet_metadata.google.area120.tables.v1alpha1.json index 375c15366f7..5560ea23794 100644 --- a/packages/google-area120-tables/samples/generated/v1alpha1/snippet_metadata.google.area120.tables.v1alpha1.json +++ b/packages/google-area120-tables/samples/generated/v1alpha1/snippet_metadata.google.area120.tables.v1alpha1.json @@ -1,7 +1,7 @@ { "clientLibrary": { "name": "nodejs-tables", - "version": "2.2.1", + "version": "2.2.2", "language": "TYPESCRIPT", "apis": [ { diff --git a/packages/google-area120-tables/samples/generated/v1alpha1/snippet_metadata_google.area120.tables.v1alpha1.json b/packages/google-area120-tables/samples/generated/v1alpha1/snippet_metadata_google.area120.tables.v1alpha1.json new file mode 100644 index 00000000000..5560ea23794 --- /dev/null +++ b/packages/google-area120-tables/samples/generated/v1alpha1/snippet_metadata_google.area120.tables.v1alpha1.json @@ -0,0 +1,551 @@ +{ + "clientLibrary": { + "name": "nodejs-tables", + "version": "2.2.2", + "language": "TYPESCRIPT", + "apis": [ + { + "id": "google.area120.tables.v1alpha1", + "version": "v1alpha1" + } + ] + }, + "snippets": [ + { + "regionTag": "area120tables_v1alpha1_generated_TablesService_GetTable_async", + "title": "TablesService getTable Sample", + "origin": "API_DEFINITION", + "description": " Gets a table. Returns NOT_FOUND if the table does not exist.", + "canonical": true, + "file": "tables_service.get_table.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 54, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetTable", + "fullName": "google.area120.tables.v1alpha1.TablesService.GetTable", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.area120.tables.v1alpha1.Table", + "client": { + "shortName": "TablesServiceClient", + "fullName": "google.area120.tables.v1alpha1.TablesServiceClient" + }, + "method": { + "shortName": "GetTable", + "fullName": "google.area120.tables.v1alpha1.TablesService.GetTable", + "service": { + "shortName": "TablesService", + "fullName": "google.area120.tables.v1alpha1.TablesService" + } + } + } + }, + { + "regionTag": "area120tables_v1alpha1_generated_TablesService_ListTables_async", + "title": "TablesService listTables Sample", + "origin": "API_DEFINITION", + "description": " Lists tables for the user.", + "canonical": true, + "file": "tables_service.list_tables.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 64, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListTables", + "fullName": "google.area120.tables.v1alpha1.TablesService.ListTables", + "async": true, + "parameters": [ + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.area120.tables.v1alpha1.ListTablesResponse", + "client": { + "shortName": "TablesServiceClient", + "fullName": "google.area120.tables.v1alpha1.TablesServiceClient" + }, + "method": { + "shortName": "ListTables", + "fullName": "google.area120.tables.v1alpha1.TablesService.ListTables", + "service": { + "shortName": "TablesService", + "fullName": "google.area120.tables.v1alpha1.TablesService" + } + } + } + }, + { + "regionTag": "area120tables_v1alpha1_generated_TablesService_GetWorkspace_async", + "title": "TablesService getWorkspace Sample", + "origin": "API_DEFINITION", + "description": " Gets a workspace. Returns NOT_FOUND if the workspace does not exist.", + "canonical": true, + "file": "tables_service.get_workspace.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 54, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetWorkspace", + "fullName": "google.area120.tables.v1alpha1.TablesService.GetWorkspace", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.area120.tables.v1alpha1.Workspace", + "client": { + "shortName": "TablesServiceClient", + "fullName": "google.area120.tables.v1alpha1.TablesServiceClient" + }, + "method": { + "shortName": "GetWorkspace", + "fullName": "google.area120.tables.v1alpha1.TablesService.GetWorkspace", + "service": { + "shortName": "TablesService", + "fullName": "google.area120.tables.v1alpha1.TablesService" + } + } + } + }, + { + "regionTag": "area120tables_v1alpha1_generated_TablesService_ListWorkspaces_async", + "title": "TablesService listWorkspaces Sample", + "origin": "API_DEFINITION", + "description": " Lists workspaces for the user.", + "canonical": true, + "file": "tables_service.list_workspaces.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 64, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListWorkspaces", + "fullName": "google.area120.tables.v1alpha1.TablesService.ListWorkspaces", + "async": true, + "parameters": [ + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.area120.tables.v1alpha1.ListWorkspacesResponse", + "client": { + "shortName": "TablesServiceClient", + "fullName": "google.area120.tables.v1alpha1.TablesServiceClient" + }, + "method": { + "shortName": "ListWorkspaces", + "fullName": "google.area120.tables.v1alpha1.TablesService.ListWorkspaces", + "service": { + "shortName": "TablesService", + "fullName": "google.area120.tables.v1alpha1.TablesService" + } + } + } + }, + { + "regionTag": "area120tables_v1alpha1_generated_TablesService_GetRow_async", + "title": "TablesService getRow Sample", + "origin": "API_DEFINITION", + "description": " Gets a row. Returns NOT_FOUND if the row does not exist in the table.", + "canonical": true, + "file": "tables_service.get_row.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 59, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetRow", + "fullName": "google.area120.tables.v1alpha1.TablesService.GetRow", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + }, + { + "name": "view", + "type": ".google.area120.tables.v1alpha1.View" + } + ], + "resultType": ".google.area120.tables.v1alpha1.Row", + "client": { + "shortName": "TablesServiceClient", + "fullName": "google.area120.tables.v1alpha1.TablesServiceClient" + }, + "method": { + "shortName": "GetRow", + "fullName": "google.area120.tables.v1alpha1.TablesService.GetRow", + "service": { + "shortName": "TablesService", + "fullName": "google.area120.tables.v1alpha1.TablesService" + } + } + } + }, + { + "regionTag": "area120tables_v1alpha1_generated_TablesService_ListRows_async", + "title": "TablesService listRows Sample", + "origin": "API_DEFINITION", + "description": " Lists rows in a table. Returns NOT_FOUND if the table does not exist.", + "canonical": true, + "file": "tables_service.list_rows.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 81, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListRows", + "fullName": "google.area120.tables.v1alpha1.TablesService.ListRows", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "view", + "type": ".google.area120.tables.v1alpha1.View" + }, + { + "name": "filter", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.area120.tables.v1alpha1.ListRowsResponse", + "client": { + "shortName": "TablesServiceClient", + "fullName": "google.area120.tables.v1alpha1.TablesServiceClient" + }, + "method": { + "shortName": "ListRows", + "fullName": "google.area120.tables.v1alpha1.TablesService.ListRows", + "service": { + "shortName": "TablesService", + "fullName": "google.area120.tables.v1alpha1.TablesService" + } + } + } + }, + { + "regionTag": "area120tables_v1alpha1_generated_TablesService_CreateRow_async", + "title": "TablesService createRow Sample", + "origin": "API_DEFINITION", + "description": " Creates a row.", + "canonical": true, + "file": "tables_service.create_row.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 64, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CreateRow", + "fullName": "google.area120.tables.v1alpha1.TablesService.CreateRow", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "row", + "type": ".google.area120.tables.v1alpha1.Row" + }, + { + "name": "view", + "type": ".google.area120.tables.v1alpha1.View" + } + ], + "resultType": ".google.area120.tables.v1alpha1.Row", + "client": { + "shortName": "TablesServiceClient", + "fullName": "google.area120.tables.v1alpha1.TablesServiceClient" + }, + "method": { + "shortName": "CreateRow", + "fullName": "google.area120.tables.v1alpha1.TablesService.CreateRow", + "service": { + "shortName": "TablesService", + "fullName": "google.area120.tables.v1alpha1.TablesService" + } + } + } + }, + { + "regionTag": "area120tables_v1alpha1_generated_TablesService_BatchCreateRows_async", + "title": "TablesService batchCreateRows Sample", + "origin": "API_DEFINITION", + "description": " Creates multiple rows.", + "canonical": true, + "file": "tables_service.batch_create_rows.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 60, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "BatchCreateRows", + "fullName": "google.area120.tables.v1alpha1.TablesService.BatchCreateRows", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "requests", + "type": "TYPE_MESSAGE[]" + } + ], + "resultType": ".google.area120.tables.v1alpha1.BatchCreateRowsResponse", + "client": { + "shortName": "TablesServiceClient", + "fullName": "google.area120.tables.v1alpha1.TablesServiceClient" + }, + "method": { + "shortName": "BatchCreateRows", + "fullName": "google.area120.tables.v1alpha1.TablesService.BatchCreateRows", + "service": { + "shortName": "TablesService", + "fullName": "google.area120.tables.v1alpha1.TablesService" + } + } + } + }, + { + "regionTag": "area120tables_v1alpha1_generated_TablesService_UpdateRow_async", + "title": "TablesService updateRow Sample", + "origin": "API_DEFINITION", + "description": " Updates a row.", + "canonical": true, + "file": "tables_service.update_row.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 62, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "UpdateRow", + "fullName": "google.area120.tables.v1alpha1.TablesService.UpdateRow", + "async": true, + "parameters": [ + { + "name": "row", + "type": ".google.area120.tables.v1alpha1.Row" + }, + { + "name": "update_mask", + "type": ".google.protobuf.FieldMask" + }, + { + "name": "view", + "type": ".google.area120.tables.v1alpha1.View" + } + ], + "resultType": ".google.area120.tables.v1alpha1.Row", + "client": { + "shortName": "TablesServiceClient", + "fullName": "google.area120.tables.v1alpha1.TablesServiceClient" + }, + "method": { + "shortName": "UpdateRow", + "fullName": "google.area120.tables.v1alpha1.TablesService.UpdateRow", + "service": { + "shortName": "TablesService", + "fullName": "google.area120.tables.v1alpha1.TablesService" + } + } + } + }, + { + "regionTag": "area120tables_v1alpha1_generated_TablesService_BatchUpdateRows_async", + "title": "TablesService batchUpdateRows Sample", + "origin": "API_DEFINITION", + "description": " Updates multiple rows.", + "canonical": true, + "file": "tables_service.batch_update_rows.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 60, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "BatchUpdateRows", + "fullName": "google.area120.tables.v1alpha1.TablesService.BatchUpdateRows", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "requests", + "type": "TYPE_MESSAGE[]" + } + ], + "resultType": ".google.area120.tables.v1alpha1.BatchUpdateRowsResponse", + "client": { + "shortName": "TablesServiceClient", + "fullName": "google.area120.tables.v1alpha1.TablesServiceClient" + }, + "method": { + "shortName": "BatchUpdateRows", + "fullName": "google.area120.tables.v1alpha1.TablesService.BatchUpdateRows", + "service": { + "shortName": "TablesService", + "fullName": "google.area120.tables.v1alpha1.TablesService" + } + } + } + }, + { + "regionTag": "area120tables_v1alpha1_generated_TablesService_DeleteRow_async", + "title": "TablesService deleteRow Sample", + "origin": "API_DEFINITION", + "description": " Deletes a row.", + "canonical": true, + "file": "tables_service.delete_row.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 54, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeleteRow", + "fullName": "google.area120.tables.v1alpha1.TablesService.DeleteRow", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.protobuf.Empty", + "client": { + "shortName": "TablesServiceClient", + "fullName": "google.area120.tables.v1alpha1.TablesServiceClient" + }, + "method": { + "shortName": "DeleteRow", + "fullName": "google.area120.tables.v1alpha1.TablesService.DeleteRow", + "service": { + "shortName": "TablesService", + "fullName": "google.area120.tables.v1alpha1.TablesService" + } + } + } + }, + { + "regionTag": "area120tables_v1alpha1_generated_TablesService_BatchDeleteRows_async", + "title": "TablesService batchDeleteRows Sample", + "origin": "API_DEFINITION", + "description": " Deletes multiple rows.", + "canonical": true, + "file": "tables_service.batch_delete_rows.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 62, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "BatchDeleteRows", + "fullName": "google.area120.tables.v1alpha1.TablesService.BatchDeleteRows", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "names", + "type": "TYPE_STRING[]" + } + ], + "resultType": ".google.protobuf.Empty", + "client": { + "shortName": "TablesServiceClient", + "fullName": "google.area120.tables.v1alpha1.TablesServiceClient" + }, + "method": { + "shortName": "BatchDeleteRows", + "fullName": "google.area120.tables.v1alpha1.TablesService.BatchDeleteRows", + "service": { + "shortName": "TablesService", + "fullName": "google.area120.tables.v1alpha1.TablesService" + } + } + } + } + ] +} \ No newline at end of file diff --git a/packages/google-area120-tables/samples/generated/v1alpha1/tables_service.batch_create_rows.js b/packages/google-area120-tables/samples/generated/v1alpha1/tables_service.batch_create_rows.js index 01a7d08ce5d..53584098ccb 100644 --- a/packages/google-area120-tables/samples/generated/v1alpha1/tables_service.batch_create_rows.js +++ b/packages/google-area120-tables/samples/generated/v1alpha1/tables_service.batch_create_rows.js @@ -37,7 +37,7 @@ function main(parent, requests) { * Required. The request message specifying the rows to create. * A maximum of 500 rows can be created in a single batch. */ - // const requests = 1234 + // const requests = [1,2,3,4] // Imports the Tables library const {TablesServiceClient} = require('@google/area120-tables').v1alpha1; diff --git a/packages/google-area120-tables/samples/generated/v1alpha1/tables_service.batch_delete_rows.js b/packages/google-area120-tables/samples/generated/v1alpha1/tables_service.batch_delete_rows.js index 8cfd8c8171c..74a4e0bc294 100644 --- a/packages/google-area120-tables/samples/generated/v1alpha1/tables_service.batch_delete_rows.js +++ b/packages/google-area120-tables/samples/generated/v1alpha1/tables_service.batch_delete_rows.js @@ -39,7 +39,7 @@ function main(parent, names) { * in a batch. * Format: tables/{table}/rows/{row} */ - // const names = 'abc123' + // const names = ['abc','def'] // Imports the Tables library const {TablesServiceClient} = require('@google/area120-tables').v1alpha1; diff --git a/packages/google-area120-tables/samples/generated/v1alpha1/tables_service.batch_update_rows.js b/packages/google-area120-tables/samples/generated/v1alpha1/tables_service.batch_update_rows.js index 313b1ce0b88..996c9023c55 100644 --- a/packages/google-area120-tables/samples/generated/v1alpha1/tables_service.batch_update_rows.js +++ b/packages/google-area120-tables/samples/generated/v1alpha1/tables_service.batch_update_rows.js @@ -37,7 +37,7 @@ function main(parent, requests) { * Required. The request messages specifying the rows to update. * A maximum of 500 rows can be modified in a single batch. */ - // const requests = 1234 + // const requests = [1,2,3,4] // Imports the Tables library const {TablesServiceClient} = require('@google/area120-tables').v1alpha1; diff --git a/packages/google-area120-tables/samples/package.json b/packages/google-area120-tables/samples/package.json index ba2741c066e..298ef9eda6d 100644 --- a/packages/google-area120-tables/samples/package.json +++ b/packages/google-area120-tables/samples/package.json @@ -4,7 +4,7 @@ "license": "Apache-2.0", "author": "Google LLC", "engines": { - "node": ">=12.0.0" + "node": ">=14.0.0" }, "files": [ "*.js" @@ -24,4 +24,4 @@ "chai": "^4.2.0", "mocha": "^8.0.0" } -} +} \ No newline at end of file diff --git a/packages/google-area120-tables/src/v1alpha1/tables_service_client.ts b/packages/google-area120-tables/src/v1alpha1/tables_service_client.ts index 98596eea9a4..dba5cfadeef 100644 --- a/packages/google-area120-tables/src/v1alpha1/tables_service_client.ts +++ b/packages/google-area120-tables/src/v1alpha1/tables_service_client.ts @@ -41,14 +41,14 @@ const version = require('../../../package.json').version; * The Tables Service provides an API for reading and updating tables. * It defines the following resource model: * - * - The API has a collection of {@link google.area120.tables.v1alpha1.Table|Table} + * - The API has a collection of {@link protos.google.area120.tables.v1alpha1.Table|Table} * resources, named `tables/*` * - * - Each Table has a collection of {@link google.area120.tables.v1alpha1.Row|Row} + * - Each Table has a collection of {@link protos.google.area120.tables.v1alpha1.Row|Row} * resources, named `tables/* /rows/*` * * - The API has a collection of - * {@link google.area120.tables.v1alpha1.Workspace|Workspace} + * {@link protos.google.area120.tables.v1alpha1.Workspace|Workspace} * resources, named `workspaces/*`. * @class * @memberof v1alpha1 @@ -382,9 +382,8 @@ export class TablesServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.area120.tables.v1alpha1.Table | Table}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.area120.tables.v1alpha1.Table|Table}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1alpha1/tables_service.get_table.js * region_tag:area120tables_v1alpha1_generated_TablesService_GetTable_async @@ -468,9 +467,8 @@ export class TablesServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.area120.tables.v1alpha1.Workspace | Workspace}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.area120.tables.v1alpha1.Workspace|Workspace}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1alpha1/tables_service.get_workspace.js * region_tag:area120tables_v1alpha1_generated_TablesService_GetWorkspace_async @@ -563,9 +561,8 @@ export class TablesServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.area120.tables.v1alpha1.Row | Row}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.area120.tables.v1alpha1.Row|Row}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1alpha1/tables_service.get_row.js * region_tag:area120tables_v1alpha1_generated_TablesService_GetRow_async @@ -654,9 +651,8 @@ export class TablesServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.area120.tables.v1alpha1.Row | Row}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.area120.tables.v1alpha1.Row|Row}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1alpha1/tables_service.create_row.js * region_tag:area120tables_v1alpha1_generated_TablesService_CreateRow_async @@ -750,9 +746,8 @@ export class TablesServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.area120.tables.v1alpha1.BatchCreateRowsResponse | BatchCreateRowsResponse}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.area120.tables.v1alpha1.BatchCreateRowsResponse|BatchCreateRowsResponse}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1alpha1/tables_service.batch_create_rows.js * region_tag:area120tables_v1alpha1_generated_TablesService_BatchCreateRows_async @@ -846,9 +841,8 @@ export class TablesServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.area120.tables.v1alpha1.Row | Row}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.area120.tables.v1alpha1.Row|Row}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1alpha1/tables_service.update_row.js * region_tag:area120tables_v1alpha1_generated_TablesService_UpdateRow_async @@ -942,9 +936,8 @@ export class TablesServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.area120.tables.v1alpha1.BatchUpdateRowsResponse | BatchUpdateRowsResponse}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.area120.tables.v1alpha1.BatchUpdateRowsResponse|BatchUpdateRowsResponse}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1alpha1/tables_service.batch_update_rows.js * region_tag:area120tables_v1alpha1_generated_TablesService_BatchUpdateRows_async @@ -1034,9 +1027,8 @@ export class TablesServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.protobuf.Empty | Empty}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.protobuf.Empty|Empty}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1alpha1/tables_service.delete_row.js * region_tag:area120tables_v1alpha1_generated_TablesService_DeleteRow_async @@ -1131,9 +1123,8 @@ export class TablesServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.protobuf.Empty | Empty}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.protobuf.Empty|Empty}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1alpha1/tables_service.batch_delete_rows.js * region_tag:area120tables_v1alpha1_generated_TablesService_BatchDeleteRows_async @@ -1233,14 +1224,13 @@ export class TablesServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.area120.tables.v1alpha1.Table | Table}. + * The first element of the array is Array of {@link protos.google.area120.tables.v1alpha1.Table|Table}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `listTablesAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listTables( @@ -1333,13 +1323,12 @@ export class TablesServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.area120.tables.v1alpha1.Table | Table} on 'data' event. + * An object stream which emits an object representing {@link protos.google.area120.tables.v1alpha1.Table|Table} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listTablesAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listTablesStream( @@ -1381,12 +1370,11 @@ export class TablesServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.area120.tables.v1alpha1.Table | Table}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.area120.tables.v1alpha1.Table|Table}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1alpha1/tables_service.list_tables.js * region_tag:area120tables_v1alpha1_generated_TablesService_ListTables_async @@ -1428,14 +1416,13 @@ export class TablesServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.area120.tables.v1alpha1.Workspace | Workspace}. + * The first element of the array is Array of {@link protos.google.area120.tables.v1alpha1.Workspace|Workspace}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `listWorkspacesAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listWorkspaces( @@ -1528,13 +1515,12 @@ export class TablesServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.area120.tables.v1alpha1.Workspace | Workspace} on 'data' event. + * An object stream which emits an object representing {@link protos.google.area120.tables.v1alpha1.Workspace|Workspace} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listWorkspacesAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listWorkspacesStream( @@ -1576,12 +1562,11 @@ export class TablesServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.area120.tables.v1alpha1.Workspace | Workspace}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.area120.tables.v1alpha1.Workspace|Workspace}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1alpha1/tables_service.list_workspaces.js * region_tag:area120tables_v1alpha1_generated_TablesService_ListWorkspaces_async @@ -1633,14 +1618,13 @@ export class TablesServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.area120.tables.v1alpha1.Row | Row}. + * The first element of the array is Array of {@link protos.google.area120.tables.v1alpha1.Row|Row}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `listRowsAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listRows( @@ -1747,13 +1731,12 @@ export class TablesServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.area120.tables.v1alpha1.Row | Row} on 'data' event. + * An object stream which emits an object representing {@link protos.google.area120.tables.v1alpha1.Row|Row} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listRowsAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listRowsStream( @@ -1809,12 +1792,11 @@ export class TablesServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.area120.tables.v1alpha1.Row | Row}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.area120.tables.v1alpha1.Row|Row}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1alpha1/tables_service.list_rows.js * region_tag:area120tables_v1alpha1_generated_TablesService_ListRows_async diff --git a/packages/google-area120-tables/webpack.config.js b/packages/google-area120-tables/webpack.config.js index 2996b5bb4ce..3217623dd1c 100644 --- a/packages/google-area120-tables/webpack.config.js +++ b/packages/google-area120-tables/webpack.config.js @@ -1,4 +1,4 @@ -// Copyright 2023 Google LLC +// Copyright 2021 Google LLC // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. diff --git a/packages/google-cloud-accessapproval/README.md b/packages/google-cloud-accessapproval/README.md index a2c0e63d550..e753b4626a0 100644 --- a/packages/google-cloud-accessapproval/README.md +++ b/packages/google-cloud-accessapproval/README.md @@ -2,7 +2,7 @@ [//]: # "To regenerate it, use `python -m synthtool`." Google Cloud Platform logo -# [Access Approval: Node.js Client](https://github.com/googleapis/google-cloud-node) +# [Access Approval: Node.js Client](https://github.com/googleapis/google-cloud-node/tree/main/packages/google-cloud-accessapproval) [![release level](https://img.shields.io/badge/release%20level-stable-brightgreen.svg?style=flat)](https://cloud.google.com/terms/launch-stages) [![npm version](https://img.shields.io/npm/v/@google-cloud/access-approval.svg)](https://www.npmjs.org/package/@google-cloud/access-approval) @@ -81,21 +81,20 @@ listRequests(); ## Samples -Samples are in the [`samples/`](https://github.com/googleapis/google-cloud-node/tree/main/samples) directory. Each sample's `README.md` has instructions for running its sample. +Samples are in the [`samples/`](https://github.com/googleapis/google-cloud-node/tree/main/packages/google-cloud-accessapproval/samples) directory. Each sample's `README.md` has instructions for running its sample. | Sample | Source Code | Try it | | --------------------------- | --------------------------------- | ------ | -| Access_approval.approve_approval_request | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-accessapproval/samples/generated/v1/access_approval.approve_approval_request.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-accessapproval/samples/generated/v1/access_approval.approve_approval_request.js,samples/README.md) | -| Access_approval.delete_access_approval_settings | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-accessapproval/samples/generated/v1/access_approval.delete_access_approval_settings.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-accessapproval/samples/generated/v1/access_approval.delete_access_approval_settings.js,samples/README.md) | -| Access_approval.dismiss_approval_request | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-accessapproval/samples/generated/v1/access_approval.dismiss_approval_request.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-accessapproval/samples/generated/v1/access_approval.dismiss_approval_request.js,samples/README.md) | -| Access_approval.get_access_approval_service_account | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-accessapproval/samples/generated/v1/access_approval.get_access_approval_service_account.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-accessapproval/samples/generated/v1/access_approval.get_access_approval_service_account.js,samples/README.md) | -| Access_approval.get_access_approval_settings | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-accessapproval/samples/generated/v1/access_approval.get_access_approval_settings.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-accessapproval/samples/generated/v1/access_approval.get_access_approval_settings.js,samples/README.md) | -| Access_approval.get_approval_request | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-accessapproval/samples/generated/v1/access_approval.get_approval_request.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-accessapproval/samples/generated/v1/access_approval.get_approval_request.js,samples/README.md) | -| Access_approval.invalidate_approval_request | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-accessapproval/samples/generated/v1/access_approval.invalidate_approval_request.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-accessapproval/samples/generated/v1/access_approval.invalidate_approval_request.js,samples/README.md) | -| Access_approval.list_approval_requests | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-accessapproval/samples/generated/v1/access_approval.list_approval_requests.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-accessapproval/samples/generated/v1/access_approval.list_approval_requests.js,samples/README.md) | -| Access_approval.update_access_approval_settings | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-accessapproval/samples/generated/v1/access_approval.update_access_approval_settings.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-accessapproval/samples/generated/v1/access_approval.update_access_approval_settings.js,samples/README.md) | -| Quickstart | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-accessapproval/samples/quickstart.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-accessapproval/samples/quickstart.js,samples/README.md) | -| Quickstart | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-accessapproval/samples/test/quickstart.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-accessapproval/samples/test/quickstart.js,samples/README.md) | +| Access_approval.approve_approval_request | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-accessapproval/samples/generated/v1/access_approval.approve_approval_request.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-accessapproval/samples/generated/v1/access_approval.approve_approval_request.js,packages/google-cloud-accessapproval/samples/README.md) | +| Access_approval.delete_access_approval_settings | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-accessapproval/samples/generated/v1/access_approval.delete_access_approval_settings.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-accessapproval/samples/generated/v1/access_approval.delete_access_approval_settings.js,packages/google-cloud-accessapproval/samples/README.md) | +| Access_approval.dismiss_approval_request | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-accessapproval/samples/generated/v1/access_approval.dismiss_approval_request.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-accessapproval/samples/generated/v1/access_approval.dismiss_approval_request.js,packages/google-cloud-accessapproval/samples/README.md) | +| Access_approval.get_access_approval_service_account | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-accessapproval/samples/generated/v1/access_approval.get_access_approval_service_account.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-accessapproval/samples/generated/v1/access_approval.get_access_approval_service_account.js,packages/google-cloud-accessapproval/samples/README.md) | +| Access_approval.get_access_approval_settings | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-accessapproval/samples/generated/v1/access_approval.get_access_approval_settings.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-accessapproval/samples/generated/v1/access_approval.get_access_approval_settings.js,packages/google-cloud-accessapproval/samples/README.md) | +| Access_approval.get_approval_request | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-accessapproval/samples/generated/v1/access_approval.get_approval_request.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-accessapproval/samples/generated/v1/access_approval.get_approval_request.js,packages/google-cloud-accessapproval/samples/README.md) | +| Access_approval.invalidate_approval_request | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-accessapproval/samples/generated/v1/access_approval.invalidate_approval_request.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-accessapproval/samples/generated/v1/access_approval.invalidate_approval_request.js,packages/google-cloud-accessapproval/samples/README.md) | +| Access_approval.list_approval_requests | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-accessapproval/samples/generated/v1/access_approval.list_approval_requests.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-accessapproval/samples/generated/v1/access_approval.list_approval_requests.js,packages/google-cloud-accessapproval/samples/README.md) | +| Access_approval.update_access_approval_settings | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-accessapproval/samples/generated/v1/access_approval.update_access_approval_settings.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-accessapproval/samples/generated/v1/access_approval.update_access_approval_settings.js,packages/google-cloud-accessapproval/samples/README.md) | +| Quickstart | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-accessapproval/samples/quickstart.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-accessapproval/samples/quickstart.js,packages/google-cloud-accessapproval/samples/README.md) | diff --git a/packages/google-cloud-accessapproval/package.json b/packages/google-cloud-accessapproval/package.json index 90fc2544b93..0916b114eaa 100644 --- a/packages/google-cloud-accessapproval/package.json +++ b/packages/google-cloud-accessapproval/package.json @@ -45,14 +45,15 @@ "test": "c8 mocha build/test" }, "dependencies": { - "google-gax": "^3.5.8" + "google-gax": "^4.0.3" }, "devDependencies": { "@types/mocha": "^9.0.0", - "@types/node": "^18.0.0", + "@types/node": "^20.4.5", "@types/sinon": "^10.0.0", "c8": "^7.3.5", - "gts": "^3.1.0", + "gapic-tools": "^0.1.8", + "gts": "^5.0.0", "jsdoc": "^4.0.0", "jsdoc-fresh": "^2.0.0", "jsdoc-region-tag": "^2.0.0", @@ -63,12 +64,12 @@ "pack-n-play": "^1.0.0-2", "sinon": "^15.0.0", "ts-loader": "^9.0.0", - "typescript": "^4.6.4", + "typescript": "^5.1.6", "webpack": "^5.9.0", "webpack-cli": "^5.0.0" }, "engines": { - "node": ">=12.0.0" + "node": ">=14.0.0" }, "homepage": "https://github.com/googleapis/google-cloud-node/tree/main/packages/google-cloud-accessapproval" } diff --git a/packages/google-cloud-accessapproval/samples/README.md b/packages/google-cloud-accessapproval/samples/README.md index bf2e6a237b9..7efa1da325e 100644 --- a/packages/google-cloud-accessapproval/samples/README.md +++ b/packages/google-cloud-accessapproval/samples/README.md @@ -22,7 +22,6 @@ * [Access_approval.list_approval_requests](#access_approval.list_approval_requests) * [Access_approval.update_access_approval_settings](#access_approval.update_access_approval_settings) * [Quickstart](#quickstart) - * [Quickstart](#quickstart) ## Before you begin @@ -204,23 +203,6 @@ __Usage:__ `node packages/google-cloud-accessapproval/samples/quickstart.js` ------ - - - - -### Quickstart - -View the [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-accessapproval/samples/test/quickstart.js). - -[![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-accessapproval/samples/test/quickstart.js,samples/README.md) - -__Usage:__ - - -`node packages/google-cloud-accessapproval/samples/test/quickstart.js` - - diff --git a/packages/google-cloud-accessapproval/samples/generated/v1/snippet_metadata.google.cloud.accessapproval.v1.json b/packages/google-cloud-accessapproval/samples/generated/v1/snippet_metadata.google.cloud.accessapproval.v1.json index 12678eeb925..bdeb5486f6c 100644 --- a/packages/google-cloud-accessapproval/samples/generated/v1/snippet_metadata.google.cloud.accessapproval.v1.json +++ b/packages/google-cloud-accessapproval/samples/generated/v1/snippet_metadata.google.cloud.accessapproval.v1.json @@ -1,7 +1,7 @@ { "clientLibrary": { "name": "nodejs-accessapproval", - "version": "2.2.0", + "version": "2.2.2", "language": "TYPESCRIPT", "apis": [ { diff --git a/packages/google-cloud-accessapproval/samples/generated/v1/snippet_metadata_google.cloud.accessapproval.v1.json b/packages/google-cloud-accessapproval/samples/generated/v1/snippet_metadata_google.cloud.accessapproval.v1.json new file mode 100644 index 00000000000..bdeb5486f6c --- /dev/null +++ b/packages/google-cloud-accessapproval/samples/generated/v1/snippet_metadata_google.cloud.accessapproval.v1.json @@ -0,0 +1,395 @@ +{ + "clientLibrary": { + "name": "nodejs-accessapproval", + "version": "2.2.2", + "language": "TYPESCRIPT", + "apis": [ + { + "id": "google.cloud.accessapproval.v1", + "version": "v1" + } + ] + }, + "snippets": [ + { + "regionTag": "accessapproval_v1_generated_AccessApproval_ListApprovalRequests_async", + "title": "AccessApproval listApprovalRequests Sample", + "origin": "API_DEFINITION", + "description": " Lists approval requests associated with a project, folder, or organization. Approval requests can be filtered by state (pending, active, dismissed). The order is reverse chronological.", + "canonical": true, + "file": "access_approval.list_approval_requests.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 77, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListApprovalRequests", + "fullName": "google.cloud.accessapproval.v1.AccessApproval.ListApprovalRequests", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.accessapproval.v1.ListApprovalRequestsResponse", + "client": { + "shortName": "AccessApprovalClient", + "fullName": "google.cloud.accessapproval.v1.AccessApprovalClient" + }, + "method": { + "shortName": "ListApprovalRequests", + "fullName": "google.cloud.accessapproval.v1.AccessApproval.ListApprovalRequests", + "service": { + "shortName": "AccessApproval", + "fullName": "google.cloud.accessapproval.v1.AccessApproval" + } + } + } + }, + { + "regionTag": "accessapproval_v1_generated_AccessApproval_GetApprovalRequest_async", + "title": "AccessApproval getApprovalRequest Sample", + "origin": "API_DEFINITION", + "description": " Gets an approval request. Returns NOT_FOUND if the request does not exist.", + "canonical": true, + "file": "access_approval.get_approval_request.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 54, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetApprovalRequest", + "fullName": "google.cloud.accessapproval.v1.AccessApproval.GetApprovalRequest", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.accessapproval.v1.ApprovalRequest", + "client": { + "shortName": "AccessApprovalClient", + "fullName": "google.cloud.accessapproval.v1.AccessApprovalClient" + }, + "method": { + "shortName": "GetApprovalRequest", + "fullName": "google.cloud.accessapproval.v1.AccessApproval.GetApprovalRequest", + "service": { + "shortName": "AccessApproval", + "fullName": "google.cloud.accessapproval.v1.AccessApproval" + } + } + } + }, + { + "regionTag": "accessapproval_v1_generated_AccessApproval_ApproveApprovalRequest_async", + "title": "AccessApproval approveApprovalRequest Sample", + "origin": "API_DEFINITION", + "description": " Approves a request and returns the updated ApprovalRequest. Returns NOT_FOUND if the request does not exist. Returns FAILED_PRECONDITION if the request exists but is not in a pending state.", + "canonical": true, + "file": "access_approval.approve_approval_request.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 56, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ApproveApprovalRequest", + "fullName": "google.cloud.accessapproval.v1.AccessApproval.ApproveApprovalRequest", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + }, + { + "name": "expire_time", + "type": ".google.protobuf.Timestamp" + } + ], + "resultType": ".google.cloud.accessapproval.v1.ApprovalRequest", + "client": { + "shortName": "AccessApprovalClient", + "fullName": "google.cloud.accessapproval.v1.AccessApprovalClient" + }, + "method": { + "shortName": "ApproveApprovalRequest", + "fullName": "google.cloud.accessapproval.v1.AccessApproval.ApproveApprovalRequest", + "service": { + "shortName": "AccessApproval", + "fullName": "google.cloud.accessapproval.v1.AccessApproval" + } + } + } + }, + { + "regionTag": "accessapproval_v1_generated_AccessApproval_DismissApprovalRequest_async", + "title": "AccessApproval dismissApprovalRequest Sample", + "origin": "API_DEFINITION", + "description": " Dismisses a request. Returns the updated ApprovalRequest. NOTE: This does not deny access to the resource if another request has been made and approved. It is equivalent in effect to ignoring the request altogether. Returns NOT_FOUND if the request does not exist. Returns FAILED_PRECONDITION if the request exists but is not in a pending state.", + "canonical": true, + "file": "access_approval.dismiss_approval_request.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 52, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DismissApprovalRequest", + "fullName": "google.cloud.accessapproval.v1.AccessApproval.DismissApprovalRequest", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.accessapproval.v1.ApprovalRequest", + "client": { + "shortName": "AccessApprovalClient", + "fullName": "google.cloud.accessapproval.v1.AccessApprovalClient" + }, + "method": { + "shortName": "DismissApprovalRequest", + "fullName": "google.cloud.accessapproval.v1.AccessApproval.DismissApprovalRequest", + "service": { + "shortName": "AccessApproval", + "fullName": "google.cloud.accessapproval.v1.AccessApproval" + } + } + } + }, + { + "regionTag": "accessapproval_v1_generated_AccessApproval_InvalidateApprovalRequest_async", + "title": "AccessApproval invalidateApprovalRequest Sample", + "origin": "API_DEFINITION", + "description": " Invalidates an existing ApprovalRequest. Returns the updated ApprovalRequest. NOTE: This does not deny access to the resource if another request has been made and approved. It only invalidates a single approval. Returns FAILED_PRECONDITION if the request exists but is not in an approved state.", + "canonical": true, + "file": "access_approval.invalidate_approval_request.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 52, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "InvalidateApprovalRequest", + "fullName": "google.cloud.accessapproval.v1.AccessApproval.InvalidateApprovalRequest", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.accessapproval.v1.ApprovalRequest", + "client": { + "shortName": "AccessApprovalClient", + "fullName": "google.cloud.accessapproval.v1.AccessApprovalClient" + }, + "method": { + "shortName": "InvalidateApprovalRequest", + "fullName": "google.cloud.accessapproval.v1.AccessApproval.InvalidateApprovalRequest", + "service": { + "shortName": "AccessApproval", + "fullName": "google.cloud.accessapproval.v1.AccessApproval" + } + } + } + }, + { + "regionTag": "accessapproval_v1_generated_AccessApproval_GetAccessApprovalSettings_async", + "title": "AccessApproval getAccessApprovalSettings Sample", + "origin": "API_DEFINITION", + "description": " Gets the settings associated with a project, folder, or organization.", + "canonical": true, + "file": "access_approval.get_access_approval_settings.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 53, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetAccessApprovalSettings", + "fullName": "google.cloud.accessapproval.v1.AccessApproval.GetAccessApprovalSettings", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.accessapproval.v1.AccessApprovalSettings", + "client": { + "shortName": "AccessApprovalClient", + "fullName": "google.cloud.accessapproval.v1.AccessApprovalClient" + }, + "method": { + "shortName": "GetAccessApprovalSettings", + "fullName": "google.cloud.accessapproval.v1.AccessApproval.GetAccessApprovalSettings", + "service": { + "shortName": "AccessApproval", + "fullName": "google.cloud.accessapproval.v1.AccessApproval" + } + } + } + }, + { + "regionTag": "accessapproval_v1_generated_AccessApproval_UpdateAccessApprovalSettings_async", + "title": "AccessApproval updateAccessApprovalSettings Sample", + "origin": "API_DEFINITION", + "description": " Updates the settings associated with a project, folder, or organization. Settings to update are determined by the value of field_mask.", + "canonical": true, + "file": "access_approval.update_access_approval_settings.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 64, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "UpdateAccessApprovalSettings", + "fullName": "google.cloud.accessapproval.v1.AccessApproval.UpdateAccessApprovalSettings", + "async": true, + "parameters": [ + { + "name": "settings", + "type": ".google.cloud.accessapproval.v1.AccessApprovalSettings" + }, + { + "name": "update_mask", + "type": ".google.protobuf.FieldMask" + } + ], + "resultType": ".google.cloud.accessapproval.v1.AccessApprovalSettings", + "client": { + "shortName": "AccessApprovalClient", + "fullName": "google.cloud.accessapproval.v1.AccessApprovalClient" + }, + "method": { + "shortName": "UpdateAccessApprovalSettings", + "fullName": "google.cloud.accessapproval.v1.AccessApproval.UpdateAccessApprovalSettings", + "service": { + "shortName": "AccessApproval", + "fullName": "google.cloud.accessapproval.v1.AccessApproval" + } + } + } + }, + { + "regionTag": "accessapproval_v1_generated_AccessApproval_DeleteAccessApprovalSettings_async", + "title": "AccessApproval deleteAccessApprovalSettings Sample", + "origin": "API_DEFINITION", + "description": " Deletes the settings associated with a project, folder, or organization. This will have the effect of disabling Access Approval for the project, folder, or organization, but only if all ancestors also have Access Approval disabled. If Access Approval is enabled at a higher level of the hierarchy, then Access Approval will still be enabled at this level as the settings are inherited.", + "canonical": true, + "file": "access_approval.delete_access_approval_settings.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 52, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeleteAccessApprovalSettings", + "fullName": "google.cloud.accessapproval.v1.AccessApproval.DeleteAccessApprovalSettings", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.protobuf.Empty", + "client": { + "shortName": "AccessApprovalClient", + "fullName": "google.cloud.accessapproval.v1.AccessApprovalClient" + }, + "method": { + "shortName": "DeleteAccessApprovalSettings", + "fullName": "google.cloud.accessapproval.v1.AccessApproval.DeleteAccessApprovalSettings", + "service": { + "shortName": "AccessApproval", + "fullName": "google.cloud.accessapproval.v1.AccessApproval" + } + } + } + }, + { + "regionTag": "accessapproval_v1_generated_AccessApproval_GetAccessApprovalServiceAccount_async", + "title": "AccessApproval getAccessApprovalServiceAccount Sample", + "origin": "API_DEFINITION", + "description": " Retrieves the service account that is used by Access Approval to access KMS keys for signing approved approval requests.", + "canonical": true, + "file": "access_approval.get_access_approval_service_account.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 52, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetAccessApprovalServiceAccount", + "fullName": "google.cloud.accessapproval.v1.AccessApproval.GetAccessApprovalServiceAccount", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.accessapproval.v1.AccessApprovalServiceAccount", + "client": { + "shortName": "AccessApprovalClient", + "fullName": "google.cloud.accessapproval.v1.AccessApprovalClient" + }, + "method": { + "shortName": "GetAccessApprovalServiceAccount", + "fullName": "google.cloud.accessapproval.v1.AccessApproval.GetAccessApprovalServiceAccount", + "service": { + "shortName": "AccessApproval", + "fullName": "google.cloud.accessapproval.v1.AccessApproval" + } + } + } + } + ] +} \ No newline at end of file diff --git a/packages/google-cloud-accessapproval/samples/package.json b/packages/google-cloud-accessapproval/samples/package.json index 6cbfdac1cb0..506b74dd228 100644 --- a/packages/google-cloud-accessapproval/samples/package.json +++ b/packages/google-cloud-accessapproval/samples/package.json @@ -4,7 +4,7 @@ "license": "Apache-2.0", "author": "Google LLC", "engines": { - "node": ">=12.0.0" + "node": ">=14.0.0" }, "files": [ "*.js" @@ -20,4 +20,4 @@ "chai": "^4.2.0", "mocha": "^8.0.0" } -} +} \ No newline at end of file diff --git a/packages/google-cloud-accessapproval/src/v1/access_approval_client.ts b/packages/google-cloud-accessapproval/src/v1/access_approval_client.ts index 6853b23b266..7a417afea37 100644 --- a/packages/google-cloud-accessapproval/src/v1/access_approval_client.ts +++ b/packages/google-cloud-accessapproval/src/v1/access_approval_client.ts @@ -42,7 +42,7 @@ const version = require('../../../package.json').version; * Google personnel. It defines the following resource model: * * - The API has a collection of - * {@link google.cloud.accessapproval.v1.ApprovalRequest|ApprovalRequest} + * {@link protos.google.cloud.accessapproval.v1.ApprovalRequest|ApprovalRequest} * resources, named `approvalRequests/{approval_request}` * - The API has top-level settings per Project/Folder/Organization, named * `accessApprovalSettings` @@ -410,9 +410,8 @@ export class AccessApprovalClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.accessapproval.v1.ApprovalRequest | ApprovalRequest}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.accessapproval.v1.ApprovalRequest|ApprovalRequest}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/access_approval.get_approval_request.js * region_tag:accessapproval_v1_generated_AccessApproval_GetApprovalRequest_async @@ -512,9 +511,8 @@ export class AccessApprovalClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.accessapproval.v1.ApprovalRequest | ApprovalRequest}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.accessapproval.v1.ApprovalRequest|ApprovalRequest}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/access_approval.approve_approval_request.js * region_tag:accessapproval_v1_generated_AccessApproval_ApproveApprovalRequest_async @@ -622,9 +620,8 @@ export class AccessApprovalClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.accessapproval.v1.ApprovalRequest | ApprovalRequest}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.accessapproval.v1.ApprovalRequest|ApprovalRequest}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/access_approval.dismiss_approval_request.js * region_tag:accessapproval_v1_generated_AccessApproval_DismissApprovalRequest_async @@ -730,9 +727,8 @@ export class AccessApprovalClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.accessapproval.v1.ApprovalRequest | ApprovalRequest}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.accessapproval.v1.ApprovalRequest|ApprovalRequest}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/access_approval.invalidate_approval_request.js * region_tag:accessapproval_v1_generated_AccessApproval_InvalidateApprovalRequest_async @@ -832,9 +828,8 @@ export class AccessApprovalClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.accessapproval.v1.AccessApprovalSettings | AccessApprovalSettings}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.accessapproval.v1.AccessApprovalSettings|AccessApprovalSettings}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/access_approval.get_access_approval_settings.js * region_tag:accessapproval_v1_generated_AccessApproval_GetAccessApprovalSettings_async @@ -945,9 +940,8 @@ export class AccessApprovalClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.accessapproval.v1.AccessApprovalSettings | AccessApprovalSettings}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.accessapproval.v1.AccessApprovalSettings|AccessApprovalSettings}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/access_approval.update_access_approval_settings.js * region_tag:accessapproval_v1_generated_AccessApproval_UpdateAccessApprovalSettings_async @@ -1051,9 +1045,8 @@ export class AccessApprovalClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.protobuf.Empty | Empty}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.protobuf.Empty|Empty}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/access_approval.delete_access_approval_settings.js * region_tag:accessapproval_v1_generated_AccessApproval_DeleteAccessApprovalSettings_async @@ -1153,9 +1146,8 @@ export class AccessApprovalClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.accessapproval.v1.AccessApprovalServiceAccount | AccessApprovalServiceAccount}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.accessapproval.v1.AccessApprovalServiceAccount|AccessApprovalServiceAccount}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/access_approval.get_access_approval_service_account.js * region_tag:accessapproval_v1_generated_AccessApproval_GetAccessApprovalServiceAccount_async @@ -1275,14 +1267,13 @@ export class AccessApprovalClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.cloud.accessapproval.v1.ApprovalRequest | ApprovalRequest}. + * The first element of the array is Array of {@link protos.google.cloud.accessapproval.v1.ApprovalRequest|ApprovalRequest}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `listApprovalRequestsAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listApprovalRequests( @@ -1387,13 +1378,12 @@ export class AccessApprovalClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.cloud.accessapproval.v1.ApprovalRequest | ApprovalRequest} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.accessapproval.v1.ApprovalRequest|ApprovalRequest} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listApprovalRequestsAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listApprovalRequestsStream( @@ -1447,12 +1437,11 @@ export class AccessApprovalClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.cloud.accessapproval.v1.ApprovalRequest | ApprovalRequest}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.accessapproval.v1.ApprovalRequest|ApprovalRequest}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1/access_approval.list_approval_requests.js * region_tag:accessapproval_v1_generated_AccessApproval_ListApprovalRequests_async diff --git a/packages/google-cloud-advisorynotifications/README.md b/packages/google-cloud-advisorynotifications/README.md index 9d9170f0500..b9ddef0cee3 100644 --- a/packages/google-cloud-advisorynotifications/README.md +++ b/packages/google-cloud-advisorynotifications/README.md @@ -2,7 +2,7 @@ [//]: # "To regenerate it, use `python -m synthtool`." Google Cloud Platform logo -# [Advisory Notifications API: Node.js Client](https://github.com/googleapis/google-cloud-node) +# [Advisory Notifications API: Node.js Client](https://github.com/googleapis/google-cloud-node/tree/main/packages/google-cloud-advisorynotifications) [![release level](https://img.shields.io/badge/release%20level-preview-yellow.svg?style=flat)](https://cloud.google.com/terms/launch-stages) [![npm version](https://img.shields.io/npm/v/@google-cloud/advisorynotifications.svg)](https://www.npmjs.org/package/@google-cloud/advisorynotifications) @@ -125,14 +125,13 @@ callListNotifications(); ## Samples -Samples are in the [`samples/`](https://github.com/googleapis/google-cloud-node/tree/main/samples) directory. Each sample's `README.md` has instructions for running its sample. +Samples are in the [`samples/`](https://github.com/googleapis/google-cloud-node/tree/main/packages/google-cloud-advisorynotifications/samples) directory. Each sample's `README.md` has instructions for running its sample. | Sample | Source Code | Try it | | --------------------------- | --------------------------------- | ------ | -| Advisory_notifications_service.get_notification | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-advisorynotifications/samples/generated/v1/advisory_notifications_service.get_notification.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-advisorynotifications/samples/generated/v1/advisory_notifications_service.get_notification.js,samples/README.md) | -| Advisory_notifications_service.list_notifications | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-advisorynotifications/samples/generated/v1/advisory_notifications_service.list_notifications.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-advisorynotifications/samples/generated/v1/advisory_notifications_service.list_notifications.js,samples/README.md) | -| Quickstart | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-advisorynotifications/samples/quickstart.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-advisorynotifications/samples/quickstart.js,samples/README.md) | -| Quickstart | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-advisorynotifications/samples/test/quickstart.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-advisorynotifications/samples/test/quickstart.js,samples/README.md) | +| Advisory_notifications_service.get_notification | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-advisorynotifications/samples/generated/v1/advisory_notifications_service.get_notification.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-advisorynotifications/samples/generated/v1/advisory_notifications_service.get_notification.js,packages/google-cloud-advisorynotifications/samples/README.md) | +| Advisory_notifications_service.list_notifications | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-advisorynotifications/samples/generated/v1/advisory_notifications_service.list_notifications.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-advisorynotifications/samples/generated/v1/advisory_notifications_service.list_notifications.js,packages/google-cloud-advisorynotifications/samples/README.md) | +| Quickstart | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-advisorynotifications/samples/quickstart.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-advisorynotifications/samples/quickstart.js,packages/google-cloud-advisorynotifications/samples/README.md) | diff --git a/packages/google-cloud-advisorynotifications/package.json b/packages/google-cloud-advisorynotifications/package.json index c96d2b9751a..eaef62bb1d5 100644 --- a/packages/google-cloud-advisorynotifications/package.json +++ b/packages/google-cloud-advisorynotifications/package.json @@ -46,14 +46,15 @@ "test": "c8 mocha build/test" }, "dependencies": { - "google-gax": "^3.5.8" + "google-gax": "^4.0.3" }, "devDependencies": { "@types/mocha": "^9.0.0", - "@types/node": "^18.0.0", + "@types/node": "^20.4.5", "@types/sinon": "^10.0.0", "c8": "^7.3.5", - "gts": "^3.1.0", + "gapic-tools": "^0.1.8", + "gts": "^5.0.0", "jsdoc": "^4.0.0", "jsdoc-fresh": "^2.0.0", "jsdoc-region-tag": "^2.0.0", @@ -64,11 +65,11 @@ "pack-n-play": "^1.0.0-2", "sinon": "^15.0.0", "ts-loader": "^9.0.0", - "typescript": "^4.6.4", + "typescript": "^5.1.6", "webpack": "^5.9.0", "webpack-cli": "^5.0.0" }, "engines": { - "node": ">=12.0.0" + "node": ">=14.0.0" } } diff --git a/packages/google-cloud-advisorynotifications/samples/README.md b/packages/google-cloud-advisorynotifications/samples/README.md index 4afe870fea7..c5a451cc4cb 100644 --- a/packages/google-cloud-advisorynotifications/samples/README.md +++ b/packages/google-cloud-advisorynotifications/samples/README.md @@ -15,7 +15,6 @@ * [Advisory_notifications_service.get_notification](#advisory_notifications_service.get_notification) * [Advisory_notifications_service.list_notifications](#advisory_notifications_service.list_notifications) * [Quickstart](#quickstart) - * [Quickstart](#quickstart) ## Before you begin @@ -78,23 +77,6 @@ __Usage:__ `node packages/google-cloud-advisorynotifications/samples/quickstart.js` ------ - - - - -### Quickstart - -View the [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-advisorynotifications/samples/test/quickstart.js). - -[![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-advisorynotifications/samples/test/quickstart.js,samples/README.md) - -__Usage:__ - - -`node packages/google-cloud-advisorynotifications/samples/test/quickstart.js` - - diff --git a/packages/google-cloud-advisorynotifications/samples/generated/v1/snippet_metadata.google.cloud.advisorynotifications.v1.json b/packages/google-cloud-advisorynotifications/samples/generated/v1/snippet_metadata.google.cloud.advisorynotifications.v1.json index 515fcd038eb..74ac58681a4 100644 --- a/packages/google-cloud-advisorynotifications/samples/generated/v1/snippet_metadata.google.cloud.advisorynotifications.v1.json +++ b/packages/google-cloud-advisorynotifications/samples/generated/v1/snippet_metadata.google.cloud.advisorynotifications.v1.json @@ -1,7 +1,7 @@ { "clientLibrary": { "name": "nodejs-advisorynotifications", - "version": "0.2.0", + "version": "0.2.1", "language": "TYPESCRIPT", "apis": [ { diff --git a/packages/google-cloud-advisorynotifications/samples/generated/v1/snippet_metadata_google.cloud.advisorynotifications.v1.json b/packages/google-cloud-advisorynotifications/samples/generated/v1/snippet_metadata_google.cloud.advisorynotifications.v1.json new file mode 100644 index 00000000000..74ac58681a4 --- /dev/null +++ b/packages/google-cloud-advisorynotifications/samples/generated/v1/snippet_metadata_google.cloud.advisorynotifications.v1.json @@ -0,0 +1,115 @@ +{ + "clientLibrary": { + "name": "nodejs-advisorynotifications", + "version": "0.2.1", + "language": "TYPESCRIPT", + "apis": [ + { + "id": "google.cloud.advisorynotifications.v1", + "version": "v1" + } + ] + }, + "snippets": [ + { + "regionTag": "advisorynotifications_v1_generated_AdvisoryNotificationsService_ListNotifications_async", + "title": "AdvisoryNotificationsService listNotifications Sample", + "origin": "API_DEFINITION", + "description": " Lists notifications under a given parent.", + "canonical": true, + "file": "advisory_notifications_service.list_notifications.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 82, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListNotifications", + "fullName": "google.cloud.advisorynotifications.v1.AdvisoryNotificationsService.ListNotifications", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "view", + "type": ".google.cloud.advisorynotifications.v1.NotificationView" + }, + { + "name": "language_code", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.advisorynotifications.v1.ListNotificationsResponse", + "client": { + "shortName": "AdvisoryNotificationsServiceClient", + "fullName": "google.cloud.advisorynotifications.v1.AdvisoryNotificationsServiceClient" + }, + "method": { + "shortName": "ListNotifications", + "fullName": "google.cloud.advisorynotifications.v1.AdvisoryNotificationsService.ListNotifications", + "service": { + "shortName": "AdvisoryNotificationsService", + "fullName": "google.cloud.advisorynotifications.v1.AdvisoryNotificationsService" + } + } + } + }, + { + "regionTag": "advisorynotifications_v1_generated_AdvisoryNotificationsService_GetNotification_async", + "title": "AdvisoryNotificationsService getNotification Sample", + "origin": "API_DEFINITION", + "description": " Gets a notification.", + "canonical": true, + "file": "advisory_notifications_service.get_notification.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 63, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetNotification", + "fullName": "google.cloud.advisorynotifications.v1.AdvisoryNotificationsService.GetNotification", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + }, + { + "name": "language_code", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.advisorynotifications.v1.Notification", + "client": { + "shortName": "AdvisoryNotificationsServiceClient", + "fullName": "google.cloud.advisorynotifications.v1.AdvisoryNotificationsServiceClient" + }, + "method": { + "shortName": "GetNotification", + "fullName": "google.cloud.advisorynotifications.v1.AdvisoryNotificationsService.GetNotification", + "service": { + "shortName": "AdvisoryNotificationsService", + "fullName": "google.cloud.advisorynotifications.v1.AdvisoryNotificationsService" + } + } + } + } + ] +} \ No newline at end of file diff --git a/packages/google-cloud-advisorynotifications/samples/package.json b/packages/google-cloud-advisorynotifications/samples/package.json index bd37447f4db..0b757e79e69 100644 --- a/packages/google-cloud-advisorynotifications/samples/package.json +++ b/packages/google-cloud-advisorynotifications/samples/package.json @@ -4,7 +4,7 @@ "license": "Apache-2.0", "author": "Google LLC", "engines": { - "node": ">=12.0.0" + "node": ">=14.0.0" }, "files": [ "*.js" @@ -21,4 +21,4 @@ "chai": "^4.2.0", "mocha": "^8.0.0" } -} +} \ No newline at end of file diff --git a/packages/google-cloud-advisorynotifications/src/v1/advisory_notifications_service_client.ts b/packages/google-cloud-advisorynotifications/src/v1/advisory_notifications_service_client.ts index 041dc2c6872..223a7670680 100644 --- a/packages/google-cloud-advisorynotifications/src/v1/advisory_notifications_service_client.ts +++ b/packages/google-cloud-advisorynotifications/src/v1/advisory_notifications_service_client.ts @@ -355,9 +355,8 @@ export class AdvisoryNotificationsServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.advisorynotifications.v1.Notification | Notification}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.advisorynotifications.v1.Notification|Notification}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/advisory_notifications_service.get_notification.js * region_tag:advisorynotifications_v1_generated_AdvisoryNotificationsService_GetNotification_async @@ -472,14 +471,13 @@ export class AdvisoryNotificationsServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.cloud.advisorynotifications.v1.Notification | Notification}. + * The first element of the array is Array of {@link protos.google.cloud.advisorynotifications.v1.Notification|Notification}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `listNotificationsAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listNotifications( @@ -585,13 +583,12 @@ export class AdvisoryNotificationsServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.cloud.advisorynotifications.v1.Notification | Notification} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.advisorynotifications.v1.Notification|Notification} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listNotificationsAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listNotificationsStream( @@ -646,12 +643,11 @@ export class AdvisoryNotificationsServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.cloud.advisorynotifications.v1.Notification | Notification}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.advisorynotifications.v1.Notification|Notification}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1/advisory_notifications_service.list_notifications.js * region_tag:advisorynotifications_v1_generated_AdvisoryNotificationsService_ListNotifications_async diff --git a/packages/google-cloud-alloydb/package.json b/packages/google-cloud-alloydb/package.json index a2f4d4f8a2f..761041ec3b9 100644 --- a/packages/google-cloud-alloydb/package.json +++ b/packages/google-cloud-alloydb/package.json @@ -46,14 +46,15 @@ "test": "c8 mocha build/test" }, "dependencies": { - "google-gax": "^3.5.8" + "google-gax": "^4.0.3" }, "devDependencies": { "@types/mocha": "^9.0.0", - "@types/node": "^18.0.0", + "@types/node": "^20.4.5", "@types/sinon": "^10.0.0", "c8": "^7.3.5", - "gts": "^3.1.0", + "gapic-tools": "^0.1.8", + "gts": "^5.0.0", "jsdoc": "^4.0.0", "jsdoc-fresh": "^2.0.0", "jsdoc-region-tag": "^2.0.0", @@ -64,11 +65,11 @@ "pack-n-play": "^1.0.0-2", "sinon": "^15.0.0", "ts-loader": "^9.0.0", - "typescript": "^4.6.4", + "typescript": "^5.1.6", "webpack": "^5.9.0", "webpack-cli": "^5.0.0" }, "engines": { - "node": ">=12.0.0" + "node": ">=14.0.0" } } diff --git a/packages/google-cloud-alloydb/samples/generated/v1/snippet_metadata_google.cloud.alloydb.v1.json b/packages/google-cloud-alloydb/samples/generated/v1/snippet_metadata_google.cloud.alloydb.v1.json new file mode 100644 index 00000000000..920b11fd7ed --- /dev/null +++ b/packages/google-cloud-alloydb/samples/generated/v1/snippet_metadata_google.cloud.alloydb.v1.json @@ -0,0 +1,1535 @@ +{ + "clientLibrary": { + "name": "nodejs-alloydb", + "version": "0.3.0", + "language": "TYPESCRIPT", + "apis": [ + { + "id": "google.cloud.alloydb.v1", + "version": "v1" + } + ] + }, + "snippets": [ + { + "regionTag": "alloydb_v1_generated_AlloyDBAdmin_ListClusters_async", + "title": "AlloyDBAdmin listClusters Sample", + "origin": "API_DEFINITION", + "description": " Lists Clusters in a given project and location.", + "canonical": true, + "file": "alloy_d_b_admin.list_clusters.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 75, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListClusters", + "fullName": "google.cloud.alloydb.v1.AlloyDBAdmin.ListClusters", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.alloydb.v1.ListClustersResponse", + "client": { + "shortName": "AlloyDBAdminClient", + "fullName": "google.cloud.alloydb.v1.AlloyDBAdminClient" + }, + "method": { + "shortName": "ListClusters", + "fullName": "google.cloud.alloydb.v1.AlloyDBAdmin.ListClusters", + "service": { + "shortName": "AlloyDBAdmin", + "fullName": "google.cloud.alloydb.v1.AlloyDBAdmin" + } + } + } + }, + { + "regionTag": "alloydb_v1_generated_AlloyDBAdmin_GetCluster_async", + "title": "AlloyDBAdmin getCluster Sample", + "origin": "API_DEFINITION", + "description": " Gets details of a single Cluster.", + "canonical": true, + "file": "alloy_d_b_admin.get_cluster.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 59, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetCluster", + "fullName": "google.cloud.alloydb.v1.AlloyDBAdmin.GetCluster", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + }, + { + "name": "view", + "type": ".google.cloud.alloydb.v1.ClusterView" + } + ], + "resultType": ".google.cloud.alloydb.v1.Cluster", + "client": { + "shortName": "AlloyDBAdminClient", + "fullName": "google.cloud.alloydb.v1.AlloyDBAdminClient" + }, + "method": { + "shortName": "GetCluster", + "fullName": "google.cloud.alloydb.v1.AlloyDBAdmin.GetCluster", + "service": { + "shortName": "AlloyDBAdmin", + "fullName": "google.cloud.alloydb.v1.AlloyDBAdmin" + } + } + } + }, + { + "regionTag": "alloydb_v1_generated_AlloyDBAdmin_CreateCluster_async", + "title": "AlloyDBAdmin createCluster Sample", + "origin": "API_DEFINITION", + "description": " Creates a new Cluster in a given project and location.", + "canonical": true, + "file": "alloy_d_b_admin.create_cluster.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 85, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CreateCluster", + "fullName": "google.cloud.alloydb.v1.AlloyDBAdmin.CreateCluster", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "cluster_id", + "type": "TYPE_STRING" + }, + { + "name": "cluster", + "type": ".google.cloud.alloydb.v1.Cluster" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "validate_only", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "AlloyDBAdminClient", + "fullName": "google.cloud.alloydb.v1.AlloyDBAdminClient" + }, + "method": { + "shortName": "CreateCluster", + "fullName": "google.cloud.alloydb.v1.AlloyDBAdmin.CreateCluster", + "service": { + "shortName": "AlloyDBAdmin", + "fullName": "google.cloud.alloydb.v1.AlloyDBAdmin" + } + } + } + }, + { + "regionTag": "alloydb_v1_generated_AlloyDBAdmin_UpdateCluster_async", + "title": "AlloyDBAdmin updateCluster Sample", + "origin": "API_DEFINITION", + "description": " Updates the parameters of a single Cluster.", + "canonical": true, + "file": "alloy_d_b_admin.update_cluster.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 87, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "UpdateCluster", + "fullName": "google.cloud.alloydb.v1.AlloyDBAdmin.UpdateCluster", + "async": true, + "parameters": [ + { + "name": "update_mask", + "type": ".google.protobuf.FieldMask" + }, + { + "name": "cluster", + "type": ".google.cloud.alloydb.v1.Cluster" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "validate_only", + "type": "TYPE_BOOL" + }, + { + "name": "allow_missing", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "AlloyDBAdminClient", + "fullName": "google.cloud.alloydb.v1.AlloyDBAdminClient" + }, + "method": { + "shortName": "UpdateCluster", + "fullName": "google.cloud.alloydb.v1.AlloyDBAdmin.UpdateCluster", + "service": { + "shortName": "AlloyDBAdmin", + "fullName": "google.cloud.alloydb.v1.AlloyDBAdmin" + } + } + } + }, + { + "regionTag": "alloydb_v1_generated_AlloyDBAdmin_DeleteCluster_async", + "title": "AlloyDBAdmin deleteCluster Sample", + "origin": "API_DEFINITION", + "description": " Deletes a single Cluster.", + "canonical": true, + "file": "alloy_d_b_admin.delete_cluster.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 84, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeleteCluster", + "fullName": "google.cloud.alloydb.v1.AlloyDBAdmin.DeleteCluster", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "etag", + "type": "TYPE_STRING" + }, + { + "name": "validate_only", + "type": "TYPE_BOOL" + }, + { + "name": "force", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "AlloyDBAdminClient", + "fullName": "google.cloud.alloydb.v1.AlloyDBAdminClient" + }, + "method": { + "shortName": "DeleteCluster", + "fullName": "google.cloud.alloydb.v1.AlloyDBAdmin.DeleteCluster", + "service": { + "shortName": "AlloyDBAdmin", + "fullName": "google.cloud.alloydb.v1.AlloyDBAdmin" + } + } + } + }, + { + "regionTag": "alloydb_v1_generated_AlloyDBAdmin_PromoteCluster_async", + "title": "AlloyDBAdmin promoteCluster Sample", + "origin": "API_DEFINITION", + "description": " Promotes a SECONDARY cluster. This turns down replication from the PRIMARY cluster and promotes a secondary cluster into its own standalone cluster. Imperative only.", + "canonical": true, + "file": "alloy_d_b_admin.promote_cluster.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 80, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "PromoteCluster", + "fullName": "google.cloud.alloydb.v1.AlloyDBAdmin.PromoteCluster", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "etag", + "type": "TYPE_STRING" + }, + { + "name": "validate_only", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "AlloyDBAdminClient", + "fullName": "google.cloud.alloydb.v1.AlloyDBAdminClient" + }, + "method": { + "shortName": "PromoteCluster", + "fullName": "google.cloud.alloydb.v1.AlloyDBAdmin.PromoteCluster", + "service": { + "shortName": "AlloyDBAdmin", + "fullName": "google.cloud.alloydb.v1.AlloyDBAdmin" + } + } + } + }, + { + "regionTag": "alloydb_v1_generated_AlloyDBAdmin_RestoreCluster_async", + "title": "AlloyDBAdmin restoreCluster Sample", + "origin": "API_DEFINITION", + "description": " Creates a new Cluster in a given project and location, with a volume restored from the provided source, either a backup ID or a point-in-time and a source cluster.", + "canonical": true, + "file": "alloy_d_b_admin.restore_cluster.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 94, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "RestoreCluster", + "fullName": "google.cloud.alloydb.v1.AlloyDBAdmin.RestoreCluster", + "async": true, + "parameters": [ + { + "name": "backup_source", + "type": ".google.cloud.alloydb.v1.BackupSource" + }, + { + "name": "continuous_backup_source", + "type": ".google.cloud.alloydb.v1.ContinuousBackupSource" + }, + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "cluster_id", + "type": "TYPE_STRING" + }, + { + "name": "cluster", + "type": ".google.cloud.alloydb.v1.Cluster" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "validate_only", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "AlloyDBAdminClient", + "fullName": "google.cloud.alloydb.v1.AlloyDBAdminClient" + }, + "method": { + "shortName": "RestoreCluster", + "fullName": "google.cloud.alloydb.v1.AlloyDBAdmin.RestoreCluster", + "service": { + "shortName": "AlloyDBAdmin", + "fullName": "google.cloud.alloydb.v1.AlloyDBAdmin" + } + } + } + }, + { + "regionTag": "alloydb_v1_generated_AlloyDBAdmin_CreateSecondaryCluster_async", + "title": "AlloyDBAdmin createSecondaryCluster Sample", + "origin": "API_DEFINITION", + "description": " Creates a cluster of type SECONDARY in the given location using the primary cluster as the source.", + "canonical": true, + "file": "alloy_d_b_admin.create_secondary_cluster.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 85, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CreateSecondaryCluster", + "fullName": "google.cloud.alloydb.v1.AlloyDBAdmin.CreateSecondaryCluster", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "cluster_id", + "type": "TYPE_STRING" + }, + { + "name": "cluster", + "type": ".google.cloud.alloydb.v1.Cluster" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "validate_only", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "AlloyDBAdminClient", + "fullName": "google.cloud.alloydb.v1.AlloyDBAdminClient" + }, + "method": { + "shortName": "CreateSecondaryCluster", + "fullName": "google.cloud.alloydb.v1.AlloyDBAdmin.CreateSecondaryCluster", + "service": { + "shortName": "AlloyDBAdmin", + "fullName": "google.cloud.alloydb.v1.AlloyDBAdmin" + } + } + } + }, + { + "regionTag": "alloydb_v1_generated_AlloyDBAdmin_ListInstances_async", + "title": "AlloyDBAdmin listInstances Sample", + "origin": "API_DEFINITION", + "description": " Lists Instances in a given project and location.", + "canonical": true, + "file": "alloy_d_b_admin.list_instances.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 77, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListInstances", + "fullName": "google.cloud.alloydb.v1.AlloyDBAdmin.ListInstances", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.alloydb.v1.ListInstancesResponse", + "client": { + "shortName": "AlloyDBAdminClient", + "fullName": "google.cloud.alloydb.v1.AlloyDBAdminClient" + }, + "method": { + "shortName": "ListInstances", + "fullName": "google.cloud.alloydb.v1.AlloyDBAdmin.ListInstances", + "service": { + "shortName": "AlloyDBAdmin", + "fullName": "google.cloud.alloydb.v1.AlloyDBAdmin" + } + } + } + }, + { + "regionTag": "alloydb_v1_generated_AlloyDBAdmin_GetInstance_async", + "title": "AlloyDBAdmin getInstance Sample", + "origin": "API_DEFINITION", + "description": " Gets details of a single Instance.", + "canonical": true, + "file": "alloy_d_b_admin.get_instance.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 58, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetInstance", + "fullName": "google.cloud.alloydb.v1.AlloyDBAdmin.GetInstance", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + }, + { + "name": "view", + "type": ".google.cloud.alloydb.v1.InstanceView" + } + ], + "resultType": ".google.cloud.alloydb.v1.Instance", + "client": { + "shortName": "AlloyDBAdminClient", + "fullName": "google.cloud.alloydb.v1.AlloyDBAdminClient" + }, + "method": { + "shortName": "GetInstance", + "fullName": "google.cloud.alloydb.v1.AlloyDBAdmin.GetInstance", + "service": { + "shortName": "AlloyDBAdmin", + "fullName": "google.cloud.alloydb.v1.AlloyDBAdmin" + } + } + } + }, + { + "regionTag": "alloydb_v1_generated_AlloyDBAdmin_CreateInstance_async", + "title": "AlloyDBAdmin createInstance Sample", + "origin": "API_DEFINITION", + "description": " Creates a new Instance in a given project and location.", + "canonical": true, + "file": "alloy_d_b_admin.create_instance.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 85, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CreateInstance", + "fullName": "google.cloud.alloydb.v1.AlloyDBAdmin.CreateInstance", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "instance_id", + "type": "TYPE_STRING" + }, + { + "name": "instance", + "type": ".google.cloud.alloydb.v1.Instance" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "validate_only", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "AlloyDBAdminClient", + "fullName": "google.cloud.alloydb.v1.AlloyDBAdminClient" + }, + "method": { + "shortName": "CreateInstance", + "fullName": "google.cloud.alloydb.v1.AlloyDBAdmin.CreateInstance", + "service": { + "shortName": "AlloyDBAdmin", + "fullName": "google.cloud.alloydb.v1.AlloyDBAdmin" + } + } + } + }, + { + "regionTag": "alloydb_v1_generated_AlloyDBAdmin_CreateSecondaryInstance_async", + "title": "AlloyDBAdmin createSecondaryInstance Sample", + "origin": "API_DEFINITION", + "description": " Creates a new SECONDARY Instance in a given project and location.", + "canonical": true, + "file": "alloy_d_b_admin.create_secondary_instance.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 85, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CreateSecondaryInstance", + "fullName": "google.cloud.alloydb.v1.AlloyDBAdmin.CreateSecondaryInstance", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "instance_id", + "type": "TYPE_STRING" + }, + { + "name": "instance", + "type": ".google.cloud.alloydb.v1.Instance" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "validate_only", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "AlloyDBAdminClient", + "fullName": "google.cloud.alloydb.v1.AlloyDBAdminClient" + }, + "method": { + "shortName": "CreateSecondaryInstance", + "fullName": "google.cloud.alloydb.v1.AlloyDBAdmin.CreateSecondaryInstance", + "service": { + "shortName": "AlloyDBAdmin", + "fullName": "google.cloud.alloydb.v1.AlloyDBAdmin" + } + } + } + }, + { + "regionTag": "alloydb_v1_generated_AlloyDBAdmin_BatchCreateInstances_async", + "title": "AlloyDBAdmin batchCreateInstances Sample", + "origin": "API_DEFINITION", + "description": " Creates new instances under the given project, location and cluster. There can be only one primary instance in a cluster. If the primary instance exists in the cluster as well as this request, then API will throw an error. The primary instance should exist before any read pool instance is created. If the primary instance is a part of the request payload, then the API will take care of creating instances in the correct order. This method is here to support Google-internal use cases, and is not meant for external customers to consume. Please do not start relying on it; its behavior is subject to change without notice.", + "canonical": true, + "file": "alloy_d_b_admin.batch_create_instances.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 73, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "BatchCreateInstances", + "fullName": "google.cloud.alloydb.v1.AlloyDBAdmin.BatchCreateInstances", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "requests", + "type": ".google.cloud.alloydb.v1.CreateInstanceRequests" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "AlloyDBAdminClient", + "fullName": "google.cloud.alloydb.v1.AlloyDBAdminClient" + }, + "method": { + "shortName": "BatchCreateInstances", + "fullName": "google.cloud.alloydb.v1.AlloyDBAdmin.BatchCreateInstances", + "service": { + "shortName": "AlloyDBAdmin", + "fullName": "google.cloud.alloydb.v1.AlloyDBAdmin" + } + } + } + }, + { + "regionTag": "alloydb_v1_generated_AlloyDBAdmin_UpdateInstance_async", + "title": "AlloyDBAdmin updateInstance Sample", + "origin": "API_DEFINITION", + "description": " Updates the parameters of a single Instance.", + "canonical": true, + "file": "alloy_d_b_admin.update_instance.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 87, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "UpdateInstance", + "fullName": "google.cloud.alloydb.v1.AlloyDBAdmin.UpdateInstance", + "async": true, + "parameters": [ + { + "name": "update_mask", + "type": ".google.protobuf.FieldMask" + }, + { + "name": "instance", + "type": ".google.cloud.alloydb.v1.Instance" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "validate_only", + "type": "TYPE_BOOL" + }, + { + "name": "allow_missing", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "AlloyDBAdminClient", + "fullName": "google.cloud.alloydb.v1.AlloyDBAdminClient" + }, + "method": { + "shortName": "UpdateInstance", + "fullName": "google.cloud.alloydb.v1.AlloyDBAdmin.UpdateInstance", + "service": { + "shortName": "AlloyDBAdmin", + "fullName": "google.cloud.alloydb.v1.AlloyDBAdmin" + } + } + } + }, + { + "regionTag": "alloydb_v1_generated_AlloyDBAdmin_DeleteInstance_async", + "title": "AlloyDBAdmin deleteInstance Sample", + "origin": "API_DEFINITION", + "description": " Deletes a single Instance.", + "canonical": true, + "file": "alloy_d_b_admin.delete_instance.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 80, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeleteInstance", + "fullName": "google.cloud.alloydb.v1.AlloyDBAdmin.DeleteInstance", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "etag", + "type": "TYPE_STRING" + }, + { + "name": "validate_only", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "AlloyDBAdminClient", + "fullName": "google.cloud.alloydb.v1.AlloyDBAdminClient" + }, + "method": { + "shortName": "DeleteInstance", + "fullName": "google.cloud.alloydb.v1.AlloyDBAdmin.DeleteInstance", + "service": { + "shortName": "AlloyDBAdmin", + "fullName": "google.cloud.alloydb.v1.AlloyDBAdmin" + } + } + } + }, + { + "regionTag": "alloydb_v1_generated_AlloyDBAdmin_FailoverInstance_async", + "title": "AlloyDBAdmin failoverInstance Sample", + "origin": "API_DEFINITION", + "description": " Forces a Failover for a highly available instance. Failover promotes the HA standby instance as the new primary. Imperative only.", + "canonical": true, + "file": "alloy_d_b_admin.failover_instance.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 74, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "FailoverInstance", + "fullName": "google.cloud.alloydb.v1.AlloyDBAdmin.FailoverInstance", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "validate_only", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "AlloyDBAdminClient", + "fullName": "google.cloud.alloydb.v1.AlloyDBAdminClient" + }, + "method": { + "shortName": "FailoverInstance", + "fullName": "google.cloud.alloydb.v1.AlloyDBAdmin.FailoverInstance", + "service": { + "shortName": "AlloyDBAdmin", + "fullName": "google.cloud.alloydb.v1.AlloyDBAdmin" + } + } + } + }, + { + "regionTag": "alloydb_v1_generated_AlloyDBAdmin_InjectFault_async", + "title": "AlloyDBAdmin injectFault Sample", + "origin": "API_DEFINITION", + "description": " Injects fault in an instance. Imperative only.", + "canonical": true, + "file": "alloy_d_b_admin.inject_fault.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 80, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "InjectFault", + "fullName": "google.cloud.alloydb.v1.AlloyDBAdmin.InjectFault", + "async": true, + "parameters": [ + { + "name": "fault_type", + "type": ".google.cloud.alloydb.v1.InjectFaultRequest.FaultType" + }, + { + "name": "name", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "validate_only", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "AlloyDBAdminClient", + "fullName": "google.cloud.alloydb.v1.AlloyDBAdminClient" + }, + "method": { + "shortName": "InjectFault", + "fullName": "google.cloud.alloydb.v1.AlloyDBAdmin.InjectFault", + "service": { + "shortName": "AlloyDBAdmin", + "fullName": "google.cloud.alloydb.v1.AlloyDBAdmin" + } + } + } + }, + { + "regionTag": "alloydb_v1_generated_AlloyDBAdmin_RestartInstance_async", + "title": "AlloyDBAdmin restartInstance Sample", + "origin": "API_DEFINITION", + "description": " Restart an Instance in a cluster. Imperative only.", + "canonical": true, + "file": "alloy_d_b_admin.restart_instance.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 74, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "RestartInstance", + "fullName": "google.cloud.alloydb.v1.AlloyDBAdmin.RestartInstance", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "validate_only", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "AlloyDBAdminClient", + "fullName": "google.cloud.alloydb.v1.AlloyDBAdminClient" + }, + "method": { + "shortName": "RestartInstance", + "fullName": "google.cloud.alloydb.v1.AlloyDBAdmin.RestartInstance", + "service": { + "shortName": "AlloyDBAdmin", + "fullName": "google.cloud.alloydb.v1.AlloyDBAdmin" + } + } + } + }, + { + "regionTag": "alloydb_v1_generated_AlloyDBAdmin_ListBackups_async", + "title": "AlloyDBAdmin listBackups Sample", + "origin": "API_DEFINITION", + "description": " Lists Backups in a given project and location.", + "canonical": true, + "file": "alloy_d_b_admin.list_backups.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 72, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListBackups", + "fullName": "google.cloud.alloydb.v1.AlloyDBAdmin.ListBackups", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.alloydb.v1.ListBackupsResponse", + "client": { + "shortName": "AlloyDBAdminClient", + "fullName": "google.cloud.alloydb.v1.AlloyDBAdminClient" + }, + "method": { + "shortName": "ListBackups", + "fullName": "google.cloud.alloydb.v1.AlloyDBAdmin.ListBackups", + "service": { + "shortName": "AlloyDBAdmin", + "fullName": "google.cloud.alloydb.v1.AlloyDBAdmin" + } + } + } + }, + { + "regionTag": "alloydb_v1_generated_AlloyDBAdmin_GetBackup_async", + "title": "AlloyDBAdmin getBackup Sample", + "origin": "API_DEFINITION", + "description": " Gets details of a single Backup.", + "canonical": true, + "file": "alloy_d_b_admin.get_backup.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 53, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetBackup", + "fullName": "google.cloud.alloydb.v1.AlloyDBAdmin.GetBackup", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.alloydb.v1.Backup", + "client": { + "shortName": "AlloyDBAdminClient", + "fullName": "google.cloud.alloydb.v1.AlloyDBAdminClient" + }, + "method": { + "shortName": "GetBackup", + "fullName": "google.cloud.alloydb.v1.AlloyDBAdmin.GetBackup", + "service": { + "shortName": "AlloyDBAdmin", + "fullName": "google.cloud.alloydb.v1.AlloyDBAdmin" + } + } + } + }, + { + "regionTag": "alloydb_v1_generated_AlloyDBAdmin_CreateBackup_async", + "title": "AlloyDBAdmin createBackup Sample", + "origin": "API_DEFINITION", + "description": " Creates a new Backup in a given project and location.", + "canonical": true, + "file": "alloy_d_b_admin.create_backup.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 83, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CreateBackup", + "fullName": "google.cloud.alloydb.v1.AlloyDBAdmin.CreateBackup", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "backup_id", + "type": "TYPE_STRING" + }, + { + "name": "backup", + "type": ".google.cloud.alloydb.v1.Backup" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "validate_only", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "AlloyDBAdminClient", + "fullName": "google.cloud.alloydb.v1.AlloyDBAdminClient" + }, + "method": { + "shortName": "CreateBackup", + "fullName": "google.cloud.alloydb.v1.AlloyDBAdmin.CreateBackup", + "service": { + "shortName": "AlloyDBAdmin", + "fullName": "google.cloud.alloydb.v1.AlloyDBAdmin" + } + } + } + }, + { + "regionTag": "alloydb_v1_generated_AlloyDBAdmin_UpdateBackup_async", + "title": "AlloyDBAdmin updateBackup Sample", + "origin": "API_DEFINITION", + "description": " Updates the parameters of a single Backup.", + "canonical": true, + "file": "alloy_d_b_admin.update_backup.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 86, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "UpdateBackup", + "fullName": "google.cloud.alloydb.v1.AlloyDBAdmin.UpdateBackup", + "async": true, + "parameters": [ + { + "name": "update_mask", + "type": ".google.protobuf.FieldMask" + }, + { + "name": "backup", + "type": ".google.cloud.alloydb.v1.Backup" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "validate_only", + "type": "TYPE_BOOL" + }, + { + "name": "allow_missing", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "AlloyDBAdminClient", + "fullName": "google.cloud.alloydb.v1.AlloyDBAdminClient" + }, + "method": { + "shortName": "UpdateBackup", + "fullName": "google.cloud.alloydb.v1.AlloyDBAdmin.UpdateBackup", + "service": { + "shortName": "AlloyDBAdmin", + "fullName": "google.cloud.alloydb.v1.AlloyDBAdmin" + } + } + } + }, + { + "regionTag": "alloydb_v1_generated_AlloyDBAdmin_DeleteBackup_async", + "title": "AlloyDBAdmin deleteBackup Sample", + "origin": "API_DEFINITION", + "description": " Deletes a single Backup.", + "canonical": true, + "file": "alloy_d_b_admin.delete_backup.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 80, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeleteBackup", + "fullName": "google.cloud.alloydb.v1.AlloyDBAdmin.DeleteBackup", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "validate_only", + "type": "TYPE_BOOL" + }, + { + "name": "etag", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "AlloyDBAdminClient", + "fullName": "google.cloud.alloydb.v1.AlloyDBAdminClient" + }, + "method": { + "shortName": "DeleteBackup", + "fullName": "google.cloud.alloydb.v1.AlloyDBAdmin.DeleteBackup", + "service": { + "shortName": "AlloyDBAdmin", + "fullName": "google.cloud.alloydb.v1.AlloyDBAdmin" + } + } + } + }, + { + "regionTag": "alloydb_v1_generated_AlloyDBAdmin_ListSupportedDatabaseFlags_async", + "title": "AlloyDBAdmin listSupportedDatabaseFlags Sample", + "origin": "API_DEFINITION", + "description": " Lists SupportedDatabaseFlags for a given project and location.", + "canonical": true, + "file": "alloy_d_b_admin.list_supported_database_flags.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 69, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListSupportedDatabaseFlags", + "fullName": "google.cloud.alloydb.v1.AlloyDBAdmin.ListSupportedDatabaseFlags", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.alloydb.v1.ListSupportedDatabaseFlagsResponse", + "client": { + "shortName": "AlloyDBAdminClient", + "fullName": "google.cloud.alloydb.v1.AlloyDBAdminClient" + }, + "method": { + "shortName": "ListSupportedDatabaseFlags", + "fullName": "google.cloud.alloydb.v1.AlloyDBAdmin.ListSupportedDatabaseFlags", + "service": { + "shortName": "AlloyDBAdmin", + "fullName": "google.cloud.alloydb.v1.AlloyDBAdmin" + } + } + } + }, + { + "regionTag": "alloydb_v1_generated_AlloyDBAdmin_ListUsers_async", + "title": "AlloyDBAdmin listUsers Sample", + "origin": "API_DEFINITION", + "description": " Lists Users in a given project and location.", + "canonical": true, + "file": "alloy_d_b_admin.list_users.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 72, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListUsers", + "fullName": "google.cloud.alloydb.v1.AlloyDBAdmin.ListUsers", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.alloydb.v1.ListUsersResponse", + "client": { + "shortName": "AlloyDBAdminClient", + "fullName": "google.cloud.alloydb.v1.AlloyDBAdminClient" + }, + "method": { + "shortName": "ListUsers", + "fullName": "google.cloud.alloydb.v1.AlloyDBAdmin.ListUsers", + "service": { + "shortName": "AlloyDBAdmin", + "fullName": "google.cloud.alloydb.v1.AlloyDBAdmin" + } + } + } + }, + { + "regionTag": "alloydb_v1_generated_AlloyDBAdmin_GetUser_async", + "title": "AlloyDBAdmin getUser Sample", + "origin": "API_DEFINITION", + "description": " Gets details of a single User.", + "canonical": true, + "file": "alloy_d_b_admin.get_user.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 54, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetUser", + "fullName": "google.cloud.alloydb.v1.AlloyDBAdmin.GetUser", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.alloydb.v1.User", + "client": { + "shortName": "AlloyDBAdminClient", + "fullName": "google.cloud.alloydb.v1.AlloyDBAdminClient" + }, + "method": { + "shortName": "GetUser", + "fullName": "google.cloud.alloydb.v1.AlloyDBAdmin.GetUser", + "service": { + "shortName": "AlloyDBAdmin", + "fullName": "google.cloud.alloydb.v1.AlloyDBAdmin" + } + } + } + }, + { + "regionTag": "alloydb_v1_generated_AlloyDBAdmin_CreateUser_async", + "title": "AlloyDBAdmin createUser Sample", + "origin": "API_DEFINITION", + "description": " Creates a new User in a given project, location, and cluster.", + "canonical": true, + "file": "alloy_d_b_admin.create_user.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 82, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CreateUser", + "fullName": "google.cloud.alloydb.v1.AlloyDBAdmin.CreateUser", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "user_id", + "type": "TYPE_STRING" + }, + { + "name": "user", + "type": ".google.cloud.alloydb.v1.User" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "validate_only", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.cloud.alloydb.v1.User", + "client": { + "shortName": "AlloyDBAdminClient", + "fullName": "google.cloud.alloydb.v1.AlloyDBAdminClient" + }, + "method": { + "shortName": "CreateUser", + "fullName": "google.cloud.alloydb.v1.AlloyDBAdmin.CreateUser", + "service": { + "shortName": "AlloyDBAdmin", + "fullName": "google.cloud.alloydb.v1.AlloyDBAdmin" + } + } + } + }, + { + "regionTag": "alloydb_v1_generated_AlloyDBAdmin_UpdateUser_async", + "title": "AlloyDBAdmin updateUser Sample", + "origin": "API_DEFINITION", + "description": " Updates the parameters of a single User.", + "canonical": true, + "file": "alloy_d_b_admin.update_user.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 84, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "UpdateUser", + "fullName": "google.cloud.alloydb.v1.AlloyDBAdmin.UpdateUser", + "async": true, + "parameters": [ + { + "name": "update_mask", + "type": ".google.protobuf.FieldMask" + }, + { + "name": "user", + "type": ".google.cloud.alloydb.v1.User" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "validate_only", + "type": "TYPE_BOOL" + }, + { + "name": "allow_missing", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.cloud.alloydb.v1.User", + "client": { + "shortName": "AlloyDBAdminClient", + "fullName": "google.cloud.alloydb.v1.AlloyDBAdminClient" + }, + "method": { + "shortName": "UpdateUser", + "fullName": "google.cloud.alloydb.v1.AlloyDBAdmin.UpdateUser", + "service": { + "shortName": "AlloyDBAdmin", + "fullName": "google.cloud.alloydb.v1.AlloyDBAdmin" + } + } + } + }, + { + "regionTag": "alloydb_v1_generated_AlloyDBAdmin_DeleteUser_async", + "title": "AlloyDBAdmin deleteUser Sample", + "origin": "API_DEFINITION", + "description": " Deletes a single User.", + "canonical": true, + "file": "alloy_d_b_admin.delete_user.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 73, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeleteUser", + "fullName": "google.cloud.alloydb.v1.AlloyDBAdmin.DeleteUser", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "validate_only", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.protobuf.Empty", + "client": { + "shortName": "AlloyDBAdminClient", + "fullName": "google.cloud.alloydb.v1.AlloyDBAdminClient" + }, + "method": { + "shortName": "DeleteUser", + "fullName": "google.cloud.alloydb.v1.AlloyDBAdmin.DeleteUser", + "service": { + "shortName": "AlloyDBAdmin", + "fullName": "google.cloud.alloydb.v1.AlloyDBAdmin" + } + } + } + } + ] +} \ No newline at end of file diff --git a/packages/google-cloud-alloydb/samples/generated/v1alpha/snippet_metadata_google.cloud.alloydb.v1alpha.json b/packages/google-cloud-alloydb/samples/generated/v1alpha/snippet_metadata_google.cloud.alloydb.v1alpha.json new file mode 100644 index 00000000000..dd76a0a0461 --- /dev/null +++ b/packages/google-cloud-alloydb/samples/generated/v1alpha/snippet_metadata_google.cloud.alloydb.v1alpha.json @@ -0,0 +1,1639 @@ +{ + "clientLibrary": { + "name": "nodejs-alloydb", + "version": "0.3.0", + "language": "TYPESCRIPT", + "apis": [ + { + "id": "google.cloud.alloydb.v1alpha", + "version": "v1alpha" + } + ] + }, + "snippets": [ + { + "regionTag": "alloydb_v1alpha_generated_AlloyDBAdmin_ListClusters_async", + "title": "AlloyDBAdmin listClusters Sample", + "origin": "API_DEFINITION", + "description": " Lists Clusters in a given project and location.", + "canonical": true, + "file": "alloy_d_b_admin.list_clusters.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 75, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListClusters", + "fullName": "google.cloud.alloydb.v1alpha.AlloyDBAdmin.ListClusters", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.alloydb.v1alpha.ListClustersResponse", + "client": { + "shortName": "AlloyDBAdminClient", + "fullName": "google.cloud.alloydb.v1alpha.AlloyDBAdminClient" + }, + "method": { + "shortName": "ListClusters", + "fullName": "google.cloud.alloydb.v1alpha.AlloyDBAdmin.ListClusters", + "service": { + "shortName": "AlloyDBAdmin", + "fullName": "google.cloud.alloydb.v1alpha.AlloyDBAdmin" + } + } + } + }, + { + "regionTag": "alloydb_v1alpha_generated_AlloyDBAdmin_GetCluster_async", + "title": "AlloyDBAdmin getCluster Sample", + "origin": "API_DEFINITION", + "description": " Gets details of a single Cluster.", + "canonical": true, + "file": "alloy_d_b_admin.get_cluster.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 59, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetCluster", + "fullName": "google.cloud.alloydb.v1alpha.AlloyDBAdmin.GetCluster", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + }, + { + "name": "view", + "type": ".google.cloud.alloydb.v1alpha.ClusterView" + } + ], + "resultType": ".google.cloud.alloydb.v1alpha.Cluster", + "client": { + "shortName": "AlloyDBAdminClient", + "fullName": "google.cloud.alloydb.v1alpha.AlloyDBAdminClient" + }, + "method": { + "shortName": "GetCluster", + "fullName": "google.cloud.alloydb.v1alpha.AlloyDBAdmin.GetCluster", + "service": { + "shortName": "AlloyDBAdmin", + "fullName": "google.cloud.alloydb.v1alpha.AlloyDBAdmin" + } + } + } + }, + { + "regionTag": "alloydb_v1alpha_generated_AlloyDBAdmin_CreateCluster_async", + "title": "AlloyDBAdmin createCluster Sample", + "origin": "API_DEFINITION", + "description": " Creates a new Cluster in a given project and location.", + "canonical": true, + "file": "alloy_d_b_admin.create_cluster.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 85, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CreateCluster", + "fullName": "google.cloud.alloydb.v1alpha.AlloyDBAdmin.CreateCluster", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "cluster_id", + "type": "TYPE_STRING" + }, + { + "name": "cluster", + "type": ".google.cloud.alloydb.v1alpha.Cluster" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "validate_only", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "AlloyDBAdminClient", + "fullName": "google.cloud.alloydb.v1alpha.AlloyDBAdminClient" + }, + "method": { + "shortName": "CreateCluster", + "fullName": "google.cloud.alloydb.v1alpha.AlloyDBAdmin.CreateCluster", + "service": { + "shortName": "AlloyDBAdmin", + "fullName": "google.cloud.alloydb.v1alpha.AlloyDBAdmin" + } + } + } + }, + { + "regionTag": "alloydb_v1alpha_generated_AlloyDBAdmin_UpdateCluster_async", + "title": "AlloyDBAdmin updateCluster Sample", + "origin": "API_DEFINITION", + "description": " Updates the parameters of a single Cluster.", + "canonical": true, + "file": "alloy_d_b_admin.update_cluster.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 87, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "UpdateCluster", + "fullName": "google.cloud.alloydb.v1alpha.AlloyDBAdmin.UpdateCluster", + "async": true, + "parameters": [ + { + "name": "update_mask", + "type": ".google.protobuf.FieldMask" + }, + { + "name": "cluster", + "type": ".google.cloud.alloydb.v1alpha.Cluster" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "validate_only", + "type": "TYPE_BOOL" + }, + { + "name": "allow_missing", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "AlloyDBAdminClient", + "fullName": "google.cloud.alloydb.v1alpha.AlloyDBAdminClient" + }, + "method": { + "shortName": "UpdateCluster", + "fullName": "google.cloud.alloydb.v1alpha.AlloyDBAdmin.UpdateCluster", + "service": { + "shortName": "AlloyDBAdmin", + "fullName": "google.cloud.alloydb.v1alpha.AlloyDBAdmin" + } + } + } + }, + { + "regionTag": "alloydb_v1alpha_generated_AlloyDBAdmin_DeleteCluster_async", + "title": "AlloyDBAdmin deleteCluster Sample", + "origin": "API_DEFINITION", + "description": " Deletes a single Cluster.", + "canonical": true, + "file": "alloy_d_b_admin.delete_cluster.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 84, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeleteCluster", + "fullName": "google.cloud.alloydb.v1alpha.AlloyDBAdmin.DeleteCluster", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "etag", + "type": "TYPE_STRING" + }, + { + "name": "validate_only", + "type": "TYPE_BOOL" + }, + { + "name": "force", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "AlloyDBAdminClient", + "fullName": "google.cloud.alloydb.v1alpha.AlloyDBAdminClient" + }, + "method": { + "shortName": "DeleteCluster", + "fullName": "google.cloud.alloydb.v1alpha.AlloyDBAdmin.DeleteCluster", + "service": { + "shortName": "AlloyDBAdmin", + "fullName": "google.cloud.alloydb.v1alpha.AlloyDBAdmin" + } + } + } + }, + { + "regionTag": "alloydb_v1alpha_generated_AlloyDBAdmin_PromoteCluster_async", + "title": "AlloyDBAdmin promoteCluster Sample", + "origin": "API_DEFINITION", + "description": " Promotes a SECONDARY cluster. This turns down replication from the PRIMARY cluster and promotes a secondary cluster into its own standalone cluster. Imperative only.", + "canonical": true, + "file": "alloy_d_b_admin.promote_cluster.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 80, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "PromoteCluster", + "fullName": "google.cloud.alloydb.v1alpha.AlloyDBAdmin.PromoteCluster", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "etag", + "type": "TYPE_STRING" + }, + { + "name": "validate_only", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "AlloyDBAdminClient", + "fullName": "google.cloud.alloydb.v1alpha.AlloyDBAdminClient" + }, + "method": { + "shortName": "PromoteCluster", + "fullName": "google.cloud.alloydb.v1alpha.AlloyDBAdmin.PromoteCluster", + "service": { + "shortName": "AlloyDBAdmin", + "fullName": "google.cloud.alloydb.v1alpha.AlloyDBAdmin" + } + } + } + }, + { + "regionTag": "alloydb_v1alpha_generated_AlloyDBAdmin_RestoreCluster_async", + "title": "AlloyDBAdmin restoreCluster Sample", + "origin": "API_DEFINITION", + "description": " Creates a new Cluster in a given project and location, with a volume restored from the provided source, either a backup ID or a point-in-time and a source cluster.", + "canonical": true, + "file": "alloy_d_b_admin.restore_cluster.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 94, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "RestoreCluster", + "fullName": "google.cloud.alloydb.v1alpha.AlloyDBAdmin.RestoreCluster", + "async": true, + "parameters": [ + { + "name": "backup_source", + "type": ".google.cloud.alloydb.v1alpha.BackupSource" + }, + { + "name": "continuous_backup_source", + "type": ".google.cloud.alloydb.v1alpha.ContinuousBackupSource" + }, + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "cluster_id", + "type": "TYPE_STRING" + }, + { + "name": "cluster", + "type": ".google.cloud.alloydb.v1alpha.Cluster" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "validate_only", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "AlloyDBAdminClient", + "fullName": "google.cloud.alloydb.v1alpha.AlloyDBAdminClient" + }, + "method": { + "shortName": "RestoreCluster", + "fullName": "google.cloud.alloydb.v1alpha.AlloyDBAdmin.RestoreCluster", + "service": { + "shortName": "AlloyDBAdmin", + "fullName": "google.cloud.alloydb.v1alpha.AlloyDBAdmin" + } + } + } + }, + { + "regionTag": "alloydb_v1alpha_generated_AlloyDBAdmin_CreateSecondaryCluster_async", + "title": "AlloyDBAdmin createSecondaryCluster Sample", + "origin": "API_DEFINITION", + "description": " Creates a cluster of type SECONDARY in the given location using the primary cluster as the source.", + "canonical": true, + "file": "alloy_d_b_admin.create_secondary_cluster.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 85, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CreateSecondaryCluster", + "fullName": "google.cloud.alloydb.v1alpha.AlloyDBAdmin.CreateSecondaryCluster", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "cluster_id", + "type": "TYPE_STRING" + }, + { + "name": "cluster", + "type": ".google.cloud.alloydb.v1alpha.Cluster" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "validate_only", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "AlloyDBAdminClient", + "fullName": "google.cloud.alloydb.v1alpha.AlloyDBAdminClient" + }, + "method": { + "shortName": "CreateSecondaryCluster", + "fullName": "google.cloud.alloydb.v1alpha.AlloyDBAdmin.CreateSecondaryCluster", + "service": { + "shortName": "AlloyDBAdmin", + "fullName": "google.cloud.alloydb.v1alpha.AlloyDBAdmin" + } + } + } + }, + { + "regionTag": "alloydb_v1alpha_generated_AlloyDBAdmin_ListInstances_async", + "title": "AlloyDBAdmin listInstances Sample", + "origin": "API_DEFINITION", + "description": " Lists Instances in a given project and location.", + "canonical": true, + "file": "alloy_d_b_admin.list_instances.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 77, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListInstances", + "fullName": "google.cloud.alloydb.v1alpha.AlloyDBAdmin.ListInstances", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.alloydb.v1alpha.ListInstancesResponse", + "client": { + "shortName": "AlloyDBAdminClient", + "fullName": "google.cloud.alloydb.v1alpha.AlloyDBAdminClient" + }, + "method": { + "shortName": "ListInstances", + "fullName": "google.cloud.alloydb.v1alpha.AlloyDBAdmin.ListInstances", + "service": { + "shortName": "AlloyDBAdmin", + "fullName": "google.cloud.alloydb.v1alpha.AlloyDBAdmin" + } + } + } + }, + { + "regionTag": "alloydb_v1alpha_generated_AlloyDBAdmin_GetInstance_async", + "title": "AlloyDBAdmin getInstance Sample", + "origin": "API_DEFINITION", + "description": " Gets details of a single Instance.", + "canonical": true, + "file": "alloy_d_b_admin.get_instance.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 58, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetInstance", + "fullName": "google.cloud.alloydb.v1alpha.AlloyDBAdmin.GetInstance", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + }, + { + "name": "view", + "type": ".google.cloud.alloydb.v1alpha.InstanceView" + } + ], + "resultType": ".google.cloud.alloydb.v1alpha.Instance", + "client": { + "shortName": "AlloyDBAdminClient", + "fullName": "google.cloud.alloydb.v1alpha.AlloyDBAdminClient" + }, + "method": { + "shortName": "GetInstance", + "fullName": "google.cloud.alloydb.v1alpha.AlloyDBAdmin.GetInstance", + "service": { + "shortName": "AlloyDBAdmin", + "fullName": "google.cloud.alloydb.v1alpha.AlloyDBAdmin" + } + } + } + }, + { + "regionTag": "alloydb_v1alpha_generated_AlloyDBAdmin_CreateInstance_async", + "title": "AlloyDBAdmin createInstance Sample", + "origin": "API_DEFINITION", + "description": " Creates a new Instance in a given project and location.", + "canonical": true, + "file": "alloy_d_b_admin.create_instance.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 85, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CreateInstance", + "fullName": "google.cloud.alloydb.v1alpha.AlloyDBAdmin.CreateInstance", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "instance_id", + "type": "TYPE_STRING" + }, + { + "name": "instance", + "type": ".google.cloud.alloydb.v1alpha.Instance" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "validate_only", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "AlloyDBAdminClient", + "fullName": "google.cloud.alloydb.v1alpha.AlloyDBAdminClient" + }, + "method": { + "shortName": "CreateInstance", + "fullName": "google.cloud.alloydb.v1alpha.AlloyDBAdmin.CreateInstance", + "service": { + "shortName": "AlloyDBAdmin", + "fullName": "google.cloud.alloydb.v1alpha.AlloyDBAdmin" + } + } + } + }, + { + "regionTag": "alloydb_v1alpha_generated_AlloyDBAdmin_CreateSecondaryInstance_async", + "title": "AlloyDBAdmin createSecondaryInstance Sample", + "origin": "API_DEFINITION", + "description": " Creates a new SECONDARY Instance in a given project and location.", + "canonical": true, + "file": "alloy_d_b_admin.create_secondary_instance.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 85, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CreateSecondaryInstance", + "fullName": "google.cloud.alloydb.v1alpha.AlloyDBAdmin.CreateSecondaryInstance", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "instance_id", + "type": "TYPE_STRING" + }, + { + "name": "instance", + "type": ".google.cloud.alloydb.v1alpha.Instance" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "validate_only", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "AlloyDBAdminClient", + "fullName": "google.cloud.alloydb.v1alpha.AlloyDBAdminClient" + }, + "method": { + "shortName": "CreateSecondaryInstance", + "fullName": "google.cloud.alloydb.v1alpha.AlloyDBAdmin.CreateSecondaryInstance", + "service": { + "shortName": "AlloyDBAdmin", + "fullName": "google.cloud.alloydb.v1alpha.AlloyDBAdmin" + } + } + } + }, + { + "regionTag": "alloydb_v1alpha_generated_AlloyDBAdmin_BatchCreateInstances_async", + "title": "AlloyDBAdmin batchCreateInstances Sample", + "origin": "API_DEFINITION", + "description": " Creates new instances under the given project, location and cluster. There can be only one primary instance in a cluster. If the primary instance exists in the cluster as well as this request, then API will throw an error. The primary instance should exist before any read pool instance is created. If the primary instance is a part of the request payload, then the API will take care of creating instances in the correct order. This method is here to support Google-internal use cases, and is not meant for external customers to consume. Please do not start relying on it; its behavior is subject to change without notice.", + "canonical": true, + "file": "alloy_d_b_admin.batch_create_instances.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 73, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "BatchCreateInstances", + "fullName": "google.cloud.alloydb.v1alpha.AlloyDBAdmin.BatchCreateInstances", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "requests", + "type": ".google.cloud.alloydb.v1alpha.CreateInstanceRequests" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "AlloyDBAdminClient", + "fullName": "google.cloud.alloydb.v1alpha.AlloyDBAdminClient" + }, + "method": { + "shortName": "BatchCreateInstances", + "fullName": "google.cloud.alloydb.v1alpha.AlloyDBAdmin.BatchCreateInstances", + "service": { + "shortName": "AlloyDBAdmin", + "fullName": "google.cloud.alloydb.v1alpha.AlloyDBAdmin" + } + } + } + }, + { + "regionTag": "alloydb_v1alpha_generated_AlloyDBAdmin_UpdateInstance_async", + "title": "AlloyDBAdmin updateInstance Sample", + "origin": "API_DEFINITION", + "description": " Updates the parameters of a single Instance.", + "canonical": true, + "file": "alloy_d_b_admin.update_instance.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 87, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "UpdateInstance", + "fullName": "google.cloud.alloydb.v1alpha.AlloyDBAdmin.UpdateInstance", + "async": true, + "parameters": [ + { + "name": "update_mask", + "type": ".google.protobuf.FieldMask" + }, + { + "name": "instance", + "type": ".google.cloud.alloydb.v1alpha.Instance" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "validate_only", + "type": "TYPE_BOOL" + }, + { + "name": "allow_missing", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "AlloyDBAdminClient", + "fullName": "google.cloud.alloydb.v1alpha.AlloyDBAdminClient" + }, + "method": { + "shortName": "UpdateInstance", + "fullName": "google.cloud.alloydb.v1alpha.AlloyDBAdmin.UpdateInstance", + "service": { + "shortName": "AlloyDBAdmin", + "fullName": "google.cloud.alloydb.v1alpha.AlloyDBAdmin" + } + } + } + }, + { + "regionTag": "alloydb_v1alpha_generated_AlloyDBAdmin_DeleteInstance_async", + "title": "AlloyDBAdmin deleteInstance Sample", + "origin": "API_DEFINITION", + "description": " Deletes a single Instance.", + "canonical": true, + "file": "alloy_d_b_admin.delete_instance.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 80, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeleteInstance", + "fullName": "google.cloud.alloydb.v1alpha.AlloyDBAdmin.DeleteInstance", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "etag", + "type": "TYPE_STRING" + }, + { + "name": "validate_only", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "AlloyDBAdminClient", + "fullName": "google.cloud.alloydb.v1alpha.AlloyDBAdminClient" + }, + "method": { + "shortName": "DeleteInstance", + "fullName": "google.cloud.alloydb.v1alpha.AlloyDBAdmin.DeleteInstance", + "service": { + "shortName": "AlloyDBAdmin", + "fullName": "google.cloud.alloydb.v1alpha.AlloyDBAdmin" + } + } + } + }, + { + "regionTag": "alloydb_v1alpha_generated_AlloyDBAdmin_FailoverInstance_async", + "title": "AlloyDBAdmin failoverInstance Sample", + "origin": "API_DEFINITION", + "description": " Forces a Failover for a highly available instance. Failover promotes the HA standby instance as the new primary. Imperative only.", + "canonical": true, + "file": "alloy_d_b_admin.failover_instance.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 74, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "FailoverInstance", + "fullName": "google.cloud.alloydb.v1alpha.AlloyDBAdmin.FailoverInstance", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "validate_only", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "AlloyDBAdminClient", + "fullName": "google.cloud.alloydb.v1alpha.AlloyDBAdminClient" + }, + "method": { + "shortName": "FailoverInstance", + "fullName": "google.cloud.alloydb.v1alpha.AlloyDBAdmin.FailoverInstance", + "service": { + "shortName": "AlloyDBAdmin", + "fullName": "google.cloud.alloydb.v1alpha.AlloyDBAdmin" + } + } + } + }, + { + "regionTag": "alloydb_v1alpha_generated_AlloyDBAdmin_InjectFault_async", + "title": "AlloyDBAdmin injectFault Sample", + "origin": "API_DEFINITION", + "description": " Injects fault in an instance. Imperative only.", + "canonical": true, + "file": "alloy_d_b_admin.inject_fault.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 80, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "InjectFault", + "fullName": "google.cloud.alloydb.v1alpha.AlloyDBAdmin.InjectFault", + "async": true, + "parameters": [ + { + "name": "fault_type", + "type": ".google.cloud.alloydb.v1alpha.InjectFaultRequest.FaultType" + }, + { + "name": "name", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "validate_only", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "AlloyDBAdminClient", + "fullName": "google.cloud.alloydb.v1alpha.AlloyDBAdminClient" + }, + "method": { + "shortName": "InjectFault", + "fullName": "google.cloud.alloydb.v1alpha.AlloyDBAdmin.InjectFault", + "service": { + "shortName": "AlloyDBAdmin", + "fullName": "google.cloud.alloydb.v1alpha.AlloyDBAdmin" + } + } + } + }, + { + "regionTag": "alloydb_v1alpha_generated_AlloyDBAdmin_RestartInstance_async", + "title": "AlloyDBAdmin restartInstance Sample", + "origin": "API_DEFINITION", + "description": " Restart an Instance in a cluster. Imperative only.", + "canonical": true, + "file": "alloy_d_b_admin.restart_instance.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 74, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "RestartInstance", + "fullName": "google.cloud.alloydb.v1alpha.AlloyDBAdmin.RestartInstance", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "validate_only", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "AlloyDBAdminClient", + "fullName": "google.cloud.alloydb.v1alpha.AlloyDBAdminClient" + }, + "method": { + "shortName": "RestartInstance", + "fullName": "google.cloud.alloydb.v1alpha.AlloyDBAdmin.RestartInstance", + "service": { + "shortName": "AlloyDBAdmin", + "fullName": "google.cloud.alloydb.v1alpha.AlloyDBAdmin" + } + } + } + }, + { + "regionTag": "alloydb_v1alpha_generated_AlloyDBAdmin_ListBackups_async", + "title": "AlloyDBAdmin listBackups Sample", + "origin": "API_DEFINITION", + "description": " Lists Backups in a given project and location.", + "canonical": true, + "file": "alloy_d_b_admin.list_backups.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 72, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListBackups", + "fullName": "google.cloud.alloydb.v1alpha.AlloyDBAdmin.ListBackups", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.alloydb.v1alpha.ListBackupsResponse", + "client": { + "shortName": "AlloyDBAdminClient", + "fullName": "google.cloud.alloydb.v1alpha.AlloyDBAdminClient" + }, + "method": { + "shortName": "ListBackups", + "fullName": "google.cloud.alloydb.v1alpha.AlloyDBAdmin.ListBackups", + "service": { + "shortName": "AlloyDBAdmin", + "fullName": "google.cloud.alloydb.v1alpha.AlloyDBAdmin" + } + } + } + }, + { + "regionTag": "alloydb_v1alpha_generated_AlloyDBAdmin_GetBackup_async", + "title": "AlloyDBAdmin getBackup Sample", + "origin": "API_DEFINITION", + "description": " Gets details of a single Backup.", + "canonical": true, + "file": "alloy_d_b_admin.get_backup.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 53, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetBackup", + "fullName": "google.cloud.alloydb.v1alpha.AlloyDBAdmin.GetBackup", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.alloydb.v1alpha.Backup", + "client": { + "shortName": "AlloyDBAdminClient", + "fullName": "google.cloud.alloydb.v1alpha.AlloyDBAdminClient" + }, + "method": { + "shortName": "GetBackup", + "fullName": "google.cloud.alloydb.v1alpha.AlloyDBAdmin.GetBackup", + "service": { + "shortName": "AlloyDBAdmin", + "fullName": "google.cloud.alloydb.v1alpha.AlloyDBAdmin" + } + } + } + }, + { + "regionTag": "alloydb_v1alpha_generated_AlloyDBAdmin_CreateBackup_async", + "title": "AlloyDBAdmin createBackup Sample", + "origin": "API_DEFINITION", + "description": " Creates a new Backup in a given project and location.", + "canonical": true, + "file": "alloy_d_b_admin.create_backup.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 83, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CreateBackup", + "fullName": "google.cloud.alloydb.v1alpha.AlloyDBAdmin.CreateBackup", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "backup_id", + "type": "TYPE_STRING" + }, + { + "name": "backup", + "type": ".google.cloud.alloydb.v1alpha.Backup" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "validate_only", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "AlloyDBAdminClient", + "fullName": "google.cloud.alloydb.v1alpha.AlloyDBAdminClient" + }, + "method": { + "shortName": "CreateBackup", + "fullName": "google.cloud.alloydb.v1alpha.AlloyDBAdmin.CreateBackup", + "service": { + "shortName": "AlloyDBAdmin", + "fullName": "google.cloud.alloydb.v1alpha.AlloyDBAdmin" + } + } + } + }, + { + "regionTag": "alloydb_v1alpha_generated_AlloyDBAdmin_UpdateBackup_async", + "title": "AlloyDBAdmin updateBackup Sample", + "origin": "API_DEFINITION", + "description": " Updates the parameters of a single Backup.", + "canonical": true, + "file": "alloy_d_b_admin.update_backup.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 86, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "UpdateBackup", + "fullName": "google.cloud.alloydb.v1alpha.AlloyDBAdmin.UpdateBackup", + "async": true, + "parameters": [ + { + "name": "update_mask", + "type": ".google.protobuf.FieldMask" + }, + { + "name": "backup", + "type": ".google.cloud.alloydb.v1alpha.Backup" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "validate_only", + "type": "TYPE_BOOL" + }, + { + "name": "allow_missing", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "AlloyDBAdminClient", + "fullName": "google.cloud.alloydb.v1alpha.AlloyDBAdminClient" + }, + "method": { + "shortName": "UpdateBackup", + "fullName": "google.cloud.alloydb.v1alpha.AlloyDBAdmin.UpdateBackup", + "service": { + "shortName": "AlloyDBAdmin", + "fullName": "google.cloud.alloydb.v1alpha.AlloyDBAdmin" + } + } + } + }, + { + "regionTag": "alloydb_v1alpha_generated_AlloyDBAdmin_DeleteBackup_async", + "title": "AlloyDBAdmin deleteBackup Sample", + "origin": "API_DEFINITION", + "description": " Deletes a single Backup.", + "canonical": true, + "file": "alloy_d_b_admin.delete_backup.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 80, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeleteBackup", + "fullName": "google.cloud.alloydb.v1alpha.AlloyDBAdmin.DeleteBackup", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "validate_only", + "type": "TYPE_BOOL" + }, + { + "name": "etag", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "AlloyDBAdminClient", + "fullName": "google.cloud.alloydb.v1alpha.AlloyDBAdminClient" + }, + "method": { + "shortName": "DeleteBackup", + "fullName": "google.cloud.alloydb.v1alpha.AlloyDBAdmin.DeleteBackup", + "service": { + "shortName": "AlloyDBAdmin", + "fullName": "google.cloud.alloydb.v1alpha.AlloyDBAdmin" + } + } + } + }, + { + "regionTag": "alloydb_v1alpha_generated_AlloyDBAdmin_ListSupportedDatabaseFlags_async", + "title": "AlloyDBAdmin listSupportedDatabaseFlags Sample", + "origin": "API_DEFINITION", + "description": " Lists SupportedDatabaseFlags for a given project and location.", + "canonical": true, + "file": "alloy_d_b_admin.list_supported_database_flags.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 69, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListSupportedDatabaseFlags", + "fullName": "google.cloud.alloydb.v1alpha.AlloyDBAdmin.ListSupportedDatabaseFlags", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.alloydb.v1alpha.ListSupportedDatabaseFlagsResponse", + "client": { + "shortName": "AlloyDBAdminClient", + "fullName": "google.cloud.alloydb.v1alpha.AlloyDBAdminClient" + }, + "method": { + "shortName": "ListSupportedDatabaseFlags", + "fullName": "google.cloud.alloydb.v1alpha.AlloyDBAdmin.ListSupportedDatabaseFlags", + "service": { + "shortName": "AlloyDBAdmin", + "fullName": "google.cloud.alloydb.v1alpha.AlloyDBAdmin" + } + } + } + }, + { + "regionTag": "alloydb_v1alpha_generated_AlloyDBAdmin_GenerateClientCertificate_async", + "title": "AlloyDBAdmin generateClientCertificate Sample", + "origin": "API_DEFINITION", + "description": " Generate a client certificate signed by a Cluster CA. The sole purpose of this endpoint is to support AlloyDB connectors and the Auth Proxy client. The endpoint's behavior is subject to change without notice, so do not rely on its behavior remaining constant. Future changes will not break AlloyDB connectors or the Auth Proxy client.", + "canonical": true, + "file": "alloy_d_b_admin.generate_client_certificate.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 90, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GenerateClientCertificate", + "fullName": "google.cloud.alloydb.v1alpha.AlloyDBAdmin.GenerateClientCertificate", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "pem_csr", + "type": "TYPE_STRING" + }, + { + "name": "cert_duration", + "type": ".google.protobuf.Duration" + }, + { + "name": "public_key", + "type": "TYPE_STRING" + }, + { + "name": "use_metadata_exchange", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.cloud.alloydb.v1alpha.GenerateClientCertificateResponse", + "client": { + "shortName": "AlloyDBAdminClient", + "fullName": "google.cloud.alloydb.v1alpha.AlloyDBAdminClient" + }, + "method": { + "shortName": "GenerateClientCertificate", + "fullName": "google.cloud.alloydb.v1alpha.AlloyDBAdmin.GenerateClientCertificate", + "service": { + "shortName": "AlloyDBAdmin", + "fullName": "google.cloud.alloydb.v1alpha.AlloyDBAdmin" + } + } + } + }, + { + "regionTag": "alloydb_v1alpha_generated_AlloyDBAdmin_GetConnectionInfo_async", + "title": "AlloyDBAdmin getConnectionInfo Sample", + "origin": "API_DEFINITION", + "description": " Get instance metadata used for a connection.", + "canonical": true, + "file": "alloy_d_b_admin.get_connection_info.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 68, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetConnectionInfo", + "fullName": "google.cloud.alloydb.v1alpha.AlloyDBAdmin.GetConnectionInfo", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.alloydb.v1alpha.ConnectionInfo", + "client": { + "shortName": "AlloyDBAdminClient", + "fullName": "google.cloud.alloydb.v1alpha.AlloyDBAdminClient" + }, + "method": { + "shortName": "GetConnectionInfo", + "fullName": "google.cloud.alloydb.v1alpha.AlloyDBAdmin.GetConnectionInfo", + "service": { + "shortName": "AlloyDBAdmin", + "fullName": "google.cloud.alloydb.v1alpha.AlloyDBAdmin" + } + } + } + }, + { + "regionTag": "alloydb_v1alpha_generated_AlloyDBAdmin_ListUsers_async", + "title": "AlloyDBAdmin listUsers Sample", + "origin": "API_DEFINITION", + "description": " Lists Users in a given project and location.", + "canonical": true, + "file": "alloy_d_b_admin.list_users.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 72, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListUsers", + "fullName": "google.cloud.alloydb.v1alpha.AlloyDBAdmin.ListUsers", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.alloydb.v1alpha.ListUsersResponse", + "client": { + "shortName": "AlloyDBAdminClient", + "fullName": "google.cloud.alloydb.v1alpha.AlloyDBAdminClient" + }, + "method": { + "shortName": "ListUsers", + "fullName": "google.cloud.alloydb.v1alpha.AlloyDBAdmin.ListUsers", + "service": { + "shortName": "AlloyDBAdmin", + "fullName": "google.cloud.alloydb.v1alpha.AlloyDBAdmin" + } + } + } + }, + { + "regionTag": "alloydb_v1alpha_generated_AlloyDBAdmin_GetUser_async", + "title": "AlloyDBAdmin getUser Sample", + "origin": "API_DEFINITION", + "description": " Gets details of a single User.", + "canonical": true, + "file": "alloy_d_b_admin.get_user.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 54, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetUser", + "fullName": "google.cloud.alloydb.v1alpha.AlloyDBAdmin.GetUser", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.alloydb.v1alpha.User", + "client": { + "shortName": "AlloyDBAdminClient", + "fullName": "google.cloud.alloydb.v1alpha.AlloyDBAdminClient" + }, + "method": { + "shortName": "GetUser", + "fullName": "google.cloud.alloydb.v1alpha.AlloyDBAdmin.GetUser", + "service": { + "shortName": "AlloyDBAdmin", + "fullName": "google.cloud.alloydb.v1alpha.AlloyDBAdmin" + } + } + } + }, + { + "regionTag": "alloydb_v1alpha_generated_AlloyDBAdmin_CreateUser_async", + "title": "AlloyDBAdmin createUser Sample", + "origin": "API_DEFINITION", + "description": " Creates a new User in a given project, location, and cluster.", + "canonical": true, + "file": "alloy_d_b_admin.create_user.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 82, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CreateUser", + "fullName": "google.cloud.alloydb.v1alpha.AlloyDBAdmin.CreateUser", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "user_id", + "type": "TYPE_STRING" + }, + { + "name": "user", + "type": ".google.cloud.alloydb.v1alpha.User" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "validate_only", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.cloud.alloydb.v1alpha.User", + "client": { + "shortName": "AlloyDBAdminClient", + "fullName": "google.cloud.alloydb.v1alpha.AlloyDBAdminClient" + }, + "method": { + "shortName": "CreateUser", + "fullName": "google.cloud.alloydb.v1alpha.AlloyDBAdmin.CreateUser", + "service": { + "shortName": "AlloyDBAdmin", + "fullName": "google.cloud.alloydb.v1alpha.AlloyDBAdmin" + } + } + } + }, + { + "regionTag": "alloydb_v1alpha_generated_AlloyDBAdmin_UpdateUser_async", + "title": "AlloyDBAdmin updateUser Sample", + "origin": "API_DEFINITION", + "description": " Updates the parameters of a single User.", + "canonical": true, + "file": "alloy_d_b_admin.update_user.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 84, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "UpdateUser", + "fullName": "google.cloud.alloydb.v1alpha.AlloyDBAdmin.UpdateUser", + "async": true, + "parameters": [ + { + "name": "update_mask", + "type": ".google.protobuf.FieldMask" + }, + { + "name": "user", + "type": ".google.cloud.alloydb.v1alpha.User" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "validate_only", + "type": "TYPE_BOOL" + }, + { + "name": "allow_missing", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.cloud.alloydb.v1alpha.User", + "client": { + "shortName": "AlloyDBAdminClient", + "fullName": "google.cloud.alloydb.v1alpha.AlloyDBAdminClient" + }, + "method": { + "shortName": "UpdateUser", + "fullName": "google.cloud.alloydb.v1alpha.AlloyDBAdmin.UpdateUser", + "service": { + "shortName": "AlloyDBAdmin", + "fullName": "google.cloud.alloydb.v1alpha.AlloyDBAdmin" + } + } + } + }, + { + "regionTag": "alloydb_v1alpha_generated_AlloyDBAdmin_DeleteUser_async", + "title": "AlloyDBAdmin deleteUser Sample", + "origin": "API_DEFINITION", + "description": " Deletes a single User.", + "canonical": true, + "file": "alloy_d_b_admin.delete_user.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 73, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeleteUser", + "fullName": "google.cloud.alloydb.v1alpha.AlloyDBAdmin.DeleteUser", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "validate_only", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.protobuf.Empty", + "client": { + "shortName": "AlloyDBAdminClient", + "fullName": "google.cloud.alloydb.v1alpha.AlloyDBAdminClient" + }, + "method": { + "shortName": "DeleteUser", + "fullName": "google.cloud.alloydb.v1alpha.AlloyDBAdmin.DeleteUser", + "service": { + "shortName": "AlloyDBAdmin", + "fullName": "google.cloud.alloydb.v1alpha.AlloyDBAdmin" + } + } + } + } + ] +} \ No newline at end of file diff --git a/packages/google-cloud-alloydb/samples/generated/v1beta/snippet_metadata_google.cloud.alloydb.v1beta.json b/packages/google-cloud-alloydb/samples/generated/v1beta/snippet_metadata_google.cloud.alloydb.v1beta.json new file mode 100644 index 00000000000..b92a0e2e5ef --- /dev/null +++ b/packages/google-cloud-alloydb/samples/generated/v1beta/snippet_metadata_google.cloud.alloydb.v1beta.json @@ -0,0 +1,1635 @@ +{ + "clientLibrary": { + "name": "nodejs-alloydb", + "version": "0.3.0", + "language": "TYPESCRIPT", + "apis": [ + { + "id": "google.cloud.alloydb.v1beta", + "version": "v1beta" + } + ] + }, + "snippets": [ + { + "regionTag": "alloydb_v1beta_generated_AlloyDBAdmin_ListClusters_async", + "title": "AlloyDBAdmin listClusters Sample", + "origin": "API_DEFINITION", + "description": " Lists Clusters in a given project and location.", + "canonical": true, + "file": "alloy_d_b_admin.list_clusters.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 75, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListClusters", + "fullName": "google.cloud.alloydb.v1beta.AlloyDBAdmin.ListClusters", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.alloydb.v1beta.ListClustersResponse", + "client": { + "shortName": "AlloyDBAdminClient", + "fullName": "google.cloud.alloydb.v1beta.AlloyDBAdminClient" + }, + "method": { + "shortName": "ListClusters", + "fullName": "google.cloud.alloydb.v1beta.AlloyDBAdmin.ListClusters", + "service": { + "shortName": "AlloyDBAdmin", + "fullName": "google.cloud.alloydb.v1beta.AlloyDBAdmin" + } + } + } + }, + { + "regionTag": "alloydb_v1beta_generated_AlloyDBAdmin_GetCluster_async", + "title": "AlloyDBAdmin getCluster Sample", + "origin": "API_DEFINITION", + "description": " Gets details of a single Cluster.", + "canonical": true, + "file": "alloy_d_b_admin.get_cluster.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 59, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetCluster", + "fullName": "google.cloud.alloydb.v1beta.AlloyDBAdmin.GetCluster", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + }, + { + "name": "view", + "type": ".google.cloud.alloydb.v1beta.ClusterView" + } + ], + "resultType": ".google.cloud.alloydb.v1beta.Cluster", + "client": { + "shortName": "AlloyDBAdminClient", + "fullName": "google.cloud.alloydb.v1beta.AlloyDBAdminClient" + }, + "method": { + "shortName": "GetCluster", + "fullName": "google.cloud.alloydb.v1beta.AlloyDBAdmin.GetCluster", + "service": { + "shortName": "AlloyDBAdmin", + "fullName": "google.cloud.alloydb.v1beta.AlloyDBAdmin" + } + } + } + }, + { + "regionTag": "alloydb_v1beta_generated_AlloyDBAdmin_CreateCluster_async", + "title": "AlloyDBAdmin createCluster Sample", + "origin": "API_DEFINITION", + "description": " Creates a new Cluster in a given project and location.", + "canonical": true, + "file": "alloy_d_b_admin.create_cluster.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 85, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CreateCluster", + "fullName": "google.cloud.alloydb.v1beta.AlloyDBAdmin.CreateCluster", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "cluster_id", + "type": "TYPE_STRING" + }, + { + "name": "cluster", + "type": ".google.cloud.alloydb.v1beta.Cluster" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "validate_only", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "AlloyDBAdminClient", + "fullName": "google.cloud.alloydb.v1beta.AlloyDBAdminClient" + }, + "method": { + "shortName": "CreateCluster", + "fullName": "google.cloud.alloydb.v1beta.AlloyDBAdmin.CreateCluster", + "service": { + "shortName": "AlloyDBAdmin", + "fullName": "google.cloud.alloydb.v1beta.AlloyDBAdmin" + } + } + } + }, + { + "regionTag": "alloydb_v1beta_generated_AlloyDBAdmin_UpdateCluster_async", + "title": "AlloyDBAdmin updateCluster Sample", + "origin": "API_DEFINITION", + "description": " Updates the parameters of a single Cluster.", + "canonical": true, + "file": "alloy_d_b_admin.update_cluster.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 87, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "UpdateCluster", + "fullName": "google.cloud.alloydb.v1beta.AlloyDBAdmin.UpdateCluster", + "async": true, + "parameters": [ + { + "name": "update_mask", + "type": ".google.protobuf.FieldMask" + }, + { + "name": "cluster", + "type": ".google.cloud.alloydb.v1beta.Cluster" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "validate_only", + "type": "TYPE_BOOL" + }, + { + "name": "allow_missing", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "AlloyDBAdminClient", + "fullName": "google.cloud.alloydb.v1beta.AlloyDBAdminClient" + }, + "method": { + "shortName": "UpdateCluster", + "fullName": "google.cloud.alloydb.v1beta.AlloyDBAdmin.UpdateCluster", + "service": { + "shortName": "AlloyDBAdmin", + "fullName": "google.cloud.alloydb.v1beta.AlloyDBAdmin" + } + } + } + }, + { + "regionTag": "alloydb_v1beta_generated_AlloyDBAdmin_DeleteCluster_async", + "title": "AlloyDBAdmin deleteCluster Sample", + "origin": "API_DEFINITION", + "description": " Deletes a single Cluster.", + "canonical": true, + "file": "alloy_d_b_admin.delete_cluster.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 84, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeleteCluster", + "fullName": "google.cloud.alloydb.v1beta.AlloyDBAdmin.DeleteCluster", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "etag", + "type": "TYPE_STRING" + }, + { + "name": "validate_only", + "type": "TYPE_BOOL" + }, + { + "name": "force", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "AlloyDBAdminClient", + "fullName": "google.cloud.alloydb.v1beta.AlloyDBAdminClient" + }, + "method": { + "shortName": "DeleteCluster", + "fullName": "google.cloud.alloydb.v1beta.AlloyDBAdmin.DeleteCluster", + "service": { + "shortName": "AlloyDBAdmin", + "fullName": "google.cloud.alloydb.v1beta.AlloyDBAdmin" + } + } + } + }, + { + "regionTag": "alloydb_v1beta_generated_AlloyDBAdmin_PromoteCluster_async", + "title": "AlloyDBAdmin promoteCluster Sample", + "origin": "API_DEFINITION", + "description": " Promotes a SECONDARY cluster. This turns down replication from the PRIMARY cluster and promotes a secondary cluster into its own standalone cluster. Imperative only.", + "canonical": true, + "file": "alloy_d_b_admin.promote_cluster.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 80, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "PromoteCluster", + "fullName": "google.cloud.alloydb.v1beta.AlloyDBAdmin.PromoteCluster", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "etag", + "type": "TYPE_STRING" + }, + { + "name": "validate_only", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "AlloyDBAdminClient", + "fullName": "google.cloud.alloydb.v1beta.AlloyDBAdminClient" + }, + "method": { + "shortName": "PromoteCluster", + "fullName": "google.cloud.alloydb.v1beta.AlloyDBAdmin.PromoteCluster", + "service": { + "shortName": "AlloyDBAdmin", + "fullName": "google.cloud.alloydb.v1beta.AlloyDBAdmin" + } + } + } + }, + { + "regionTag": "alloydb_v1beta_generated_AlloyDBAdmin_RestoreCluster_async", + "title": "AlloyDBAdmin restoreCluster Sample", + "origin": "API_DEFINITION", + "description": " Creates a new Cluster in a given project and location, with a volume restored from the provided source, either a backup ID or a point-in-time and a source cluster.", + "canonical": true, + "file": "alloy_d_b_admin.restore_cluster.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 94, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "RestoreCluster", + "fullName": "google.cloud.alloydb.v1beta.AlloyDBAdmin.RestoreCluster", + "async": true, + "parameters": [ + { + "name": "backup_source", + "type": ".google.cloud.alloydb.v1beta.BackupSource" + }, + { + "name": "continuous_backup_source", + "type": ".google.cloud.alloydb.v1beta.ContinuousBackupSource" + }, + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "cluster_id", + "type": "TYPE_STRING" + }, + { + "name": "cluster", + "type": ".google.cloud.alloydb.v1beta.Cluster" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "validate_only", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "AlloyDBAdminClient", + "fullName": "google.cloud.alloydb.v1beta.AlloyDBAdminClient" + }, + "method": { + "shortName": "RestoreCluster", + "fullName": "google.cloud.alloydb.v1beta.AlloyDBAdmin.RestoreCluster", + "service": { + "shortName": "AlloyDBAdmin", + "fullName": "google.cloud.alloydb.v1beta.AlloyDBAdmin" + } + } + } + }, + { + "regionTag": "alloydb_v1beta_generated_AlloyDBAdmin_CreateSecondaryCluster_async", + "title": "AlloyDBAdmin createSecondaryCluster Sample", + "origin": "API_DEFINITION", + "description": " Creates a cluster of type SECONDARY in the given location using the primary cluster as the source.", + "canonical": true, + "file": "alloy_d_b_admin.create_secondary_cluster.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 85, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CreateSecondaryCluster", + "fullName": "google.cloud.alloydb.v1beta.AlloyDBAdmin.CreateSecondaryCluster", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "cluster_id", + "type": "TYPE_STRING" + }, + { + "name": "cluster", + "type": ".google.cloud.alloydb.v1beta.Cluster" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "validate_only", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "AlloyDBAdminClient", + "fullName": "google.cloud.alloydb.v1beta.AlloyDBAdminClient" + }, + "method": { + "shortName": "CreateSecondaryCluster", + "fullName": "google.cloud.alloydb.v1beta.AlloyDBAdmin.CreateSecondaryCluster", + "service": { + "shortName": "AlloyDBAdmin", + "fullName": "google.cloud.alloydb.v1beta.AlloyDBAdmin" + } + } + } + }, + { + "regionTag": "alloydb_v1beta_generated_AlloyDBAdmin_ListInstances_async", + "title": "AlloyDBAdmin listInstances Sample", + "origin": "API_DEFINITION", + "description": " Lists Instances in a given project and location.", + "canonical": true, + "file": "alloy_d_b_admin.list_instances.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 77, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListInstances", + "fullName": "google.cloud.alloydb.v1beta.AlloyDBAdmin.ListInstances", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.alloydb.v1beta.ListInstancesResponse", + "client": { + "shortName": "AlloyDBAdminClient", + "fullName": "google.cloud.alloydb.v1beta.AlloyDBAdminClient" + }, + "method": { + "shortName": "ListInstances", + "fullName": "google.cloud.alloydb.v1beta.AlloyDBAdmin.ListInstances", + "service": { + "shortName": "AlloyDBAdmin", + "fullName": "google.cloud.alloydb.v1beta.AlloyDBAdmin" + } + } + } + }, + { + "regionTag": "alloydb_v1beta_generated_AlloyDBAdmin_GetInstance_async", + "title": "AlloyDBAdmin getInstance Sample", + "origin": "API_DEFINITION", + "description": " Gets details of a single Instance.", + "canonical": true, + "file": "alloy_d_b_admin.get_instance.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 58, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetInstance", + "fullName": "google.cloud.alloydb.v1beta.AlloyDBAdmin.GetInstance", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + }, + { + "name": "view", + "type": ".google.cloud.alloydb.v1beta.InstanceView" + } + ], + "resultType": ".google.cloud.alloydb.v1beta.Instance", + "client": { + "shortName": "AlloyDBAdminClient", + "fullName": "google.cloud.alloydb.v1beta.AlloyDBAdminClient" + }, + "method": { + "shortName": "GetInstance", + "fullName": "google.cloud.alloydb.v1beta.AlloyDBAdmin.GetInstance", + "service": { + "shortName": "AlloyDBAdmin", + "fullName": "google.cloud.alloydb.v1beta.AlloyDBAdmin" + } + } + } + }, + { + "regionTag": "alloydb_v1beta_generated_AlloyDBAdmin_CreateInstance_async", + "title": "AlloyDBAdmin createInstance Sample", + "origin": "API_DEFINITION", + "description": " Creates a new Instance in a given project and location.", + "canonical": true, + "file": "alloy_d_b_admin.create_instance.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 85, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CreateInstance", + "fullName": "google.cloud.alloydb.v1beta.AlloyDBAdmin.CreateInstance", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "instance_id", + "type": "TYPE_STRING" + }, + { + "name": "instance", + "type": ".google.cloud.alloydb.v1beta.Instance" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "validate_only", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "AlloyDBAdminClient", + "fullName": "google.cloud.alloydb.v1beta.AlloyDBAdminClient" + }, + "method": { + "shortName": "CreateInstance", + "fullName": "google.cloud.alloydb.v1beta.AlloyDBAdmin.CreateInstance", + "service": { + "shortName": "AlloyDBAdmin", + "fullName": "google.cloud.alloydb.v1beta.AlloyDBAdmin" + } + } + } + }, + { + "regionTag": "alloydb_v1beta_generated_AlloyDBAdmin_CreateSecondaryInstance_async", + "title": "AlloyDBAdmin createSecondaryInstance Sample", + "origin": "API_DEFINITION", + "description": " Creates a new SECONDARY Instance in a given project and location.", + "canonical": true, + "file": "alloy_d_b_admin.create_secondary_instance.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 85, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CreateSecondaryInstance", + "fullName": "google.cloud.alloydb.v1beta.AlloyDBAdmin.CreateSecondaryInstance", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "instance_id", + "type": "TYPE_STRING" + }, + { + "name": "instance", + "type": ".google.cloud.alloydb.v1beta.Instance" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "validate_only", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "AlloyDBAdminClient", + "fullName": "google.cloud.alloydb.v1beta.AlloyDBAdminClient" + }, + "method": { + "shortName": "CreateSecondaryInstance", + "fullName": "google.cloud.alloydb.v1beta.AlloyDBAdmin.CreateSecondaryInstance", + "service": { + "shortName": "AlloyDBAdmin", + "fullName": "google.cloud.alloydb.v1beta.AlloyDBAdmin" + } + } + } + }, + { + "regionTag": "alloydb_v1beta_generated_AlloyDBAdmin_BatchCreateInstances_async", + "title": "AlloyDBAdmin batchCreateInstances Sample", + "origin": "API_DEFINITION", + "description": " Creates new instances under the given project, location and cluster. There can be only one primary instance in a cluster. If the primary instance exists in the cluster as well as this request, then API will throw an error. The primary instance should exist before any read pool instance is created. If the primary instance is a part of the request payload, then the API will take care of creating instances in the correct order. This method is here to support Google-internal use cases, and is not meant for external customers to consume. Please do not start relying on it; its behavior is subject to change without notice.", + "canonical": true, + "file": "alloy_d_b_admin.batch_create_instances.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 73, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "BatchCreateInstances", + "fullName": "google.cloud.alloydb.v1beta.AlloyDBAdmin.BatchCreateInstances", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "requests", + "type": ".google.cloud.alloydb.v1beta.CreateInstanceRequests" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "AlloyDBAdminClient", + "fullName": "google.cloud.alloydb.v1beta.AlloyDBAdminClient" + }, + "method": { + "shortName": "BatchCreateInstances", + "fullName": "google.cloud.alloydb.v1beta.AlloyDBAdmin.BatchCreateInstances", + "service": { + "shortName": "AlloyDBAdmin", + "fullName": "google.cloud.alloydb.v1beta.AlloyDBAdmin" + } + } + } + }, + { + "regionTag": "alloydb_v1beta_generated_AlloyDBAdmin_UpdateInstance_async", + "title": "AlloyDBAdmin updateInstance Sample", + "origin": "API_DEFINITION", + "description": " Updates the parameters of a single Instance.", + "canonical": true, + "file": "alloy_d_b_admin.update_instance.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 87, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "UpdateInstance", + "fullName": "google.cloud.alloydb.v1beta.AlloyDBAdmin.UpdateInstance", + "async": true, + "parameters": [ + { + "name": "update_mask", + "type": ".google.protobuf.FieldMask" + }, + { + "name": "instance", + "type": ".google.cloud.alloydb.v1beta.Instance" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "validate_only", + "type": "TYPE_BOOL" + }, + { + "name": "allow_missing", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "AlloyDBAdminClient", + "fullName": "google.cloud.alloydb.v1beta.AlloyDBAdminClient" + }, + "method": { + "shortName": "UpdateInstance", + "fullName": "google.cloud.alloydb.v1beta.AlloyDBAdmin.UpdateInstance", + "service": { + "shortName": "AlloyDBAdmin", + "fullName": "google.cloud.alloydb.v1beta.AlloyDBAdmin" + } + } + } + }, + { + "regionTag": "alloydb_v1beta_generated_AlloyDBAdmin_DeleteInstance_async", + "title": "AlloyDBAdmin deleteInstance Sample", + "origin": "API_DEFINITION", + "description": " Deletes a single Instance.", + "canonical": true, + "file": "alloy_d_b_admin.delete_instance.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 80, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeleteInstance", + "fullName": "google.cloud.alloydb.v1beta.AlloyDBAdmin.DeleteInstance", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "etag", + "type": "TYPE_STRING" + }, + { + "name": "validate_only", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "AlloyDBAdminClient", + "fullName": "google.cloud.alloydb.v1beta.AlloyDBAdminClient" + }, + "method": { + "shortName": "DeleteInstance", + "fullName": "google.cloud.alloydb.v1beta.AlloyDBAdmin.DeleteInstance", + "service": { + "shortName": "AlloyDBAdmin", + "fullName": "google.cloud.alloydb.v1beta.AlloyDBAdmin" + } + } + } + }, + { + "regionTag": "alloydb_v1beta_generated_AlloyDBAdmin_FailoverInstance_async", + "title": "AlloyDBAdmin failoverInstance Sample", + "origin": "API_DEFINITION", + "description": " Forces a Failover for a highly available instance. Failover promotes the HA standby instance as the new primary. Imperative only.", + "canonical": true, + "file": "alloy_d_b_admin.failover_instance.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 74, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "FailoverInstance", + "fullName": "google.cloud.alloydb.v1beta.AlloyDBAdmin.FailoverInstance", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "validate_only", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "AlloyDBAdminClient", + "fullName": "google.cloud.alloydb.v1beta.AlloyDBAdminClient" + }, + "method": { + "shortName": "FailoverInstance", + "fullName": "google.cloud.alloydb.v1beta.AlloyDBAdmin.FailoverInstance", + "service": { + "shortName": "AlloyDBAdmin", + "fullName": "google.cloud.alloydb.v1beta.AlloyDBAdmin" + } + } + } + }, + { + "regionTag": "alloydb_v1beta_generated_AlloyDBAdmin_InjectFault_async", + "title": "AlloyDBAdmin injectFault Sample", + "origin": "API_DEFINITION", + "description": " Injects fault in an instance. Imperative only.", + "canonical": true, + "file": "alloy_d_b_admin.inject_fault.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 80, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "InjectFault", + "fullName": "google.cloud.alloydb.v1beta.AlloyDBAdmin.InjectFault", + "async": true, + "parameters": [ + { + "name": "fault_type", + "type": ".google.cloud.alloydb.v1beta.InjectFaultRequest.FaultType" + }, + { + "name": "name", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "validate_only", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "AlloyDBAdminClient", + "fullName": "google.cloud.alloydb.v1beta.AlloyDBAdminClient" + }, + "method": { + "shortName": "InjectFault", + "fullName": "google.cloud.alloydb.v1beta.AlloyDBAdmin.InjectFault", + "service": { + "shortName": "AlloyDBAdmin", + "fullName": "google.cloud.alloydb.v1beta.AlloyDBAdmin" + } + } + } + }, + { + "regionTag": "alloydb_v1beta_generated_AlloyDBAdmin_RestartInstance_async", + "title": "AlloyDBAdmin restartInstance Sample", + "origin": "API_DEFINITION", + "description": " Restart an Instance in a cluster. Imperative only.", + "canonical": true, + "file": "alloy_d_b_admin.restart_instance.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 74, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "RestartInstance", + "fullName": "google.cloud.alloydb.v1beta.AlloyDBAdmin.RestartInstance", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "validate_only", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "AlloyDBAdminClient", + "fullName": "google.cloud.alloydb.v1beta.AlloyDBAdminClient" + }, + "method": { + "shortName": "RestartInstance", + "fullName": "google.cloud.alloydb.v1beta.AlloyDBAdmin.RestartInstance", + "service": { + "shortName": "AlloyDBAdmin", + "fullName": "google.cloud.alloydb.v1beta.AlloyDBAdmin" + } + } + } + }, + { + "regionTag": "alloydb_v1beta_generated_AlloyDBAdmin_ListBackups_async", + "title": "AlloyDBAdmin listBackups Sample", + "origin": "API_DEFINITION", + "description": " Lists Backups in a given project and location.", + "canonical": true, + "file": "alloy_d_b_admin.list_backups.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 72, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListBackups", + "fullName": "google.cloud.alloydb.v1beta.AlloyDBAdmin.ListBackups", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.alloydb.v1beta.ListBackupsResponse", + "client": { + "shortName": "AlloyDBAdminClient", + "fullName": "google.cloud.alloydb.v1beta.AlloyDBAdminClient" + }, + "method": { + "shortName": "ListBackups", + "fullName": "google.cloud.alloydb.v1beta.AlloyDBAdmin.ListBackups", + "service": { + "shortName": "AlloyDBAdmin", + "fullName": "google.cloud.alloydb.v1beta.AlloyDBAdmin" + } + } + } + }, + { + "regionTag": "alloydb_v1beta_generated_AlloyDBAdmin_GetBackup_async", + "title": "AlloyDBAdmin getBackup Sample", + "origin": "API_DEFINITION", + "description": " Gets details of a single Backup.", + "canonical": true, + "file": "alloy_d_b_admin.get_backup.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 53, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetBackup", + "fullName": "google.cloud.alloydb.v1beta.AlloyDBAdmin.GetBackup", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.alloydb.v1beta.Backup", + "client": { + "shortName": "AlloyDBAdminClient", + "fullName": "google.cloud.alloydb.v1beta.AlloyDBAdminClient" + }, + "method": { + "shortName": "GetBackup", + "fullName": "google.cloud.alloydb.v1beta.AlloyDBAdmin.GetBackup", + "service": { + "shortName": "AlloyDBAdmin", + "fullName": "google.cloud.alloydb.v1beta.AlloyDBAdmin" + } + } + } + }, + { + "regionTag": "alloydb_v1beta_generated_AlloyDBAdmin_CreateBackup_async", + "title": "AlloyDBAdmin createBackup Sample", + "origin": "API_DEFINITION", + "description": " Creates a new Backup in a given project and location.", + "canonical": true, + "file": "alloy_d_b_admin.create_backup.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 83, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CreateBackup", + "fullName": "google.cloud.alloydb.v1beta.AlloyDBAdmin.CreateBackup", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "backup_id", + "type": "TYPE_STRING" + }, + { + "name": "backup", + "type": ".google.cloud.alloydb.v1beta.Backup" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "validate_only", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "AlloyDBAdminClient", + "fullName": "google.cloud.alloydb.v1beta.AlloyDBAdminClient" + }, + "method": { + "shortName": "CreateBackup", + "fullName": "google.cloud.alloydb.v1beta.AlloyDBAdmin.CreateBackup", + "service": { + "shortName": "AlloyDBAdmin", + "fullName": "google.cloud.alloydb.v1beta.AlloyDBAdmin" + } + } + } + }, + { + "regionTag": "alloydb_v1beta_generated_AlloyDBAdmin_UpdateBackup_async", + "title": "AlloyDBAdmin updateBackup Sample", + "origin": "API_DEFINITION", + "description": " Updates the parameters of a single Backup.", + "canonical": true, + "file": "alloy_d_b_admin.update_backup.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 86, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "UpdateBackup", + "fullName": "google.cloud.alloydb.v1beta.AlloyDBAdmin.UpdateBackup", + "async": true, + "parameters": [ + { + "name": "update_mask", + "type": ".google.protobuf.FieldMask" + }, + { + "name": "backup", + "type": ".google.cloud.alloydb.v1beta.Backup" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "validate_only", + "type": "TYPE_BOOL" + }, + { + "name": "allow_missing", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "AlloyDBAdminClient", + "fullName": "google.cloud.alloydb.v1beta.AlloyDBAdminClient" + }, + "method": { + "shortName": "UpdateBackup", + "fullName": "google.cloud.alloydb.v1beta.AlloyDBAdmin.UpdateBackup", + "service": { + "shortName": "AlloyDBAdmin", + "fullName": "google.cloud.alloydb.v1beta.AlloyDBAdmin" + } + } + } + }, + { + "regionTag": "alloydb_v1beta_generated_AlloyDBAdmin_DeleteBackup_async", + "title": "AlloyDBAdmin deleteBackup Sample", + "origin": "API_DEFINITION", + "description": " Deletes a single Backup.", + "canonical": true, + "file": "alloy_d_b_admin.delete_backup.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 80, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeleteBackup", + "fullName": "google.cloud.alloydb.v1beta.AlloyDBAdmin.DeleteBackup", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "validate_only", + "type": "TYPE_BOOL" + }, + { + "name": "etag", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "AlloyDBAdminClient", + "fullName": "google.cloud.alloydb.v1beta.AlloyDBAdminClient" + }, + "method": { + "shortName": "DeleteBackup", + "fullName": "google.cloud.alloydb.v1beta.AlloyDBAdmin.DeleteBackup", + "service": { + "shortName": "AlloyDBAdmin", + "fullName": "google.cloud.alloydb.v1beta.AlloyDBAdmin" + } + } + } + }, + { + "regionTag": "alloydb_v1beta_generated_AlloyDBAdmin_ListSupportedDatabaseFlags_async", + "title": "AlloyDBAdmin listSupportedDatabaseFlags Sample", + "origin": "API_DEFINITION", + "description": " Lists SupportedDatabaseFlags for a given project and location.", + "canonical": true, + "file": "alloy_d_b_admin.list_supported_database_flags.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 69, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListSupportedDatabaseFlags", + "fullName": "google.cloud.alloydb.v1beta.AlloyDBAdmin.ListSupportedDatabaseFlags", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.alloydb.v1beta.ListSupportedDatabaseFlagsResponse", + "client": { + "shortName": "AlloyDBAdminClient", + "fullName": "google.cloud.alloydb.v1beta.AlloyDBAdminClient" + }, + "method": { + "shortName": "ListSupportedDatabaseFlags", + "fullName": "google.cloud.alloydb.v1beta.AlloyDBAdmin.ListSupportedDatabaseFlags", + "service": { + "shortName": "AlloyDBAdmin", + "fullName": "google.cloud.alloydb.v1beta.AlloyDBAdmin" + } + } + } + }, + { + "regionTag": "alloydb_v1beta_generated_AlloyDBAdmin_GenerateClientCertificate_async", + "title": "AlloyDBAdmin generateClientCertificate Sample", + "origin": "API_DEFINITION", + "description": " Generate a client certificate signed by a Cluster CA. The sole purpose of this endpoint is to support the Auth Proxy client and the endpoint's behavior is subject to change without notice, so do not rely on its behavior remaining constant. Future changes will not break the Auth Proxy client.", + "canonical": true, + "file": "alloy_d_b_admin.generate_client_certificate.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 84, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GenerateClientCertificate", + "fullName": "google.cloud.alloydb.v1beta.AlloyDBAdmin.GenerateClientCertificate", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "pem_csr", + "type": "TYPE_STRING" + }, + { + "name": "cert_duration", + "type": ".google.protobuf.Duration" + }, + { + "name": "public_key", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.alloydb.v1beta.GenerateClientCertificateResponse", + "client": { + "shortName": "AlloyDBAdminClient", + "fullName": "google.cloud.alloydb.v1beta.AlloyDBAdminClient" + }, + "method": { + "shortName": "GenerateClientCertificate", + "fullName": "google.cloud.alloydb.v1beta.AlloyDBAdmin.GenerateClientCertificate", + "service": { + "shortName": "AlloyDBAdmin", + "fullName": "google.cloud.alloydb.v1beta.AlloyDBAdmin" + } + } + } + }, + { + "regionTag": "alloydb_v1beta_generated_AlloyDBAdmin_GetConnectionInfo_async", + "title": "AlloyDBAdmin getConnectionInfo Sample", + "origin": "API_DEFINITION", + "description": " Get instance metadata used for a connection.", + "canonical": true, + "file": "alloy_d_b_admin.get_connection_info.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 68, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetConnectionInfo", + "fullName": "google.cloud.alloydb.v1beta.AlloyDBAdmin.GetConnectionInfo", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.alloydb.v1beta.ConnectionInfo", + "client": { + "shortName": "AlloyDBAdminClient", + "fullName": "google.cloud.alloydb.v1beta.AlloyDBAdminClient" + }, + "method": { + "shortName": "GetConnectionInfo", + "fullName": "google.cloud.alloydb.v1beta.AlloyDBAdmin.GetConnectionInfo", + "service": { + "shortName": "AlloyDBAdmin", + "fullName": "google.cloud.alloydb.v1beta.AlloyDBAdmin" + } + } + } + }, + { + "regionTag": "alloydb_v1beta_generated_AlloyDBAdmin_ListUsers_async", + "title": "AlloyDBAdmin listUsers Sample", + "origin": "API_DEFINITION", + "description": " Lists Users in a given project and location.", + "canonical": true, + "file": "alloy_d_b_admin.list_users.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 72, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListUsers", + "fullName": "google.cloud.alloydb.v1beta.AlloyDBAdmin.ListUsers", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.alloydb.v1beta.ListUsersResponse", + "client": { + "shortName": "AlloyDBAdminClient", + "fullName": "google.cloud.alloydb.v1beta.AlloyDBAdminClient" + }, + "method": { + "shortName": "ListUsers", + "fullName": "google.cloud.alloydb.v1beta.AlloyDBAdmin.ListUsers", + "service": { + "shortName": "AlloyDBAdmin", + "fullName": "google.cloud.alloydb.v1beta.AlloyDBAdmin" + } + } + } + }, + { + "regionTag": "alloydb_v1beta_generated_AlloyDBAdmin_GetUser_async", + "title": "AlloyDBAdmin getUser Sample", + "origin": "API_DEFINITION", + "description": " Gets details of a single User.", + "canonical": true, + "file": "alloy_d_b_admin.get_user.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 54, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetUser", + "fullName": "google.cloud.alloydb.v1beta.AlloyDBAdmin.GetUser", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.alloydb.v1beta.User", + "client": { + "shortName": "AlloyDBAdminClient", + "fullName": "google.cloud.alloydb.v1beta.AlloyDBAdminClient" + }, + "method": { + "shortName": "GetUser", + "fullName": "google.cloud.alloydb.v1beta.AlloyDBAdmin.GetUser", + "service": { + "shortName": "AlloyDBAdmin", + "fullName": "google.cloud.alloydb.v1beta.AlloyDBAdmin" + } + } + } + }, + { + "regionTag": "alloydb_v1beta_generated_AlloyDBAdmin_CreateUser_async", + "title": "AlloyDBAdmin createUser Sample", + "origin": "API_DEFINITION", + "description": " Creates a new User in a given project, location, and cluster.", + "canonical": true, + "file": "alloy_d_b_admin.create_user.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 82, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CreateUser", + "fullName": "google.cloud.alloydb.v1beta.AlloyDBAdmin.CreateUser", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "user_id", + "type": "TYPE_STRING" + }, + { + "name": "user", + "type": ".google.cloud.alloydb.v1beta.User" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "validate_only", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.cloud.alloydb.v1beta.User", + "client": { + "shortName": "AlloyDBAdminClient", + "fullName": "google.cloud.alloydb.v1beta.AlloyDBAdminClient" + }, + "method": { + "shortName": "CreateUser", + "fullName": "google.cloud.alloydb.v1beta.AlloyDBAdmin.CreateUser", + "service": { + "shortName": "AlloyDBAdmin", + "fullName": "google.cloud.alloydb.v1beta.AlloyDBAdmin" + } + } + } + }, + { + "regionTag": "alloydb_v1beta_generated_AlloyDBAdmin_UpdateUser_async", + "title": "AlloyDBAdmin updateUser Sample", + "origin": "API_DEFINITION", + "description": " Updates the parameters of a single User.", + "canonical": true, + "file": "alloy_d_b_admin.update_user.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 84, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "UpdateUser", + "fullName": "google.cloud.alloydb.v1beta.AlloyDBAdmin.UpdateUser", + "async": true, + "parameters": [ + { + "name": "update_mask", + "type": ".google.protobuf.FieldMask" + }, + { + "name": "user", + "type": ".google.cloud.alloydb.v1beta.User" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "validate_only", + "type": "TYPE_BOOL" + }, + { + "name": "allow_missing", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.cloud.alloydb.v1beta.User", + "client": { + "shortName": "AlloyDBAdminClient", + "fullName": "google.cloud.alloydb.v1beta.AlloyDBAdminClient" + }, + "method": { + "shortName": "UpdateUser", + "fullName": "google.cloud.alloydb.v1beta.AlloyDBAdmin.UpdateUser", + "service": { + "shortName": "AlloyDBAdmin", + "fullName": "google.cloud.alloydb.v1beta.AlloyDBAdmin" + } + } + } + }, + { + "regionTag": "alloydb_v1beta_generated_AlloyDBAdmin_DeleteUser_async", + "title": "AlloyDBAdmin deleteUser Sample", + "origin": "API_DEFINITION", + "description": " Deletes a single User.", + "canonical": true, + "file": "alloy_d_b_admin.delete_user.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 73, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeleteUser", + "fullName": "google.cloud.alloydb.v1beta.AlloyDBAdmin.DeleteUser", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "validate_only", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.protobuf.Empty", + "client": { + "shortName": "AlloyDBAdminClient", + "fullName": "google.cloud.alloydb.v1beta.AlloyDBAdminClient" + }, + "method": { + "shortName": "DeleteUser", + "fullName": "google.cloud.alloydb.v1beta.AlloyDBAdmin.DeleteUser", + "service": { + "shortName": "AlloyDBAdmin", + "fullName": "google.cloud.alloydb.v1beta.AlloyDBAdmin" + } + } + } + } + ] +} \ No newline at end of file diff --git a/packages/google-cloud-alloydb/samples/package.json b/packages/google-cloud-alloydb/samples/package.json index f254e87d474..cc6503a102b 100644 --- a/packages/google-cloud-alloydb/samples/package.json +++ b/packages/google-cloud-alloydb/samples/package.json @@ -4,7 +4,7 @@ "license": "Apache-2.0", "author": "Google LLC", "engines": { - "node": ">=12.0.0" + "node": ">=14.0.0" }, "files": [ "*.js" @@ -21,4 +21,4 @@ "chai": "^4.2.0", "mocha": "^8.0.0" } -} +} \ No newline at end of file diff --git a/packages/google-cloud-alloydb/src/v1/alloy_d_b_admin_client.ts b/packages/google-cloud-alloydb/src/v1/alloy_d_b_admin_client.ts index 591dce74f78..3ea40206d07 100644 --- a/packages/google-cloud-alloydb/src/v1/alloy_d_b_admin_client.ts +++ b/packages/google-cloud-alloydb/src/v1/alloy_d_b_admin_client.ts @@ -666,9 +666,8 @@ export class AlloyDBAdminClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.alloydb.v1.Cluster | Cluster}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.alloydb.v1.Cluster|Cluster}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/alloy_d_b_admin.get_cluster.js * region_tag:alloydb_v1_generated_AlloyDBAdmin_GetCluster_async @@ -752,9 +751,8 @@ export class AlloyDBAdminClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.alloydb.v1.Instance | Instance}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.alloydb.v1.Instance|Instance}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/alloy_d_b_admin.get_instance.js * region_tag:alloydb_v1_generated_AlloyDBAdmin_GetInstance_async @@ -835,9 +833,8 @@ export class AlloyDBAdminClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.alloydb.v1.Backup | Backup}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.alloydb.v1.Backup|Backup}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/alloy_d_b_admin.get_backup.js * region_tag:alloydb_v1_generated_AlloyDBAdmin_GetBackup_async @@ -919,9 +916,8 @@ export class AlloyDBAdminClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.alloydb.v1.User | User}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.alloydb.v1.User|User}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/alloy_d_b_admin.get_user.js * region_tag:alloydb_v1_generated_AlloyDBAdmin_GetUser_async @@ -1023,9 +1019,8 @@ export class AlloyDBAdminClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.alloydb.v1.User | User}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.alloydb.v1.User|User}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/alloy_d_b_admin.create_user.js * region_tag:alloydb_v1_generated_AlloyDBAdmin_CreateUser_async @@ -1131,9 +1126,8 @@ export class AlloyDBAdminClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.alloydb.v1.User | User}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.alloydb.v1.User|User}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/alloy_d_b_admin.update_user.js * region_tag:alloydb_v1_generated_AlloyDBAdmin_UpdateUser_async @@ -1232,9 +1226,8 @@ export class AlloyDBAdminClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.protobuf.Empty | Empty}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.protobuf.Empty|Empty}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/alloy_d_b_admin.delete_user.js * region_tag:alloydb_v1_generated_AlloyDBAdmin_DeleteUser_async @@ -1342,8 +1335,7 @@ export class AlloyDBAdminClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/alloy_d_b_admin.create_cluster.js * region_tag:alloydb_v1_generated_AlloyDBAdmin_CreateCluster_async @@ -1438,8 +1430,7 @@ export class AlloyDBAdminClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/alloy_d_b_admin.create_cluster.js * region_tag:alloydb_v1_generated_AlloyDBAdmin_CreateCluster_async @@ -1507,8 +1498,7 @@ export class AlloyDBAdminClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/alloy_d_b_admin.update_cluster.js * region_tag:alloydb_v1_generated_AlloyDBAdmin_UpdateCluster_async @@ -1603,8 +1593,7 @@ export class AlloyDBAdminClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/alloy_d_b_admin.update_cluster.js * region_tag:alloydb_v1_generated_AlloyDBAdmin_UpdateCluster_async @@ -1669,8 +1658,7 @@ export class AlloyDBAdminClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/alloy_d_b_admin.delete_cluster.js * region_tag:alloydb_v1_generated_AlloyDBAdmin_DeleteCluster_async @@ -1765,8 +1753,7 @@ export class AlloyDBAdminClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/alloy_d_b_admin.delete_cluster.js * region_tag:alloydb_v1_generated_AlloyDBAdmin_DeleteCluster_async @@ -1832,8 +1819,7 @@ export class AlloyDBAdminClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/alloy_d_b_admin.promote_cluster.js * region_tag:alloydb_v1_generated_AlloyDBAdmin_PromoteCluster_async @@ -1928,8 +1914,7 @@ export class AlloyDBAdminClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/alloy_d_b_admin.promote_cluster.js * region_tag:alloydb_v1_generated_AlloyDBAdmin_PromoteCluster_async @@ -2000,8 +1985,7 @@ export class AlloyDBAdminClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/alloy_d_b_admin.restore_cluster.js * region_tag:alloydb_v1_generated_AlloyDBAdmin_RestoreCluster_async @@ -2096,8 +2080,7 @@ export class AlloyDBAdminClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/alloy_d_b_admin.restore_cluster.js * region_tag:alloydb_v1_generated_AlloyDBAdmin_RestoreCluster_async @@ -2162,8 +2145,7 @@ export class AlloyDBAdminClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/alloy_d_b_admin.create_secondary_cluster.js * region_tag:alloydb_v1_generated_AlloyDBAdmin_CreateSecondaryCluster_async @@ -2262,8 +2244,7 @@ export class AlloyDBAdminClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/alloy_d_b_admin.create_secondary_cluster.js * region_tag:alloydb_v1_generated_AlloyDBAdmin_CreateSecondaryCluster_async @@ -2327,8 +2308,7 @@ export class AlloyDBAdminClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/alloy_d_b_admin.create_instance.js * region_tag:alloydb_v1_generated_AlloyDBAdmin_CreateInstance_async @@ -2423,8 +2403,7 @@ export class AlloyDBAdminClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/alloy_d_b_admin.create_instance.js * region_tag:alloydb_v1_generated_AlloyDBAdmin_CreateInstance_async @@ -2488,8 +2467,7 @@ export class AlloyDBAdminClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/alloy_d_b_admin.create_secondary_instance.js * region_tag:alloydb_v1_generated_AlloyDBAdmin_CreateSecondaryInstance_async @@ -2588,8 +2566,7 @@ export class AlloyDBAdminClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/alloy_d_b_admin.create_secondary_instance.js * region_tag:alloydb_v1_generated_AlloyDBAdmin_CreateSecondaryInstance_async @@ -2655,8 +2632,7 @@ export class AlloyDBAdminClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/alloy_d_b_admin.batch_create_instances.js * region_tag:alloydb_v1_generated_AlloyDBAdmin_BatchCreateInstances_async @@ -2751,8 +2727,7 @@ export class AlloyDBAdminClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/alloy_d_b_admin.batch_create_instances.js * region_tag:alloydb_v1_generated_AlloyDBAdmin_BatchCreateInstances_async @@ -2820,8 +2795,7 @@ export class AlloyDBAdminClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/alloy_d_b_admin.update_instance.js * region_tag:alloydb_v1_generated_AlloyDBAdmin_UpdateInstance_async @@ -2916,8 +2890,7 @@ export class AlloyDBAdminClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/alloy_d_b_admin.update_instance.js * region_tag:alloydb_v1_generated_AlloyDBAdmin_UpdateInstance_async @@ -2980,8 +2953,7 @@ export class AlloyDBAdminClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/alloy_d_b_admin.delete_instance.js * region_tag:alloydb_v1_generated_AlloyDBAdmin_DeleteInstance_async @@ -3076,8 +3048,7 @@ export class AlloyDBAdminClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/alloy_d_b_admin.delete_instance.js * region_tag:alloydb_v1_generated_AlloyDBAdmin_DeleteInstance_async @@ -3138,8 +3109,7 @@ export class AlloyDBAdminClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/alloy_d_b_admin.failover_instance.js * region_tag:alloydb_v1_generated_AlloyDBAdmin_FailoverInstance_async @@ -3234,8 +3204,7 @@ export class AlloyDBAdminClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/alloy_d_b_admin.failover_instance.js * region_tag:alloydb_v1_generated_AlloyDBAdmin_FailoverInstance_async @@ -3298,8 +3267,7 @@ export class AlloyDBAdminClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/alloy_d_b_admin.inject_fault.js * region_tag:alloydb_v1_generated_AlloyDBAdmin_InjectFault_async @@ -3394,8 +3362,7 @@ export class AlloyDBAdminClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/alloy_d_b_admin.inject_fault.js * region_tag:alloydb_v1_generated_AlloyDBAdmin_InjectFault_async @@ -3455,8 +3422,7 @@ export class AlloyDBAdminClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/alloy_d_b_admin.restart_instance.js * region_tag:alloydb_v1_generated_AlloyDBAdmin_RestartInstance_async @@ -3551,8 +3517,7 @@ export class AlloyDBAdminClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/alloy_d_b_admin.restart_instance.js * region_tag:alloydb_v1_generated_AlloyDBAdmin_RestartInstance_async @@ -3614,8 +3579,7 @@ export class AlloyDBAdminClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/alloy_d_b_admin.create_backup.js * region_tag:alloydb_v1_generated_AlloyDBAdmin_CreateBackup_async @@ -3710,8 +3674,7 @@ export class AlloyDBAdminClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/alloy_d_b_admin.create_backup.js * region_tag:alloydb_v1_generated_AlloyDBAdmin_CreateBackup_async @@ -3778,8 +3741,7 @@ export class AlloyDBAdminClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/alloy_d_b_admin.update_backup.js * region_tag:alloydb_v1_generated_AlloyDBAdmin_UpdateBackup_async @@ -3874,8 +3836,7 @@ export class AlloyDBAdminClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/alloy_d_b_admin.update_backup.js * region_tag:alloydb_v1_generated_AlloyDBAdmin_UpdateBackup_async @@ -3938,8 +3899,7 @@ export class AlloyDBAdminClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/alloy_d_b_admin.delete_backup.js * region_tag:alloydb_v1_generated_AlloyDBAdmin_DeleteBackup_async @@ -4034,8 +3994,7 @@ export class AlloyDBAdminClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/alloy_d_b_admin.delete_backup.js * region_tag:alloydb_v1_generated_AlloyDBAdmin_DeleteBackup_async @@ -4085,14 +4044,13 @@ export class AlloyDBAdminClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.cloud.alloydb.v1.Cluster | Cluster}. + * The first element of the array is Array of {@link protos.google.cloud.alloydb.v1.Cluster|Cluster}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `listClustersAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listClusters( @@ -4185,13 +4143,12 @@ export class AlloyDBAdminClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.cloud.alloydb.v1.Cluster | Cluster} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.alloydb.v1.Cluster|Cluster} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listClustersAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listClustersStream( @@ -4239,12 +4196,11 @@ export class AlloyDBAdminClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.cloud.alloydb.v1.Cluster | Cluster}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.alloydb.v1.Cluster|Cluster}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1/alloy_d_b_admin.list_clusters.js * region_tag:alloydb_v1_generated_AlloyDBAdmin_ListClusters_async @@ -4294,14 +4250,13 @@ export class AlloyDBAdminClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.cloud.alloydb.v1.Instance | Instance}. + * The first element of the array is Array of {@link protos.google.cloud.alloydb.v1.Instance|Instance}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `listInstancesAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listInstances( @@ -4396,13 +4351,12 @@ export class AlloyDBAdminClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.cloud.alloydb.v1.Instance | Instance} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.alloydb.v1.Instance|Instance} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listInstancesAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listInstancesStream( @@ -4452,12 +4406,11 @@ export class AlloyDBAdminClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.cloud.alloydb.v1.Instance | Instance}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.alloydb.v1.Instance|Instance}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1/alloy_d_b_admin.list_instances.js * region_tag:alloydb_v1_generated_AlloyDBAdmin_ListInstances_async @@ -4502,14 +4455,13 @@ export class AlloyDBAdminClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.cloud.alloydb.v1.Backup | Backup}. + * The first element of the array is Array of {@link protos.google.cloud.alloydb.v1.Backup|Backup}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `listBackupsAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listBackups( @@ -4599,13 +4551,12 @@ export class AlloyDBAdminClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.cloud.alloydb.v1.Backup | Backup} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.alloydb.v1.Backup|Backup} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listBackupsAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listBackupsStream( @@ -4650,12 +4601,11 @@ export class AlloyDBAdminClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.cloud.alloydb.v1.Backup | Backup}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.alloydb.v1.Backup|Backup}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1/alloy_d_b_admin.list_backups.js * region_tag:alloydb_v1_generated_AlloyDBAdmin_ListBackups_async @@ -4702,14 +4652,13 @@ export class AlloyDBAdminClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.cloud.alloydb.v1.SupportedDatabaseFlag | SupportedDatabaseFlag}. + * The first element of the array is Array of {@link protos.google.cloud.alloydb.v1.SupportedDatabaseFlag|SupportedDatabaseFlag}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `listSupportedDatabaseFlagsAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listSupportedDatabaseFlags( @@ -4811,13 +4760,12 @@ export class AlloyDBAdminClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.cloud.alloydb.v1.SupportedDatabaseFlag | SupportedDatabaseFlag} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.alloydb.v1.SupportedDatabaseFlag|SupportedDatabaseFlag} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listSupportedDatabaseFlagsAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listSupportedDatabaseFlagsStream( @@ -4864,12 +4812,11 @@ export class AlloyDBAdminClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.cloud.alloydb.v1.SupportedDatabaseFlag | SupportedDatabaseFlag}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.alloydb.v1.SupportedDatabaseFlag|SupportedDatabaseFlag}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1/alloy_d_b_admin.list_supported_database_flags.js * region_tag:alloydb_v1_generated_AlloyDBAdmin_ListSupportedDatabaseFlags_async @@ -4914,14 +4861,13 @@ export class AlloyDBAdminClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.cloud.alloydb.v1.User | User}. + * The first element of the array is Array of {@link protos.google.cloud.alloydb.v1.User|User}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `listUsersAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listUsers( @@ -5009,13 +4955,12 @@ export class AlloyDBAdminClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.cloud.alloydb.v1.User | User} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.alloydb.v1.User|User} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listUsersAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listUsersStream( @@ -5060,12 +5005,11 @@ export class AlloyDBAdminClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.cloud.alloydb.v1.User | User}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.alloydb.v1.User|User}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1/alloy_d_b_admin.list_users.js * region_tag:alloydb_v1_generated_AlloyDBAdmin_ListUsers_async @@ -5130,7 +5074,7 @@ export class AlloyDBAdminClient { IamProtos.google.iam.v1.GetIamPolicyRequest | null | undefined, {} | null | undefined > - ): Promise { + ): Promise<[IamProtos.google.iam.v1.Policy]> { return this.iamClient.getIamPolicy(request, options, callback); } @@ -5151,8 +5095,7 @@ export class AlloyDBAdminClient { * @param {string[]} request.permissions * The set of permissions to check for the `resource`. Permissions with * wildcards (such as '*' or 'storage.*') are not allowed. For more - * information see - * [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). + * information see {@link https://cloud.google.com/iam/docs/overview#permissions | IAM Overview }. * @param {Object} [options] * Optional parameters. You can override the default settings for this call, e.g, timeout, * retries, paginations, etc. See {@link https://googleapis.github.io/gax-nodejs/interfaces/CallOptions.html | gax.CallOptions} for the details. @@ -5178,7 +5121,7 @@ export class AlloyDBAdminClient { IamProtos.google.iam.v1.SetIamPolicyRequest | null | undefined, {} | null | undefined > - ): Promise { + ): Promise<[IamProtos.google.iam.v1.Policy]> { return this.iamClient.setIamPolicy(request, options, callback); } @@ -5199,8 +5142,7 @@ export class AlloyDBAdminClient { * @param {string[]} request.permissions * The set of permissions to check for the `resource`. Permissions with * wildcards (such as '*' or 'storage.*') are not allowed. For more - * information see - * [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). + * information see {@link https://cloud.google.com/iam/docs/overview#permissions | IAM Overview }. * @param {Object} [options] * Optional parameters. You can override the default settings for this call, e.g, timeout, * retries, paginations, etc. See {@link https://googleapis.github.io/gax-nodejs/interfaces/CallOptions.html | gax.CallOptions} for the details. @@ -5227,7 +5169,7 @@ export class AlloyDBAdminClient { IamProtos.google.iam.v1.TestIamPermissionsRequest | null | undefined, {} | null | undefined > - ): Promise { + ): Promise<[IamProtos.google.iam.v1.TestIamPermissionsResponse]> { return this.iamClient.testIamPermissions(request, options, callback); } @@ -5242,8 +5184,7 @@ export class AlloyDBAdminClient { * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html | CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing {@link google.cloud.location.Location | Location}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example * ``` @@ -5289,12 +5230,11 @@ export class AlloyDBAdminClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing * {@link google.cloud.location.Location | Location}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example * ``` diff --git a/packages/google-cloud-alloydb/src/v1alpha/alloy_d_b_admin_client.ts b/packages/google-cloud-alloydb/src/v1alpha/alloy_d_b_admin_client.ts index e1b9417f5e4..229a637be04 100644 --- a/packages/google-cloud-alloydb/src/v1alpha/alloy_d_b_admin_client.ts +++ b/packages/google-cloud-alloydb/src/v1alpha/alloy_d_b_admin_client.ts @@ -671,9 +671,8 @@ export class AlloyDBAdminClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.alloydb.v1alpha.Cluster | Cluster}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.alloydb.v1alpha.Cluster|Cluster}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1alpha/alloy_d_b_admin.get_cluster.js * region_tag:alloydb_v1alpha_generated_AlloyDBAdmin_GetCluster_async @@ -759,9 +758,8 @@ export class AlloyDBAdminClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.alloydb.v1alpha.Instance | Instance}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.alloydb.v1alpha.Instance|Instance}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1alpha/alloy_d_b_admin.get_instance.js * region_tag:alloydb_v1alpha_generated_AlloyDBAdmin_GetInstance_async @@ -850,9 +848,8 @@ export class AlloyDBAdminClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.alloydb.v1alpha.Backup | Backup}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.alloydb.v1alpha.Backup|Backup}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1alpha/alloy_d_b_admin.get_backup.js * region_tag:alloydb_v1alpha_generated_AlloyDBAdmin_GetBackup_async @@ -968,9 +965,8 @@ export class AlloyDBAdminClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.alloydb.v1alpha.GenerateClientCertificateResponse | GenerateClientCertificateResponse}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.alloydb.v1alpha.GenerateClientCertificateResponse|GenerateClientCertificateResponse}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1alpha/alloy_d_b_admin.generate_client_certificate.js * region_tag:alloydb_v1alpha_generated_AlloyDBAdmin_GenerateClientCertificate_async @@ -1084,9 +1080,8 @@ export class AlloyDBAdminClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.alloydb.v1alpha.ConnectionInfo | ConnectionInfo}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.alloydb.v1alpha.ConnectionInfo|ConnectionInfo}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1alpha/alloy_d_b_admin.get_connection_info.js * region_tag:alloydb_v1alpha_generated_AlloyDBAdmin_GetConnectionInfo_async @@ -1176,9 +1171,8 @@ export class AlloyDBAdminClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.alloydb.v1alpha.User | User}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.alloydb.v1alpha.User|User}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1alpha/alloy_d_b_admin.get_user.js * region_tag:alloydb_v1alpha_generated_AlloyDBAdmin_GetUser_async @@ -1282,9 +1276,8 @@ export class AlloyDBAdminClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.alloydb.v1alpha.User | User}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.alloydb.v1alpha.User|User}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1alpha/alloy_d_b_admin.create_user.js * region_tag:alloydb_v1alpha_generated_AlloyDBAdmin_CreateUser_async @@ -1392,9 +1385,8 @@ export class AlloyDBAdminClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.alloydb.v1alpha.User | User}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.alloydb.v1alpha.User|User}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1alpha/alloy_d_b_admin.update_user.js * region_tag:alloydb_v1alpha_generated_AlloyDBAdmin_UpdateUser_async @@ -1495,9 +1487,8 @@ export class AlloyDBAdminClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.protobuf.Empty | Empty}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.protobuf.Empty|Empty}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1alpha/alloy_d_b_admin.delete_user.js * region_tag:alloydb_v1alpha_generated_AlloyDBAdmin_DeleteUser_async @@ -1607,8 +1598,7 @@ export class AlloyDBAdminClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1alpha/alloy_d_b_admin.create_cluster.js * region_tag:alloydb_v1alpha_generated_AlloyDBAdmin_CreateCluster_async @@ -1703,8 +1693,7 @@ export class AlloyDBAdminClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1alpha/alloy_d_b_admin.create_cluster.js * region_tag:alloydb_v1alpha_generated_AlloyDBAdmin_CreateCluster_async @@ -1772,8 +1761,7 @@ export class AlloyDBAdminClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1alpha/alloy_d_b_admin.update_cluster.js * region_tag:alloydb_v1alpha_generated_AlloyDBAdmin_UpdateCluster_async @@ -1868,8 +1856,7 @@ export class AlloyDBAdminClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1alpha/alloy_d_b_admin.update_cluster.js * region_tag:alloydb_v1alpha_generated_AlloyDBAdmin_UpdateCluster_async @@ -1934,8 +1921,7 @@ export class AlloyDBAdminClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1alpha/alloy_d_b_admin.delete_cluster.js * region_tag:alloydb_v1alpha_generated_AlloyDBAdmin_DeleteCluster_async @@ -2030,8 +2016,7 @@ export class AlloyDBAdminClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1alpha/alloy_d_b_admin.delete_cluster.js * region_tag:alloydb_v1alpha_generated_AlloyDBAdmin_DeleteCluster_async @@ -2097,8 +2082,7 @@ export class AlloyDBAdminClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1alpha/alloy_d_b_admin.promote_cluster.js * region_tag:alloydb_v1alpha_generated_AlloyDBAdmin_PromoteCluster_async @@ -2193,8 +2177,7 @@ export class AlloyDBAdminClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1alpha/alloy_d_b_admin.promote_cluster.js * region_tag:alloydb_v1alpha_generated_AlloyDBAdmin_PromoteCluster_async @@ -2265,8 +2248,7 @@ export class AlloyDBAdminClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1alpha/alloy_d_b_admin.restore_cluster.js * region_tag:alloydb_v1alpha_generated_AlloyDBAdmin_RestoreCluster_async @@ -2361,8 +2343,7 @@ export class AlloyDBAdminClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1alpha/alloy_d_b_admin.restore_cluster.js * region_tag:alloydb_v1alpha_generated_AlloyDBAdmin_RestoreCluster_async @@ -2427,8 +2408,7 @@ export class AlloyDBAdminClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1alpha/alloy_d_b_admin.create_secondary_cluster.js * region_tag:alloydb_v1alpha_generated_AlloyDBAdmin_CreateSecondaryCluster_async @@ -2527,8 +2507,7 @@ export class AlloyDBAdminClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1alpha/alloy_d_b_admin.create_secondary_cluster.js * region_tag:alloydb_v1alpha_generated_AlloyDBAdmin_CreateSecondaryCluster_async @@ -2592,8 +2571,7 @@ export class AlloyDBAdminClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1alpha/alloy_d_b_admin.create_instance.js * region_tag:alloydb_v1alpha_generated_AlloyDBAdmin_CreateInstance_async @@ -2688,8 +2666,7 @@ export class AlloyDBAdminClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1alpha/alloy_d_b_admin.create_instance.js * region_tag:alloydb_v1alpha_generated_AlloyDBAdmin_CreateInstance_async @@ -2753,8 +2730,7 @@ export class AlloyDBAdminClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1alpha/alloy_d_b_admin.create_secondary_instance.js * region_tag:alloydb_v1alpha_generated_AlloyDBAdmin_CreateSecondaryInstance_async @@ -2853,8 +2829,7 @@ export class AlloyDBAdminClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1alpha/alloy_d_b_admin.create_secondary_instance.js * region_tag:alloydb_v1alpha_generated_AlloyDBAdmin_CreateSecondaryInstance_async @@ -2920,8 +2895,7 @@ export class AlloyDBAdminClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1alpha/alloy_d_b_admin.batch_create_instances.js * region_tag:alloydb_v1alpha_generated_AlloyDBAdmin_BatchCreateInstances_async @@ -3016,8 +2990,7 @@ export class AlloyDBAdminClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1alpha/alloy_d_b_admin.batch_create_instances.js * region_tag:alloydb_v1alpha_generated_AlloyDBAdmin_BatchCreateInstances_async @@ -3085,8 +3058,7 @@ export class AlloyDBAdminClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1alpha/alloy_d_b_admin.update_instance.js * region_tag:alloydb_v1alpha_generated_AlloyDBAdmin_UpdateInstance_async @@ -3181,8 +3153,7 @@ export class AlloyDBAdminClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1alpha/alloy_d_b_admin.update_instance.js * region_tag:alloydb_v1alpha_generated_AlloyDBAdmin_UpdateInstance_async @@ -3245,8 +3216,7 @@ export class AlloyDBAdminClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1alpha/alloy_d_b_admin.delete_instance.js * region_tag:alloydb_v1alpha_generated_AlloyDBAdmin_DeleteInstance_async @@ -3341,8 +3311,7 @@ export class AlloyDBAdminClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1alpha/alloy_d_b_admin.delete_instance.js * region_tag:alloydb_v1alpha_generated_AlloyDBAdmin_DeleteInstance_async @@ -3403,8 +3372,7 @@ export class AlloyDBAdminClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1alpha/alloy_d_b_admin.failover_instance.js * region_tag:alloydb_v1alpha_generated_AlloyDBAdmin_FailoverInstance_async @@ -3499,8 +3467,7 @@ export class AlloyDBAdminClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1alpha/alloy_d_b_admin.failover_instance.js * region_tag:alloydb_v1alpha_generated_AlloyDBAdmin_FailoverInstance_async @@ -3563,8 +3530,7 @@ export class AlloyDBAdminClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1alpha/alloy_d_b_admin.inject_fault.js * region_tag:alloydb_v1alpha_generated_AlloyDBAdmin_InjectFault_async @@ -3659,8 +3625,7 @@ export class AlloyDBAdminClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1alpha/alloy_d_b_admin.inject_fault.js * region_tag:alloydb_v1alpha_generated_AlloyDBAdmin_InjectFault_async @@ -3720,8 +3685,7 @@ export class AlloyDBAdminClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1alpha/alloy_d_b_admin.restart_instance.js * region_tag:alloydb_v1alpha_generated_AlloyDBAdmin_RestartInstance_async @@ -3816,8 +3780,7 @@ export class AlloyDBAdminClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1alpha/alloy_d_b_admin.restart_instance.js * region_tag:alloydb_v1alpha_generated_AlloyDBAdmin_RestartInstance_async @@ -3879,8 +3842,7 @@ export class AlloyDBAdminClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1alpha/alloy_d_b_admin.create_backup.js * region_tag:alloydb_v1alpha_generated_AlloyDBAdmin_CreateBackup_async @@ -3975,8 +3937,7 @@ export class AlloyDBAdminClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1alpha/alloy_d_b_admin.create_backup.js * region_tag:alloydb_v1alpha_generated_AlloyDBAdmin_CreateBackup_async @@ -4043,8 +4004,7 @@ export class AlloyDBAdminClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1alpha/alloy_d_b_admin.update_backup.js * region_tag:alloydb_v1alpha_generated_AlloyDBAdmin_UpdateBackup_async @@ -4139,8 +4099,7 @@ export class AlloyDBAdminClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1alpha/alloy_d_b_admin.update_backup.js * region_tag:alloydb_v1alpha_generated_AlloyDBAdmin_UpdateBackup_async @@ -4203,8 +4162,7 @@ export class AlloyDBAdminClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1alpha/alloy_d_b_admin.delete_backup.js * region_tag:alloydb_v1alpha_generated_AlloyDBAdmin_DeleteBackup_async @@ -4299,8 +4257,7 @@ export class AlloyDBAdminClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1alpha/alloy_d_b_admin.delete_backup.js * region_tag:alloydb_v1alpha_generated_AlloyDBAdmin_DeleteBackup_async @@ -4350,14 +4307,13 @@ export class AlloyDBAdminClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.cloud.alloydb.v1alpha.Cluster | Cluster}. + * The first element of the array is Array of {@link protos.google.cloud.alloydb.v1alpha.Cluster|Cluster}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `listClustersAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listClusters( @@ -4456,13 +4412,12 @@ export class AlloyDBAdminClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.cloud.alloydb.v1alpha.Cluster | Cluster} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.alloydb.v1alpha.Cluster|Cluster} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listClustersAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listClustersStream( @@ -4510,12 +4465,11 @@ export class AlloyDBAdminClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.cloud.alloydb.v1alpha.Cluster | Cluster}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.alloydb.v1alpha.Cluster|Cluster}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1alpha/alloy_d_b_admin.list_clusters.js * region_tag:alloydb_v1alpha_generated_AlloyDBAdmin_ListClusters_async @@ -4565,14 +4519,13 @@ export class AlloyDBAdminClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.cloud.alloydb.v1alpha.Instance | Instance}. + * The first element of the array is Array of {@link protos.google.cloud.alloydb.v1alpha.Instance|Instance}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `listInstancesAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listInstances( @@ -4673,13 +4626,12 @@ export class AlloyDBAdminClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.cloud.alloydb.v1alpha.Instance | Instance} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.alloydb.v1alpha.Instance|Instance} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listInstancesAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listInstancesStream( @@ -4729,12 +4681,11 @@ export class AlloyDBAdminClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.cloud.alloydb.v1alpha.Instance | Instance}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.alloydb.v1alpha.Instance|Instance}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1alpha/alloy_d_b_admin.list_instances.js * region_tag:alloydb_v1alpha_generated_AlloyDBAdmin_ListInstances_async @@ -4779,14 +4730,13 @@ export class AlloyDBAdminClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.cloud.alloydb.v1alpha.Backup | Backup}. + * The first element of the array is Array of {@link protos.google.cloud.alloydb.v1alpha.Backup|Backup}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `listBackupsAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listBackups( @@ -4882,13 +4832,12 @@ export class AlloyDBAdminClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.cloud.alloydb.v1alpha.Backup | Backup} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.alloydb.v1alpha.Backup|Backup} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listBackupsAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listBackupsStream( @@ -4933,12 +4882,11 @@ export class AlloyDBAdminClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.cloud.alloydb.v1alpha.Backup | Backup}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.alloydb.v1alpha.Backup|Backup}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1alpha/alloy_d_b_admin.list_backups.js * region_tag:alloydb_v1alpha_generated_AlloyDBAdmin_ListBackups_async @@ -4985,14 +4933,13 @@ export class AlloyDBAdminClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.cloud.alloydb.v1alpha.SupportedDatabaseFlag | SupportedDatabaseFlag}. + * The first element of the array is Array of {@link protos.google.cloud.alloydb.v1alpha.SupportedDatabaseFlag|SupportedDatabaseFlag}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `listSupportedDatabaseFlagsAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listSupportedDatabaseFlags( @@ -5094,13 +5041,12 @@ export class AlloyDBAdminClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.cloud.alloydb.v1alpha.SupportedDatabaseFlag | SupportedDatabaseFlag} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.alloydb.v1alpha.SupportedDatabaseFlag|SupportedDatabaseFlag} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listSupportedDatabaseFlagsAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listSupportedDatabaseFlagsStream( @@ -5147,12 +5093,11 @@ export class AlloyDBAdminClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.cloud.alloydb.v1alpha.SupportedDatabaseFlag | SupportedDatabaseFlag}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.alloydb.v1alpha.SupportedDatabaseFlag|SupportedDatabaseFlag}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1alpha/alloy_d_b_admin.list_supported_database_flags.js * region_tag:alloydb_v1alpha_generated_AlloyDBAdmin_ListSupportedDatabaseFlags_async @@ -5197,14 +5142,13 @@ export class AlloyDBAdminClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.cloud.alloydb.v1alpha.User | User}. + * The first element of the array is Array of {@link protos.google.cloud.alloydb.v1alpha.User|User}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `listUsersAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listUsers( @@ -5294,13 +5238,12 @@ export class AlloyDBAdminClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.cloud.alloydb.v1alpha.User | User} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.alloydb.v1alpha.User|User} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listUsersAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listUsersStream( @@ -5345,12 +5288,11 @@ export class AlloyDBAdminClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.cloud.alloydb.v1alpha.User | User}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.alloydb.v1alpha.User|User}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1alpha/alloy_d_b_admin.list_users.js * region_tag:alloydb_v1alpha_generated_AlloyDBAdmin_ListUsers_async @@ -5415,7 +5357,7 @@ export class AlloyDBAdminClient { IamProtos.google.iam.v1.GetIamPolicyRequest | null | undefined, {} | null | undefined > - ): Promise { + ): Promise<[IamProtos.google.iam.v1.Policy]> { return this.iamClient.getIamPolicy(request, options, callback); } @@ -5436,8 +5378,7 @@ export class AlloyDBAdminClient { * @param {string[]} request.permissions * The set of permissions to check for the `resource`. Permissions with * wildcards (such as '*' or 'storage.*') are not allowed. For more - * information see - * [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). + * information see {@link https://cloud.google.com/iam/docs/overview#permissions | IAM Overview }. * @param {Object} [options] * Optional parameters. You can override the default settings for this call, e.g, timeout, * retries, paginations, etc. See {@link https://googleapis.github.io/gax-nodejs/interfaces/CallOptions.html | gax.CallOptions} for the details. @@ -5463,7 +5404,7 @@ export class AlloyDBAdminClient { IamProtos.google.iam.v1.SetIamPolicyRequest | null | undefined, {} | null | undefined > - ): Promise { + ): Promise<[IamProtos.google.iam.v1.Policy]> { return this.iamClient.setIamPolicy(request, options, callback); } @@ -5484,8 +5425,7 @@ export class AlloyDBAdminClient { * @param {string[]} request.permissions * The set of permissions to check for the `resource`. Permissions with * wildcards (such as '*' or 'storage.*') are not allowed. For more - * information see - * [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). + * information see {@link https://cloud.google.com/iam/docs/overview#permissions | IAM Overview }. * @param {Object} [options] * Optional parameters. You can override the default settings for this call, e.g, timeout, * retries, paginations, etc. See {@link https://googleapis.github.io/gax-nodejs/interfaces/CallOptions.html | gax.CallOptions} for the details. @@ -5512,7 +5452,7 @@ export class AlloyDBAdminClient { IamProtos.google.iam.v1.TestIamPermissionsRequest | null | undefined, {} | null | undefined > - ): Promise { + ): Promise<[IamProtos.google.iam.v1.TestIamPermissionsResponse]> { return this.iamClient.testIamPermissions(request, options, callback); } @@ -5527,8 +5467,7 @@ export class AlloyDBAdminClient { * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html | CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing {@link google.cloud.location.Location | Location}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example * ``` @@ -5574,12 +5513,11 @@ export class AlloyDBAdminClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing * {@link google.cloud.location.Location | Location}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example * ``` diff --git a/packages/google-cloud-alloydb/src/v1beta/alloy_d_b_admin_client.ts b/packages/google-cloud-alloydb/src/v1beta/alloy_d_b_admin_client.ts index 415bdaed813..3a430e26b73 100644 --- a/packages/google-cloud-alloydb/src/v1beta/alloy_d_b_admin_client.ts +++ b/packages/google-cloud-alloydb/src/v1beta/alloy_d_b_admin_client.ts @@ -670,9 +670,8 @@ export class AlloyDBAdminClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.alloydb.v1beta.Cluster | Cluster}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.alloydb.v1beta.Cluster|Cluster}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1beta/alloy_d_b_admin.get_cluster.js * region_tag:alloydb_v1beta_generated_AlloyDBAdmin_GetCluster_async @@ -758,9 +757,8 @@ export class AlloyDBAdminClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.alloydb.v1beta.Instance | Instance}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.alloydb.v1beta.Instance|Instance}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1beta/alloy_d_b_admin.get_instance.js * region_tag:alloydb_v1beta_generated_AlloyDBAdmin_GetInstance_async @@ -843,9 +841,8 @@ export class AlloyDBAdminClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.alloydb.v1beta.Backup | Backup}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.alloydb.v1beta.Backup|Backup}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1beta/alloy_d_b_admin.get_backup.js * region_tag:alloydb_v1beta_generated_AlloyDBAdmin_GetBackup_async @@ -957,9 +954,8 @@ export class AlloyDBAdminClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.alloydb.v1beta.GenerateClientCertificateResponse | GenerateClientCertificateResponse}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.alloydb.v1beta.GenerateClientCertificateResponse|GenerateClientCertificateResponse}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1beta/alloy_d_b_admin.generate_client_certificate.js * region_tag:alloydb_v1beta_generated_AlloyDBAdmin_GenerateClientCertificate_async @@ -1073,9 +1069,8 @@ export class AlloyDBAdminClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.alloydb.v1beta.ConnectionInfo | ConnectionInfo}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.alloydb.v1beta.ConnectionInfo|ConnectionInfo}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1beta/alloy_d_b_admin.get_connection_info.js * region_tag:alloydb_v1beta_generated_AlloyDBAdmin_GetConnectionInfo_async @@ -1165,9 +1160,8 @@ export class AlloyDBAdminClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.alloydb.v1beta.User | User}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.alloydb.v1beta.User|User}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1beta/alloy_d_b_admin.get_user.js * region_tag:alloydb_v1beta_generated_AlloyDBAdmin_GetUser_async @@ -1269,9 +1263,8 @@ export class AlloyDBAdminClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.alloydb.v1beta.User | User}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.alloydb.v1beta.User|User}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1beta/alloy_d_b_admin.create_user.js * region_tag:alloydb_v1beta_generated_AlloyDBAdmin_CreateUser_async @@ -1379,9 +1372,8 @@ export class AlloyDBAdminClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.alloydb.v1beta.User | User}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.alloydb.v1beta.User|User}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1beta/alloy_d_b_admin.update_user.js * region_tag:alloydb_v1beta_generated_AlloyDBAdmin_UpdateUser_async @@ -1482,9 +1474,8 @@ export class AlloyDBAdminClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.protobuf.Empty | Empty}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.protobuf.Empty|Empty}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1beta/alloy_d_b_admin.delete_user.js * region_tag:alloydb_v1beta_generated_AlloyDBAdmin_DeleteUser_async @@ -1594,8 +1585,7 @@ export class AlloyDBAdminClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1beta/alloy_d_b_admin.create_cluster.js * region_tag:alloydb_v1beta_generated_AlloyDBAdmin_CreateCluster_async @@ -1690,8 +1680,7 @@ export class AlloyDBAdminClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1beta/alloy_d_b_admin.create_cluster.js * region_tag:alloydb_v1beta_generated_AlloyDBAdmin_CreateCluster_async @@ -1759,8 +1748,7 @@ export class AlloyDBAdminClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1beta/alloy_d_b_admin.update_cluster.js * region_tag:alloydb_v1beta_generated_AlloyDBAdmin_UpdateCluster_async @@ -1855,8 +1843,7 @@ export class AlloyDBAdminClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1beta/alloy_d_b_admin.update_cluster.js * region_tag:alloydb_v1beta_generated_AlloyDBAdmin_UpdateCluster_async @@ -1921,8 +1908,7 @@ export class AlloyDBAdminClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1beta/alloy_d_b_admin.delete_cluster.js * region_tag:alloydb_v1beta_generated_AlloyDBAdmin_DeleteCluster_async @@ -2017,8 +2003,7 @@ export class AlloyDBAdminClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1beta/alloy_d_b_admin.delete_cluster.js * region_tag:alloydb_v1beta_generated_AlloyDBAdmin_DeleteCluster_async @@ -2084,8 +2069,7 @@ export class AlloyDBAdminClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1beta/alloy_d_b_admin.promote_cluster.js * region_tag:alloydb_v1beta_generated_AlloyDBAdmin_PromoteCluster_async @@ -2180,8 +2164,7 @@ export class AlloyDBAdminClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1beta/alloy_d_b_admin.promote_cluster.js * region_tag:alloydb_v1beta_generated_AlloyDBAdmin_PromoteCluster_async @@ -2252,8 +2235,7 @@ export class AlloyDBAdminClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1beta/alloy_d_b_admin.restore_cluster.js * region_tag:alloydb_v1beta_generated_AlloyDBAdmin_RestoreCluster_async @@ -2348,8 +2330,7 @@ export class AlloyDBAdminClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1beta/alloy_d_b_admin.restore_cluster.js * region_tag:alloydb_v1beta_generated_AlloyDBAdmin_RestoreCluster_async @@ -2414,8 +2395,7 @@ export class AlloyDBAdminClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1beta/alloy_d_b_admin.create_secondary_cluster.js * region_tag:alloydb_v1beta_generated_AlloyDBAdmin_CreateSecondaryCluster_async @@ -2514,8 +2494,7 @@ export class AlloyDBAdminClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1beta/alloy_d_b_admin.create_secondary_cluster.js * region_tag:alloydb_v1beta_generated_AlloyDBAdmin_CreateSecondaryCluster_async @@ -2579,8 +2558,7 @@ export class AlloyDBAdminClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1beta/alloy_d_b_admin.create_instance.js * region_tag:alloydb_v1beta_generated_AlloyDBAdmin_CreateInstance_async @@ -2675,8 +2653,7 @@ export class AlloyDBAdminClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1beta/alloy_d_b_admin.create_instance.js * region_tag:alloydb_v1beta_generated_AlloyDBAdmin_CreateInstance_async @@ -2740,8 +2717,7 @@ export class AlloyDBAdminClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1beta/alloy_d_b_admin.create_secondary_instance.js * region_tag:alloydb_v1beta_generated_AlloyDBAdmin_CreateSecondaryInstance_async @@ -2840,8 +2816,7 @@ export class AlloyDBAdminClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1beta/alloy_d_b_admin.create_secondary_instance.js * region_tag:alloydb_v1beta_generated_AlloyDBAdmin_CreateSecondaryInstance_async @@ -2907,8 +2882,7 @@ export class AlloyDBAdminClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1beta/alloy_d_b_admin.batch_create_instances.js * region_tag:alloydb_v1beta_generated_AlloyDBAdmin_BatchCreateInstances_async @@ -3003,8 +2977,7 @@ export class AlloyDBAdminClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1beta/alloy_d_b_admin.batch_create_instances.js * region_tag:alloydb_v1beta_generated_AlloyDBAdmin_BatchCreateInstances_async @@ -3072,8 +3045,7 @@ export class AlloyDBAdminClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1beta/alloy_d_b_admin.update_instance.js * region_tag:alloydb_v1beta_generated_AlloyDBAdmin_UpdateInstance_async @@ -3168,8 +3140,7 @@ export class AlloyDBAdminClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1beta/alloy_d_b_admin.update_instance.js * region_tag:alloydb_v1beta_generated_AlloyDBAdmin_UpdateInstance_async @@ -3232,8 +3203,7 @@ export class AlloyDBAdminClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1beta/alloy_d_b_admin.delete_instance.js * region_tag:alloydb_v1beta_generated_AlloyDBAdmin_DeleteInstance_async @@ -3328,8 +3298,7 @@ export class AlloyDBAdminClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1beta/alloy_d_b_admin.delete_instance.js * region_tag:alloydb_v1beta_generated_AlloyDBAdmin_DeleteInstance_async @@ -3390,8 +3359,7 @@ export class AlloyDBAdminClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1beta/alloy_d_b_admin.failover_instance.js * region_tag:alloydb_v1beta_generated_AlloyDBAdmin_FailoverInstance_async @@ -3486,8 +3454,7 @@ export class AlloyDBAdminClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1beta/alloy_d_b_admin.failover_instance.js * region_tag:alloydb_v1beta_generated_AlloyDBAdmin_FailoverInstance_async @@ -3550,8 +3517,7 @@ export class AlloyDBAdminClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1beta/alloy_d_b_admin.inject_fault.js * region_tag:alloydb_v1beta_generated_AlloyDBAdmin_InjectFault_async @@ -3646,8 +3612,7 @@ export class AlloyDBAdminClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1beta/alloy_d_b_admin.inject_fault.js * region_tag:alloydb_v1beta_generated_AlloyDBAdmin_InjectFault_async @@ -3707,8 +3672,7 @@ export class AlloyDBAdminClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1beta/alloy_d_b_admin.restart_instance.js * region_tag:alloydb_v1beta_generated_AlloyDBAdmin_RestartInstance_async @@ -3803,8 +3767,7 @@ export class AlloyDBAdminClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1beta/alloy_d_b_admin.restart_instance.js * region_tag:alloydb_v1beta_generated_AlloyDBAdmin_RestartInstance_async @@ -3866,8 +3829,7 @@ export class AlloyDBAdminClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1beta/alloy_d_b_admin.create_backup.js * region_tag:alloydb_v1beta_generated_AlloyDBAdmin_CreateBackup_async @@ -3962,8 +3924,7 @@ export class AlloyDBAdminClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1beta/alloy_d_b_admin.create_backup.js * region_tag:alloydb_v1beta_generated_AlloyDBAdmin_CreateBackup_async @@ -4030,8 +3991,7 @@ export class AlloyDBAdminClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1beta/alloy_d_b_admin.update_backup.js * region_tag:alloydb_v1beta_generated_AlloyDBAdmin_UpdateBackup_async @@ -4126,8 +4086,7 @@ export class AlloyDBAdminClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1beta/alloy_d_b_admin.update_backup.js * region_tag:alloydb_v1beta_generated_AlloyDBAdmin_UpdateBackup_async @@ -4190,8 +4149,7 @@ export class AlloyDBAdminClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1beta/alloy_d_b_admin.delete_backup.js * region_tag:alloydb_v1beta_generated_AlloyDBAdmin_DeleteBackup_async @@ -4286,8 +4244,7 @@ export class AlloyDBAdminClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1beta/alloy_d_b_admin.delete_backup.js * region_tag:alloydb_v1beta_generated_AlloyDBAdmin_DeleteBackup_async @@ -4337,14 +4294,13 @@ export class AlloyDBAdminClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.cloud.alloydb.v1beta.Cluster | Cluster}. + * The first element of the array is Array of {@link protos.google.cloud.alloydb.v1beta.Cluster|Cluster}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `listClustersAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listClusters( @@ -4443,13 +4399,12 @@ export class AlloyDBAdminClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.cloud.alloydb.v1beta.Cluster | Cluster} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.alloydb.v1beta.Cluster|Cluster} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listClustersAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listClustersStream( @@ -4497,12 +4452,11 @@ export class AlloyDBAdminClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.cloud.alloydb.v1beta.Cluster | Cluster}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.alloydb.v1beta.Cluster|Cluster}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1beta/alloy_d_b_admin.list_clusters.js * region_tag:alloydb_v1beta_generated_AlloyDBAdmin_ListClusters_async @@ -4552,14 +4506,13 @@ export class AlloyDBAdminClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.cloud.alloydb.v1beta.Instance | Instance}. + * The first element of the array is Array of {@link protos.google.cloud.alloydb.v1beta.Instance|Instance}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `listInstancesAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listInstances( @@ -4660,13 +4613,12 @@ export class AlloyDBAdminClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.cloud.alloydb.v1beta.Instance | Instance} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.alloydb.v1beta.Instance|Instance} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listInstancesAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listInstancesStream( @@ -4716,12 +4668,11 @@ export class AlloyDBAdminClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.cloud.alloydb.v1beta.Instance | Instance}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.alloydb.v1beta.Instance|Instance}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1beta/alloy_d_b_admin.list_instances.js * region_tag:alloydb_v1beta_generated_AlloyDBAdmin_ListInstances_async @@ -4766,14 +4717,13 @@ export class AlloyDBAdminClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.cloud.alloydb.v1beta.Backup | Backup}. + * The first element of the array is Array of {@link protos.google.cloud.alloydb.v1beta.Backup|Backup}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `listBackupsAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listBackups( @@ -4869,13 +4819,12 @@ export class AlloyDBAdminClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.cloud.alloydb.v1beta.Backup | Backup} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.alloydb.v1beta.Backup|Backup} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listBackupsAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listBackupsStream( @@ -4920,12 +4869,11 @@ export class AlloyDBAdminClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.cloud.alloydb.v1beta.Backup | Backup}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.alloydb.v1beta.Backup|Backup}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1beta/alloy_d_b_admin.list_backups.js * region_tag:alloydb_v1beta_generated_AlloyDBAdmin_ListBackups_async @@ -4972,14 +4920,13 @@ export class AlloyDBAdminClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.cloud.alloydb.v1beta.SupportedDatabaseFlag | SupportedDatabaseFlag}. + * The first element of the array is Array of {@link protos.google.cloud.alloydb.v1beta.SupportedDatabaseFlag|SupportedDatabaseFlag}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `listSupportedDatabaseFlagsAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listSupportedDatabaseFlags( @@ -5081,13 +5028,12 @@ export class AlloyDBAdminClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.cloud.alloydb.v1beta.SupportedDatabaseFlag | SupportedDatabaseFlag} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.alloydb.v1beta.SupportedDatabaseFlag|SupportedDatabaseFlag} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listSupportedDatabaseFlagsAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listSupportedDatabaseFlagsStream( @@ -5134,12 +5080,11 @@ export class AlloyDBAdminClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.cloud.alloydb.v1beta.SupportedDatabaseFlag | SupportedDatabaseFlag}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.alloydb.v1beta.SupportedDatabaseFlag|SupportedDatabaseFlag}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1beta/alloy_d_b_admin.list_supported_database_flags.js * region_tag:alloydb_v1beta_generated_AlloyDBAdmin_ListSupportedDatabaseFlags_async @@ -5184,14 +5129,13 @@ export class AlloyDBAdminClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.cloud.alloydb.v1beta.User | User}. + * The first element of the array is Array of {@link protos.google.cloud.alloydb.v1beta.User|User}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `listUsersAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listUsers( @@ -5281,13 +5225,12 @@ export class AlloyDBAdminClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.cloud.alloydb.v1beta.User | User} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.alloydb.v1beta.User|User} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listUsersAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listUsersStream( @@ -5332,12 +5275,11 @@ export class AlloyDBAdminClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.cloud.alloydb.v1beta.User | User}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.alloydb.v1beta.User|User}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1beta/alloy_d_b_admin.list_users.js * region_tag:alloydb_v1beta_generated_AlloyDBAdmin_ListUsers_async @@ -5402,7 +5344,7 @@ export class AlloyDBAdminClient { IamProtos.google.iam.v1.GetIamPolicyRequest | null | undefined, {} | null | undefined > - ): Promise { + ): Promise<[IamProtos.google.iam.v1.Policy]> { return this.iamClient.getIamPolicy(request, options, callback); } @@ -5423,8 +5365,7 @@ export class AlloyDBAdminClient { * @param {string[]} request.permissions * The set of permissions to check for the `resource`. Permissions with * wildcards (such as '*' or 'storage.*') are not allowed. For more - * information see - * [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). + * information see {@link https://cloud.google.com/iam/docs/overview#permissions | IAM Overview }. * @param {Object} [options] * Optional parameters. You can override the default settings for this call, e.g, timeout, * retries, paginations, etc. See {@link https://googleapis.github.io/gax-nodejs/interfaces/CallOptions.html | gax.CallOptions} for the details. @@ -5450,7 +5391,7 @@ export class AlloyDBAdminClient { IamProtos.google.iam.v1.SetIamPolicyRequest | null | undefined, {} | null | undefined > - ): Promise { + ): Promise<[IamProtos.google.iam.v1.Policy]> { return this.iamClient.setIamPolicy(request, options, callback); } @@ -5471,8 +5412,7 @@ export class AlloyDBAdminClient { * @param {string[]} request.permissions * The set of permissions to check for the `resource`. Permissions with * wildcards (such as '*' or 'storage.*') are not allowed. For more - * information see - * [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). + * information see {@link https://cloud.google.com/iam/docs/overview#permissions | IAM Overview }. * @param {Object} [options] * Optional parameters. You can override the default settings for this call, e.g, timeout, * retries, paginations, etc. See {@link https://googleapis.github.io/gax-nodejs/interfaces/CallOptions.html | gax.CallOptions} for the details. @@ -5499,7 +5439,7 @@ export class AlloyDBAdminClient { IamProtos.google.iam.v1.TestIamPermissionsRequest | null | undefined, {} | null | undefined > - ): Promise { + ): Promise<[IamProtos.google.iam.v1.TestIamPermissionsResponse]> { return this.iamClient.testIamPermissions(request, options, callback); } @@ -5514,8 +5454,7 @@ export class AlloyDBAdminClient { * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html | CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing {@link google.cloud.location.Location | Location}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example * ``` @@ -5561,12 +5500,11 @@ export class AlloyDBAdminClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing * {@link google.cloud.location.Location | Location}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example * ``` diff --git a/packages/google-cloud-apigateway/README.md b/packages/google-cloud-apigateway/README.md index 03e3a5d58c6..fd8f8248169 100644 --- a/packages/google-cloud-apigateway/README.md +++ b/packages/google-cloud-apigateway/README.md @@ -2,7 +2,7 @@ [//]: # "To regenerate it, use `python -m synthtool`." Google Cloud Platform logo -# [API Gateway: Node.js Client](https://github.com/googleapis/google-cloud-node) +# [API Gateway: Node.js Client](https://github.com/googleapis/google-cloud-node/tree/main/packages/google-cloud-apigateway) [![release level](https://img.shields.io/badge/release%20level-stable-brightgreen.svg?style=flat)](https://cloud.google.com/terms/launch-stages) [![npm version](https://img.shields.io/npm/v/@google-cloud/api-gateway.svg)](https://www.npmjs.org/package/@google-cloud/api-gateway) @@ -79,27 +79,26 @@ listApis(); ## Samples -Samples are in the [`samples/`](https://github.com/googleapis/google-cloud-node/tree/main/samples) directory. Each sample's `README.md` has instructions for running its sample. +Samples are in the [`samples/`](https://github.com/googleapis/google-cloud-node/tree/main/packages/google-cloud-apigateway/samples) directory. Each sample's `README.md` has instructions for running its sample. | Sample | Source Code | Try it | | --------------------------- | --------------------------------- | ------ | -| Api_gateway_service.create_api | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-apigateway/samples/generated/v1/api_gateway_service.create_api.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-apigateway/samples/generated/v1/api_gateway_service.create_api.js,samples/README.md) | -| Api_gateway_service.create_api_config | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-apigateway/samples/generated/v1/api_gateway_service.create_api_config.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-apigateway/samples/generated/v1/api_gateway_service.create_api_config.js,samples/README.md) | -| Api_gateway_service.create_gateway | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-apigateway/samples/generated/v1/api_gateway_service.create_gateway.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-apigateway/samples/generated/v1/api_gateway_service.create_gateway.js,samples/README.md) | -| Api_gateway_service.delete_api | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-apigateway/samples/generated/v1/api_gateway_service.delete_api.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-apigateway/samples/generated/v1/api_gateway_service.delete_api.js,samples/README.md) | -| Api_gateway_service.delete_api_config | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-apigateway/samples/generated/v1/api_gateway_service.delete_api_config.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-apigateway/samples/generated/v1/api_gateway_service.delete_api_config.js,samples/README.md) | -| Api_gateway_service.delete_gateway | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-apigateway/samples/generated/v1/api_gateway_service.delete_gateway.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-apigateway/samples/generated/v1/api_gateway_service.delete_gateway.js,samples/README.md) | -| Api_gateway_service.get_api | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-apigateway/samples/generated/v1/api_gateway_service.get_api.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-apigateway/samples/generated/v1/api_gateway_service.get_api.js,samples/README.md) | -| Api_gateway_service.get_api_config | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-apigateway/samples/generated/v1/api_gateway_service.get_api_config.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-apigateway/samples/generated/v1/api_gateway_service.get_api_config.js,samples/README.md) | -| Api_gateway_service.get_gateway | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-apigateway/samples/generated/v1/api_gateway_service.get_gateway.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-apigateway/samples/generated/v1/api_gateway_service.get_gateway.js,samples/README.md) | -| Api_gateway_service.list_api_configs | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-apigateway/samples/generated/v1/api_gateway_service.list_api_configs.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-apigateway/samples/generated/v1/api_gateway_service.list_api_configs.js,samples/README.md) | -| Api_gateway_service.list_apis | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-apigateway/samples/generated/v1/api_gateway_service.list_apis.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-apigateway/samples/generated/v1/api_gateway_service.list_apis.js,samples/README.md) | -| Api_gateway_service.list_gateways | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-apigateway/samples/generated/v1/api_gateway_service.list_gateways.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-apigateway/samples/generated/v1/api_gateway_service.list_gateways.js,samples/README.md) | -| Api_gateway_service.update_api | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-apigateway/samples/generated/v1/api_gateway_service.update_api.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-apigateway/samples/generated/v1/api_gateway_service.update_api.js,samples/README.md) | -| Api_gateway_service.update_api_config | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-apigateway/samples/generated/v1/api_gateway_service.update_api_config.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-apigateway/samples/generated/v1/api_gateway_service.update_api_config.js,samples/README.md) | -| Api_gateway_service.update_gateway | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-apigateway/samples/generated/v1/api_gateway_service.update_gateway.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-apigateway/samples/generated/v1/api_gateway_service.update_gateway.js,samples/README.md) | -| Quickstart | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-apigateway/samples/quickstart.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-apigateway/samples/quickstart.js,samples/README.md) | -| Quickstart.test | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-apigateway/samples/test/quickstart.test.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-apigateway/samples/test/quickstart.test.js,samples/README.md) | +| Api_gateway_service.create_api | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-apigateway/samples/generated/v1/api_gateway_service.create_api.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-apigateway/samples/generated/v1/api_gateway_service.create_api.js,packages/google-cloud-apigateway/samples/README.md) | +| Api_gateway_service.create_api_config | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-apigateway/samples/generated/v1/api_gateway_service.create_api_config.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-apigateway/samples/generated/v1/api_gateway_service.create_api_config.js,packages/google-cloud-apigateway/samples/README.md) | +| Api_gateway_service.create_gateway | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-apigateway/samples/generated/v1/api_gateway_service.create_gateway.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-apigateway/samples/generated/v1/api_gateway_service.create_gateway.js,packages/google-cloud-apigateway/samples/README.md) | +| Api_gateway_service.delete_api | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-apigateway/samples/generated/v1/api_gateway_service.delete_api.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-apigateway/samples/generated/v1/api_gateway_service.delete_api.js,packages/google-cloud-apigateway/samples/README.md) | +| Api_gateway_service.delete_api_config | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-apigateway/samples/generated/v1/api_gateway_service.delete_api_config.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-apigateway/samples/generated/v1/api_gateway_service.delete_api_config.js,packages/google-cloud-apigateway/samples/README.md) | +| Api_gateway_service.delete_gateway | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-apigateway/samples/generated/v1/api_gateway_service.delete_gateway.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-apigateway/samples/generated/v1/api_gateway_service.delete_gateway.js,packages/google-cloud-apigateway/samples/README.md) | +| Api_gateway_service.get_api | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-apigateway/samples/generated/v1/api_gateway_service.get_api.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-apigateway/samples/generated/v1/api_gateway_service.get_api.js,packages/google-cloud-apigateway/samples/README.md) | +| Api_gateway_service.get_api_config | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-apigateway/samples/generated/v1/api_gateway_service.get_api_config.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-apigateway/samples/generated/v1/api_gateway_service.get_api_config.js,packages/google-cloud-apigateway/samples/README.md) | +| Api_gateway_service.get_gateway | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-apigateway/samples/generated/v1/api_gateway_service.get_gateway.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-apigateway/samples/generated/v1/api_gateway_service.get_gateway.js,packages/google-cloud-apigateway/samples/README.md) | +| Api_gateway_service.list_api_configs | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-apigateway/samples/generated/v1/api_gateway_service.list_api_configs.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-apigateway/samples/generated/v1/api_gateway_service.list_api_configs.js,packages/google-cloud-apigateway/samples/README.md) | +| Api_gateway_service.list_apis | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-apigateway/samples/generated/v1/api_gateway_service.list_apis.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-apigateway/samples/generated/v1/api_gateway_service.list_apis.js,packages/google-cloud-apigateway/samples/README.md) | +| Api_gateway_service.list_gateways | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-apigateway/samples/generated/v1/api_gateway_service.list_gateways.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-apigateway/samples/generated/v1/api_gateway_service.list_gateways.js,packages/google-cloud-apigateway/samples/README.md) | +| Api_gateway_service.update_api | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-apigateway/samples/generated/v1/api_gateway_service.update_api.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-apigateway/samples/generated/v1/api_gateway_service.update_api.js,packages/google-cloud-apigateway/samples/README.md) | +| Api_gateway_service.update_api_config | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-apigateway/samples/generated/v1/api_gateway_service.update_api_config.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-apigateway/samples/generated/v1/api_gateway_service.update_api_config.js,packages/google-cloud-apigateway/samples/README.md) | +| Api_gateway_service.update_gateway | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-apigateway/samples/generated/v1/api_gateway_service.update_gateway.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-apigateway/samples/generated/v1/api_gateway_service.update_gateway.js,packages/google-cloud-apigateway/samples/README.md) | +| Quickstart | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-apigateway/samples/quickstart.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-apigateway/samples/quickstart.js,packages/google-cloud-apigateway/samples/README.md) | diff --git a/packages/google-cloud-apigateway/package.json b/packages/google-cloud-apigateway/package.json index 65fc30a1971..96e0622f886 100644 --- a/packages/google-cloud-apigateway/package.json +++ b/packages/google-cloud-apigateway/package.json @@ -45,14 +45,15 @@ "test": "c8 mocha build/test" }, "dependencies": { - "google-gax": "^3.5.8" + "google-gax": "^4.0.3" }, "devDependencies": { "@types/mocha": "^9.0.0", - "@types/node": "^18.0.0", + "@types/node": "^20.4.5", "@types/sinon": "^10.0.0", "c8": "^7.3.5", - "gts": "^3.1.0", + "gapic-tools": "^0.1.8", + "gts": "^5.0.0", "jsdoc": "^4.0.0", "jsdoc-fresh": "^2.0.0", "jsdoc-region-tag": "^2.0.0", @@ -63,12 +64,12 @@ "pack-n-play": "^1.0.0-2", "sinon": "^15.0.0", "ts-loader": "^9.0.0", - "typescript": "^4.6.4", + "typescript": "^5.1.6", "webpack": "^5.9.0", "webpack-cli": "^5.0.0" }, "engines": { - "node": ">=12.0.0" + "node": ">=14.0.0" }, "homepage": "https://github.com/googleapis/google-cloud-node/tree/main/packages/google-cloud-apigateway" } diff --git a/packages/google-cloud-apigateway/samples/README.md b/packages/google-cloud-apigateway/samples/README.md index 663da687c11..0c455bf3e4c 100644 --- a/packages/google-cloud-apigateway/samples/README.md +++ b/packages/google-cloud-apigateway/samples/README.md @@ -28,7 +28,6 @@ * [Api_gateway_service.update_api_config](#api_gateway_service.update_api_config) * [Api_gateway_service.update_gateway](#api_gateway_service.update_gateway) * [Quickstart](#quickstart) - * [Quickstart.test](#quickstart.test) ## Before you begin @@ -312,23 +311,6 @@ __Usage:__ `node packages/google-cloud-apigateway/samples/quickstart.js` ------ - - - - -### Quickstart.test - -View the [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-apigateway/samples/test/quickstart.test.js). - -[![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-apigateway/samples/test/quickstart.test.js,samples/README.md) - -__Usage:__ - - -`node packages/google-cloud-apigateway/samples/test/quickstart.test.js` - - diff --git a/packages/google-cloud-apigateway/samples/generated/v1/snippet_metadata.google.cloud.apigateway.v1.json b/packages/google-cloud-apigateway/samples/generated/v1/snippet_metadata.google.cloud.apigateway.v1.json index b8c0ddd4dea..6024bc5146e 100644 --- a/packages/google-cloud-apigateway/samples/generated/v1/snippet_metadata.google.cloud.apigateway.v1.json +++ b/packages/google-cloud-apigateway/samples/generated/v1/snippet_metadata.google.cloud.apigateway.v1.json @@ -1,7 +1,7 @@ { "clientLibrary": { "name": "nodejs-apigateway", - "version": "2.2.0", + "version": "2.2.2", "language": "TYPESCRIPT", "apis": [ { diff --git a/packages/google-cloud-apigateway/samples/generated/v1/snippet_metadata_google.cloud.apigateway.v1.json b/packages/google-cloud-apigateway/samples/generated/v1/snippet_metadata_google.cloud.apigateway.v1.json new file mode 100644 index 00000000000..6024bc5146e --- /dev/null +++ b/packages/google-cloud-apigateway/samples/generated/v1/snippet_metadata_google.cloud.apigateway.v1.json @@ -0,0 +1,703 @@ +{ + "clientLibrary": { + "name": "nodejs-apigateway", + "version": "2.2.2", + "language": "TYPESCRIPT", + "apis": [ + { + "id": "google.cloud.apigateway.v1", + "version": "v1" + } + ] + }, + "snippets": [ + { + "regionTag": "apigateway_v1_generated_ApiGatewayService_ListGateways_async", + "title": "ApiGatewayService listGateways Sample", + "origin": "API_DEFINITION", + "description": " Lists Gateways in a given project and location.", + "canonical": true, + "file": "api_gateway_service.list_gateways.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 72, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListGateways", + "fullName": "google.cloud.apigateway.v1.ApiGatewayService.ListGateways", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.apigateway.v1.ListGatewaysResponse", + "client": { + "shortName": "ApiGatewayServiceClient", + "fullName": "google.cloud.apigateway.v1.ApiGatewayServiceClient" + }, + "method": { + "shortName": "ListGateways", + "fullName": "google.cloud.apigateway.v1.ApiGatewayService.ListGateways", + "service": { + "shortName": "ApiGatewayService", + "fullName": "google.cloud.apigateway.v1.ApiGatewayService" + } + } + } + }, + { + "regionTag": "apigateway_v1_generated_ApiGatewayService_GetGateway_async", + "title": "ApiGatewayService getGateway Sample", + "origin": "API_DEFINITION", + "description": " Gets details of a single Gateway.", + "canonical": true, + "file": "api_gateway_service.get_gateway.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 54, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetGateway", + "fullName": "google.cloud.apigateway.v1.ApiGatewayService.GetGateway", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.apigateway.v1.Gateway", + "client": { + "shortName": "ApiGatewayServiceClient", + "fullName": "google.cloud.apigateway.v1.ApiGatewayServiceClient" + }, + "method": { + "shortName": "GetGateway", + "fullName": "google.cloud.apigateway.v1.ApiGatewayService.GetGateway", + "service": { + "shortName": "ApiGatewayService", + "fullName": "google.cloud.apigateway.v1.ApiGatewayService" + } + } + } + }, + { + "regionTag": "apigateway_v1_generated_ApiGatewayService_CreateGateway_async", + "title": "ApiGatewayService createGateway Sample", + "origin": "API_DEFINITION", + "description": " Creates a new Gateway in a given project and location.", + "canonical": true, + "file": "api_gateway_service.create_gateway.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 66, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CreateGateway", + "fullName": "google.cloud.apigateway.v1.ApiGatewayService.CreateGateway", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "gateway_id", + "type": "TYPE_STRING" + }, + { + "name": "gateway", + "type": ".google.cloud.apigateway.v1.Gateway" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "ApiGatewayServiceClient", + "fullName": "google.cloud.apigateway.v1.ApiGatewayServiceClient" + }, + "method": { + "shortName": "CreateGateway", + "fullName": "google.cloud.apigateway.v1.ApiGatewayService.CreateGateway", + "service": { + "shortName": "ApiGatewayService", + "fullName": "google.cloud.apigateway.v1.ApiGatewayService" + } + } + } + }, + { + "regionTag": "apigateway_v1_generated_ApiGatewayService_UpdateGateway_async", + "title": "ApiGatewayService updateGateway Sample", + "origin": "API_DEFINITION", + "description": " Updates the parameters of a single Gateway.", + "canonical": true, + "file": "api_gateway_service.update_gateway.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 62, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "UpdateGateway", + "fullName": "google.cloud.apigateway.v1.ApiGatewayService.UpdateGateway", + "async": true, + "parameters": [ + { + "name": "update_mask", + "type": ".google.protobuf.FieldMask" + }, + { + "name": "gateway", + "type": ".google.cloud.apigateway.v1.Gateway" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "ApiGatewayServiceClient", + "fullName": "google.cloud.apigateway.v1.ApiGatewayServiceClient" + }, + "method": { + "shortName": "UpdateGateway", + "fullName": "google.cloud.apigateway.v1.ApiGatewayService.UpdateGateway", + "service": { + "shortName": "ApiGatewayService", + "fullName": "google.cloud.apigateway.v1.ApiGatewayService" + } + } + } + }, + { + "regionTag": "apigateway_v1_generated_ApiGatewayService_DeleteGateway_async", + "title": "ApiGatewayService deleteGateway Sample", + "origin": "API_DEFINITION", + "description": " Deletes a single Gateway.", + "canonical": true, + "file": "api_gateway_service.delete_gateway.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 55, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeleteGateway", + "fullName": "google.cloud.apigateway.v1.ApiGatewayService.DeleteGateway", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "ApiGatewayServiceClient", + "fullName": "google.cloud.apigateway.v1.ApiGatewayServiceClient" + }, + "method": { + "shortName": "DeleteGateway", + "fullName": "google.cloud.apigateway.v1.ApiGatewayService.DeleteGateway", + "service": { + "shortName": "ApiGatewayService", + "fullName": "google.cloud.apigateway.v1.ApiGatewayService" + } + } + } + }, + { + "regionTag": "apigateway_v1_generated_ApiGatewayService_ListApis_async", + "title": "ApiGatewayService listApis Sample", + "origin": "API_DEFINITION", + "description": " Lists Apis in a given project and location.", + "canonical": true, + "file": "api_gateway_service.list_apis.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 72, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListApis", + "fullName": "google.cloud.apigateway.v1.ApiGatewayService.ListApis", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.apigateway.v1.ListApisResponse", + "client": { + "shortName": "ApiGatewayServiceClient", + "fullName": "google.cloud.apigateway.v1.ApiGatewayServiceClient" + }, + "method": { + "shortName": "ListApis", + "fullName": "google.cloud.apigateway.v1.ApiGatewayService.ListApis", + "service": { + "shortName": "ApiGatewayService", + "fullName": "google.cloud.apigateway.v1.ApiGatewayService" + } + } + } + }, + { + "regionTag": "apigateway_v1_generated_ApiGatewayService_GetApi_async", + "title": "ApiGatewayService getApi Sample", + "origin": "API_DEFINITION", + "description": " Gets details of a single Api.", + "canonical": true, + "file": "api_gateway_service.get_api.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 54, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetApi", + "fullName": "google.cloud.apigateway.v1.ApiGatewayService.GetApi", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.apigateway.v1.Api", + "client": { + "shortName": "ApiGatewayServiceClient", + "fullName": "google.cloud.apigateway.v1.ApiGatewayServiceClient" + }, + "method": { + "shortName": "GetApi", + "fullName": "google.cloud.apigateway.v1.ApiGatewayService.GetApi", + "service": { + "shortName": "ApiGatewayService", + "fullName": "google.cloud.apigateway.v1.ApiGatewayService" + } + } + } + }, + { + "regionTag": "apigateway_v1_generated_ApiGatewayService_CreateApi_async", + "title": "ApiGatewayService createApi Sample", + "origin": "API_DEFINITION", + "description": " Creates a new Api in a given project and location.", + "canonical": true, + "file": "api_gateway_service.create_api.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 66, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CreateApi", + "fullName": "google.cloud.apigateway.v1.ApiGatewayService.CreateApi", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "api_id", + "type": "TYPE_STRING" + }, + { + "name": "api", + "type": ".google.cloud.apigateway.v1.Api" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "ApiGatewayServiceClient", + "fullName": "google.cloud.apigateway.v1.ApiGatewayServiceClient" + }, + "method": { + "shortName": "CreateApi", + "fullName": "google.cloud.apigateway.v1.ApiGatewayService.CreateApi", + "service": { + "shortName": "ApiGatewayService", + "fullName": "google.cloud.apigateway.v1.ApiGatewayService" + } + } + } + }, + { + "regionTag": "apigateway_v1_generated_ApiGatewayService_UpdateApi_async", + "title": "ApiGatewayService updateApi Sample", + "origin": "API_DEFINITION", + "description": " Updates the parameters of a single Api.", + "canonical": true, + "file": "api_gateway_service.update_api.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 62, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "UpdateApi", + "fullName": "google.cloud.apigateway.v1.ApiGatewayService.UpdateApi", + "async": true, + "parameters": [ + { + "name": "update_mask", + "type": ".google.protobuf.FieldMask" + }, + { + "name": "api", + "type": ".google.cloud.apigateway.v1.Api" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "ApiGatewayServiceClient", + "fullName": "google.cloud.apigateway.v1.ApiGatewayServiceClient" + }, + "method": { + "shortName": "UpdateApi", + "fullName": "google.cloud.apigateway.v1.ApiGatewayService.UpdateApi", + "service": { + "shortName": "ApiGatewayService", + "fullName": "google.cloud.apigateway.v1.ApiGatewayService" + } + } + } + }, + { + "regionTag": "apigateway_v1_generated_ApiGatewayService_DeleteApi_async", + "title": "ApiGatewayService deleteApi Sample", + "origin": "API_DEFINITION", + "description": " Deletes a single Api.", + "canonical": true, + "file": "api_gateway_service.delete_api.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 55, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeleteApi", + "fullName": "google.cloud.apigateway.v1.ApiGatewayService.DeleteApi", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "ApiGatewayServiceClient", + "fullName": "google.cloud.apigateway.v1.ApiGatewayServiceClient" + }, + "method": { + "shortName": "DeleteApi", + "fullName": "google.cloud.apigateway.v1.ApiGatewayService.DeleteApi", + "service": { + "shortName": "ApiGatewayService", + "fullName": "google.cloud.apigateway.v1.ApiGatewayService" + } + } + } + }, + { + "regionTag": "apigateway_v1_generated_ApiGatewayService_ListApiConfigs_async", + "title": "ApiGatewayService listApiConfigs Sample", + "origin": "API_DEFINITION", + "description": " Lists ApiConfigs in a given project and location.", + "canonical": true, + "file": "api_gateway_service.list_api_configs.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 72, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListApiConfigs", + "fullName": "google.cloud.apigateway.v1.ApiGatewayService.ListApiConfigs", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.apigateway.v1.ListApiConfigsResponse", + "client": { + "shortName": "ApiGatewayServiceClient", + "fullName": "google.cloud.apigateway.v1.ApiGatewayServiceClient" + }, + "method": { + "shortName": "ListApiConfigs", + "fullName": "google.cloud.apigateway.v1.ApiGatewayService.ListApiConfigs", + "service": { + "shortName": "ApiGatewayService", + "fullName": "google.cloud.apigateway.v1.ApiGatewayService" + } + } + } + }, + { + "regionTag": "apigateway_v1_generated_ApiGatewayService_GetApiConfig_async", + "title": "ApiGatewayService getApiConfig Sample", + "origin": "API_DEFINITION", + "description": " Gets details of a single ApiConfig.", + "canonical": true, + "file": "api_gateway_service.get_api_config.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 59, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetApiConfig", + "fullName": "google.cloud.apigateway.v1.ApiGatewayService.GetApiConfig", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + }, + { + "name": "view", + "type": ".google.cloud.apigateway.v1.GetApiConfigRequest.ConfigView" + } + ], + "resultType": ".google.cloud.apigateway.v1.ApiConfig", + "client": { + "shortName": "ApiGatewayServiceClient", + "fullName": "google.cloud.apigateway.v1.ApiGatewayServiceClient" + }, + "method": { + "shortName": "GetApiConfig", + "fullName": "google.cloud.apigateway.v1.ApiGatewayService.GetApiConfig", + "service": { + "shortName": "ApiGatewayService", + "fullName": "google.cloud.apigateway.v1.ApiGatewayService" + } + } + } + }, + { + "regionTag": "apigateway_v1_generated_ApiGatewayService_CreateApiConfig_async", + "title": "ApiGatewayService createApiConfig Sample", + "origin": "API_DEFINITION", + "description": " Creates a new ApiConfig in a given project and location.", + "canonical": true, + "file": "api_gateway_service.create_api_config.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 66, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CreateApiConfig", + "fullName": "google.cloud.apigateway.v1.ApiGatewayService.CreateApiConfig", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "api_config_id", + "type": "TYPE_STRING" + }, + { + "name": "api_config", + "type": ".google.cloud.apigateway.v1.ApiConfig" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "ApiGatewayServiceClient", + "fullName": "google.cloud.apigateway.v1.ApiGatewayServiceClient" + }, + "method": { + "shortName": "CreateApiConfig", + "fullName": "google.cloud.apigateway.v1.ApiGatewayService.CreateApiConfig", + "service": { + "shortName": "ApiGatewayService", + "fullName": "google.cloud.apigateway.v1.ApiGatewayService" + } + } + } + }, + { + "regionTag": "apigateway_v1_generated_ApiGatewayService_UpdateApiConfig_async", + "title": "ApiGatewayService updateApiConfig Sample", + "origin": "API_DEFINITION", + "description": " Updates the parameters of a single ApiConfig.", + "canonical": true, + "file": "api_gateway_service.update_api_config.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 62, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "UpdateApiConfig", + "fullName": "google.cloud.apigateway.v1.ApiGatewayService.UpdateApiConfig", + "async": true, + "parameters": [ + { + "name": "update_mask", + "type": ".google.protobuf.FieldMask" + }, + { + "name": "api_config", + "type": ".google.cloud.apigateway.v1.ApiConfig" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "ApiGatewayServiceClient", + "fullName": "google.cloud.apigateway.v1.ApiGatewayServiceClient" + }, + "method": { + "shortName": "UpdateApiConfig", + "fullName": "google.cloud.apigateway.v1.ApiGatewayService.UpdateApiConfig", + "service": { + "shortName": "ApiGatewayService", + "fullName": "google.cloud.apigateway.v1.ApiGatewayService" + } + } + } + }, + { + "regionTag": "apigateway_v1_generated_ApiGatewayService_DeleteApiConfig_async", + "title": "ApiGatewayService deleteApiConfig Sample", + "origin": "API_DEFINITION", + "description": " Deletes a single ApiConfig.", + "canonical": true, + "file": "api_gateway_service.delete_api_config.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 55, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeleteApiConfig", + "fullName": "google.cloud.apigateway.v1.ApiGatewayService.DeleteApiConfig", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "ApiGatewayServiceClient", + "fullName": "google.cloud.apigateway.v1.ApiGatewayServiceClient" + }, + "method": { + "shortName": "DeleteApiConfig", + "fullName": "google.cloud.apigateway.v1.ApiGatewayService.DeleteApiConfig", + "service": { + "shortName": "ApiGatewayService", + "fullName": "google.cloud.apigateway.v1.ApiGatewayService" + } + } + } + } + ] +} \ No newline at end of file diff --git a/packages/google-cloud-apigateway/samples/package.json b/packages/google-cloud-apigateway/samples/package.json index 0c71a6496ff..34e4c1c3609 100644 --- a/packages/google-cloud-apigateway/samples/package.json +++ b/packages/google-cloud-apigateway/samples/package.json @@ -4,7 +4,7 @@ "license": "Apache-2.0", "author": "Google LLC", "engines": { - "node": ">=12.0.0" + "node": ">=14.0.0" }, "files": [ "*.js" @@ -19,4 +19,4 @@ "c8": "^7.3.0", "mocha": "^8.1.1" } -} +} \ No newline at end of file diff --git a/packages/google-cloud-apigateway/src/v1/api_gateway_service_client.ts b/packages/google-cloud-apigateway/src/v1/api_gateway_service_client.ts index 7cfdb764142..dc3ead45d55 100644 --- a/packages/google-cloud-apigateway/src/v1/api_gateway_service_client.ts +++ b/packages/google-cloud-apigateway/src/v1/api_gateway_service_client.ts @@ -559,9 +559,8 @@ export class ApiGatewayServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.apigateway.v1.Gateway | Gateway}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.apigateway.v1.Gateway|Gateway}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/api_gateway_service.get_gateway.js * region_tag:apigateway_v1_generated_ApiGatewayService_GetGateway_async @@ -645,9 +644,8 @@ export class ApiGatewayServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.apigateway.v1.Api | Api}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.apigateway.v1.Api|Api}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/api_gateway_service.get_api.js * region_tag:apigateway_v1_generated_ApiGatewayService_GetApi_async @@ -732,9 +730,8 @@ export class ApiGatewayServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.apigateway.v1.ApiConfig | ApiConfig}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.apigateway.v1.ApiConfig|ApiConfig}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/api_gateway_service.get_api_config.js * region_tag:apigateway_v1_generated_ApiGatewayService_GetApiConfig_async @@ -827,8 +824,7 @@ export class ApiGatewayServiceClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/api_gateway_service.create_gateway.js * region_tag:apigateway_v1_generated_ApiGatewayService_CreateGateway_async @@ -923,8 +919,7 @@ export class ApiGatewayServiceClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/api_gateway_service.create_gateway.js * region_tag:apigateway_v1_generated_ApiGatewayService_CreateGateway_async @@ -971,8 +966,7 @@ export class ApiGatewayServiceClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/api_gateway_service.update_gateway.js * region_tag:apigateway_v1_generated_ApiGatewayService_UpdateGateway_async @@ -1067,8 +1061,7 @@ export class ApiGatewayServiceClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/api_gateway_service.update_gateway.js * region_tag:apigateway_v1_generated_ApiGatewayService_UpdateGateway_async @@ -1110,8 +1103,7 @@ export class ApiGatewayServiceClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/api_gateway_service.delete_gateway.js * region_tag:apigateway_v1_generated_ApiGatewayService_DeleteGateway_async @@ -1206,8 +1198,7 @@ export class ApiGatewayServiceClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/api_gateway_service.delete_gateway.js * region_tag:apigateway_v1_generated_ApiGatewayService_DeleteGateway_async @@ -1254,8 +1245,7 @@ export class ApiGatewayServiceClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/api_gateway_service.create_api.js * region_tag:apigateway_v1_generated_ApiGatewayService_CreateApi_async @@ -1350,8 +1340,7 @@ export class ApiGatewayServiceClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/api_gateway_service.create_api.js * region_tag:apigateway_v1_generated_ApiGatewayService_CreateApi_async @@ -1398,8 +1387,7 @@ export class ApiGatewayServiceClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/api_gateway_service.update_api.js * region_tag:apigateway_v1_generated_ApiGatewayService_UpdateApi_async @@ -1494,8 +1482,7 @@ export class ApiGatewayServiceClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/api_gateway_service.update_api.js * region_tag:apigateway_v1_generated_ApiGatewayService_UpdateApi_async @@ -1537,8 +1524,7 @@ export class ApiGatewayServiceClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/api_gateway_service.delete_api.js * region_tag:apigateway_v1_generated_ApiGatewayService_DeleteApi_async @@ -1633,8 +1619,7 @@ export class ApiGatewayServiceClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/api_gateway_service.delete_api.js * region_tag:apigateway_v1_generated_ApiGatewayService_DeleteApi_async @@ -1681,8 +1666,7 @@ export class ApiGatewayServiceClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/api_gateway_service.create_api_config.js * region_tag:apigateway_v1_generated_ApiGatewayService_CreateApiConfig_async @@ -1777,8 +1761,7 @@ export class ApiGatewayServiceClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/api_gateway_service.create_api_config.js * region_tag:apigateway_v1_generated_ApiGatewayService_CreateApiConfig_async @@ -1825,8 +1808,7 @@ export class ApiGatewayServiceClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/api_gateway_service.update_api_config.js * region_tag:apigateway_v1_generated_ApiGatewayService_UpdateApiConfig_async @@ -1921,8 +1903,7 @@ export class ApiGatewayServiceClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/api_gateway_service.update_api_config.js * region_tag:apigateway_v1_generated_ApiGatewayService_UpdateApiConfig_async @@ -1964,8 +1945,7 @@ export class ApiGatewayServiceClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/api_gateway_service.delete_api_config.js * region_tag:apigateway_v1_generated_ApiGatewayService_DeleteApiConfig_async @@ -2060,8 +2040,7 @@ export class ApiGatewayServiceClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/api_gateway_service.delete_api_config.js * region_tag:apigateway_v1_generated_ApiGatewayService_DeleteApiConfig_async @@ -2108,14 +2087,13 @@ export class ApiGatewayServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.cloud.apigateway.v1.Gateway | Gateway}. + * The first element of the array is Array of {@link protos.google.cloud.apigateway.v1.Gateway|Gateway}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `listGatewaysAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listGateways( @@ -2211,13 +2189,12 @@ export class ApiGatewayServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.cloud.apigateway.v1.Gateway | Gateway} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.apigateway.v1.Gateway|Gateway} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listGatewaysAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listGatewaysStream( @@ -2262,12 +2239,11 @@ export class ApiGatewayServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.cloud.apigateway.v1.Gateway | Gateway}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.apigateway.v1.Gateway|Gateway}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1/api_gateway_service.list_gateways.js * region_tag:apigateway_v1_generated_ApiGatewayService_ListGateways_async @@ -2312,14 +2288,13 @@ export class ApiGatewayServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.cloud.apigateway.v1.Api | Api}. + * The first element of the array is Array of {@link protos.google.cloud.apigateway.v1.Api|Api}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `listApisAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listApis( @@ -2409,13 +2384,12 @@ export class ApiGatewayServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.cloud.apigateway.v1.Api | Api} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.apigateway.v1.Api|Api} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listApisAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listApisStream( @@ -2460,12 +2434,11 @@ export class ApiGatewayServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.cloud.apigateway.v1.Api | Api}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.apigateway.v1.Api|Api}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1/api_gateway_service.list_apis.js * region_tag:apigateway_v1_generated_ApiGatewayService_ListApis_async @@ -2510,14 +2483,13 @@ export class ApiGatewayServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.cloud.apigateway.v1.ApiConfig | ApiConfig}. + * The first element of the array is Array of {@link protos.google.cloud.apigateway.v1.ApiConfig|ApiConfig}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `listApiConfigsAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listApiConfigs( @@ -2613,13 +2585,12 @@ export class ApiGatewayServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.cloud.apigateway.v1.ApiConfig | ApiConfig} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.apigateway.v1.ApiConfig|ApiConfig} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listApiConfigsAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listApiConfigsStream( @@ -2664,12 +2635,11 @@ export class ApiGatewayServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.cloud.apigateway.v1.ApiConfig | ApiConfig}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.apigateway.v1.ApiConfig|ApiConfig}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1/api_gateway_service.list_api_configs.js * region_tag:apigateway_v1_generated_ApiGatewayService_ListApiConfigs_async diff --git a/packages/google-cloud-apigeeconnect/README.md b/packages/google-cloud-apigeeconnect/README.md index aa61da32d73..bc3f467dc6e 100644 --- a/packages/google-cloud-apigeeconnect/README.md +++ b/packages/google-cloud-apigeeconnect/README.md @@ -2,7 +2,7 @@ [//]: # "To regenerate it, use `python -m synthtool`." Google Cloud Platform logo -# [Apigee Connect API: Node.js Client](https://github.com/googleapis/google-cloud-node) +# [Apigee Connect API: Node.js Client](https://github.com/googleapis/google-cloud-node/tree/main/packages/google-cloud-apigeeconnect) [![release level](https://img.shields.io/badge/release%20level-stable-brightgreen.svg?style=flat)](https://cloud.google.com/terms/launch-stages) [![npm version](https://img.shields.io/npm/v/@google-cloud/apigee-connect.svg)](https://www.npmjs.org/package/@google-cloud/apigee-connect) @@ -84,14 +84,13 @@ listConnections(); ## Samples -Samples are in the [`samples/`](https://github.com/googleapis/google-cloud-node/tree/main/samples) directory. Each sample's `README.md` has instructions for running its sample. +Samples are in the [`samples/`](https://github.com/googleapis/google-cloud-node/tree/main/packages/google-cloud-apigeeconnect/samples) directory. Each sample's `README.md` has instructions for running its sample. | Sample | Source Code | Try it | | --------------------------- | --------------------------------- | ------ | -| Connection_service.list_connections | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-apigeeconnect/samples/generated/v1/connection_service.list_connections.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-apigeeconnect/samples/generated/v1/connection_service.list_connections.js,samples/README.md) | -| Tether.egress | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-apigeeconnect/samples/generated/v1/tether.egress.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-apigeeconnect/samples/generated/v1/tether.egress.js,samples/README.md) | -| Quickstart | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-apigeeconnect/samples/quickstart.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-apigeeconnect/samples/quickstart.js,samples/README.md) | -| Quickstart | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-apigeeconnect/samples/test/quickstart.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-apigeeconnect/samples/test/quickstart.js,samples/README.md) | +| Connection_service.list_connections | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-apigeeconnect/samples/generated/v1/connection_service.list_connections.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-apigeeconnect/samples/generated/v1/connection_service.list_connections.js,packages/google-cloud-apigeeconnect/samples/README.md) | +| Tether.egress | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-apigeeconnect/samples/generated/v1/tether.egress.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-apigeeconnect/samples/generated/v1/tether.egress.js,packages/google-cloud-apigeeconnect/samples/README.md) | +| Quickstart | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-apigeeconnect/samples/quickstart.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-apigeeconnect/samples/quickstart.js,packages/google-cloud-apigeeconnect/samples/README.md) | diff --git a/packages/google-cloud-apigeeconnect/package.json b/packages/google-cloud-apigeeconnect/package.json index 404e465a82b..aa563446177 100644 --- a/packages/google-cloud-apigeeconnect/package.json +++ b/packages/google-cloud-apigeeconnect/package.json @@ -45,14 +45,15 @@ "test": "c8 mocha build/test" }, "dependencies": { - "google-gax": "^3.5.8" + "google-gax": "^4.0.3" }, "devDependencies": { "@types/mocha": "^9.0.0", - "@types/node": "^18.0.0", + "@types/node": "^20.4.5", "@types/sinon": "^10.0.0", "c8": "^7.7.2", - "gts": "^3.1.0", + "gapic-tools": "^0.1.8", + "gts": "^5.0.0", "jsdoc": "^4.0.0", "jsdoc-fresh": "^2.0.0", "jsdoc-region-tag": "^2.0.0", @@ -63,12 +64,12 @@ "pack-n-play": "^1.0.0-2", "sinon": "^15.0.0", "ts-loader": "^9.1.2", - "typescript": "^4.6.4", + "typescript": "^5.1.6", "webpack": "^5.36.2", "webpack-cli": "^5.0.0" }, "engines": { - "node": ">=12.0.0" + "node": ">=14.0.0" }, "homepage": "https://github.com/googleapis/google-cloud-node/tree/main/packages/google-cloud-apigeeconnect" } diff --git a/packages/google-cloud-apigeeconnect/samples/README.md b/packages/google-cloud-apigeeconnect/samples/README.md index ee86faa9c23..95ec138b17e 100644 --- a/packages/google-cloud-apigeeconnect/samples/README.md +++ b/packages/google-cloud-apigeeconnect/samples/README.md @@ -15,7 +15,6 @@ * [Connection_service.list_connections](#connection_service.list_connections) * [Tether.egress](#tether.egress) * [Quickstart](#quickstart) - * [Quickstart](#quickstart) ## Before you begin @@ -78,23 +77,6 @@ __Usage:__ `node packages/google-cloud-apigeeconnect/samples/quickstart.js` ------ - - - - -### Quickstart - -View the [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-apigeeconnect/samples/test/quickstart.js). - -[![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-apigeeconnect/samples/test/quickstart.js,samples/README.md) - -__Usage:__ - - -`node packages/google-cloud-apigeeconnect/samples/test/quickstart.js` - - diff --git a/packages/google-cloud-apigeeconnect/samples/generated/v1/snippet_metadata.google.cloud.apigeeconnect.v1.json b/packages/google-cloud-apigeeconnect/samples/generated/v1/snippet_metadata.google.cloud.apigeeconnect.v1.json index 1655e4ce81b..2bbcef28336 100644 --- a/packages/google-cloud-apigeeconnect/samples/generated/v1/snippet_metadata.google.cloud.apigeeconnect.v1.json +++ b/packages/google-cloud-apigeeconnect/samples/generated/v1/snippet_metadata.google.cloud.apigeeconnect.v1.json @@ -1,7 +1,7 @@ { "clientLibrary": { "name": "nodejs-apigeeconnect", - "version": "2.2.0", + "version": "2.2.2", "language": "TYPESCRIPT", "apis": [ { diff --git a/packages/google-cloud-apigeeconnect/samples/generated/v1/snippet_metadata_google.cloud.apigeeconnect.v1.json b/packages/google-cloud-apigeeconnect/samples/generated/v1/snippet_metadata_google.cloud.apigeeconnect.v1.json new file mode 100644 index 00000000000..2bbcef28336 --- /dev/null +++ b/packages/google-cloud-apigeeconnect/samples/generated/v1/snippet_metadata_google.cloud.apigeeconnect.v1.json @@ -0,0 +1,127 @@ +{ + "clientLibrary": { + "name": "nodejs-apigeeconnect", + "version": "2.2.2", + "language": "TYPESCRIPT", + "apis": [ + { + "id": "google.cloud.apigeeconnect.v1", + "version": "v1" + } + ] + }, + "snippets": [ + { + "regionTag": "apigeeconnect_v1_generated_ConnectionService_ListConnections_async", + "title": "ConnectionService listConnections Sample", + "origin": "API_DEFINITION", + "description": " Lists connections that are currently active for the given Apigee Connect endpoint.", + "canonical": true, + "file": "connection_service.list_connections.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 69, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListConnections", + "fullName": "google.cloud.apigeeconnect.v1.ConnectionService.ListConnections", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.apigeeconnect.v1.ListConnectionsResponse", + "client": { + "shortName": "ConnectionServiceClient", + "fullName": "google.cloud.apigeeconnect.v1.ConnectionServiceClient" + }, + "method": { + "shortName": "ListConnections", + "fullName": "google.cloud.apigeeconnect.v1.ConnectionService.ListConnections", + "service": { + "shortName": "ConnectionService", + "fullName": "google.cloud.apigeeconnect.v1.ConnectionService" + } + } + } + }, + { + "regionTag": "apigeeconnect_v1_generated_Tether_Egress_async", + "title": "ConnectionService egress Sample", + "origin": "API_DEFINITION", + "description": " Egress streams egress requests and responses. Logically, this is not actually a streaming request, but uses streaming as a mechanism to flip the client-server relationship of gRPC so that the server can act as a client. The listener, the RPC server, accepts connections from the dialer, the RPC client. The listener streams http requests and the dialer streams http responses.", + "canonical": true, + "file": "tether.egress.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 83, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Egress", + "fullName": "google.cloud.apigeeconnect.v1.Tether.Egress", + "async": true, + "parameters": [ + { + "name": "id", + "type": "TYPE_STRING" + }, + { + "name": "http_response", + "type": ".google.cloud.apigeeconnect.v1.HttpResponse" + }, + { + "name": "status", + "type": ".google.rpc.Status" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "trace_id", + "type": "TYPE_STRING" + }, + { + "name": "endpoint", + "type": ".google.cloud.apigeeconnect.v1.TetherEndpoint" + }, + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.apigeeconnect.v1.EgressRequest", + "client": { + "shortName": "TetherClient", + "fullName": "google.cloud.apigeeconnect.v1.TetherClient" + }, + "method": { + "shortName": "Egress", + "fullName": "google.cloud.apigeeconnect.v1.Tether.Egress", + "service": { + "shortName": "Tether", + "fullName": "google.cloud.apigeeconnect.v1.Tether" + } + } + } + } + ] +} \ No newline at end of file diff --git a/packages/google-cloud-apigeeconnect/samples/package.json b/packages/google-cloud-apigeeconnect/samples/package.json index 26cb002d8c3..ee09f3decf5 100644 --- a/packages/google-cloud-apigeeconnect/samples/package.json +++ b/packages/google-cloud-apigeeconnect/samples/package.json @@ -4,7 +4,7 @@ "license": "Apache-2.0", "author": "Google LLC", "engines": { - "node": ">=12.0.0" + "node": ">=14.0.0" }, "files": [ "*.js" diff --git a/packages/google-cloud-apigeeconnect/src/v1/connection_service_client.ts b/packages/google-cloud-apigeeconnect/src/v1/connection_service_client.ts index 936ff697288..874c2c535f5 100644 --- a/packages/google-cloud-apigeeconnect/src/v1/connection_service_client.ts +++ b/packages/google-cloud-apigeeconnect/src/v1/connection_service_client.ts @@ -349,14 +349,13 @@ export class ConnectionServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.cloud.apigeeconnect.v1.Connection | Connection}. + * The first element of the array is Array of {@link protos.google.cloud.apigeeconnect.v1.Connection|Connection}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `listConnectionsAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listConnections( @@ -454,13 +453,12 @@ export class ConnectionServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.cloud.apigeeconnect.v1.Connection | Connection} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.apigeeconnect.v1.Connection|Connection} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listConnectionsAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listConnectionsStream( @@ -507,12 +505,11 @@ export class ConnectionServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.cloud.apigeeconnect.v1.Connection | Connection}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.apigeeconnect.v1.Connection|Connection}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1/connection_service.list_connections.js * region_tag:apigeeconnect_v1_generated_ConnectionService_ListConnections_async diff --git a/packages/google-cloud-apigeeconnect/src/v1/tether_client.ts b/packages/google-cloud-apigeeconnect/src/v1/tether_client.ts index d1ce99b73b4..70d7678b4a5 100644 --- a/packages/google-cloud-apigeeconnect/src/v1/tether_client.ts +++ b/packages/google-cloud-apigeeconnect/src/v1/tether_client.ts @@ -340,10 +340,9 @@ export class TetherClient { * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} * An object stream which is both readable and writable. It accepts objects - * representing {@link google.cloud.apigeeconnect.v1.EgressResponse | EgressResponse} for write() method, and - * will emit objects representing {@link google.cloud.apigeeconnect.v1.EgressRequest | EgressRequest} on 'data' event asynchronously. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#bi-directional-streaming) + * representing {@link protos.google.cloud.apigeeconnect.v1.EgressResponse|EgressResponse} for write() method, and + * will emit objects representing {@link protos.google.cloud.apigeeconnect.v1.EgressRequest|EgressRequest} on 'data' event asynchronously. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#bi-directional-streaming | documentation } * for more details and examples. * @example include:samples/generated/v1/tether.egress.js * region_tag:apigeeconnect_v1_generated_Tether_Egress_async diff --git a/packages/google-cloud-asset/package.json b/packages/google-cloud-asset/package.json index ab127e57a56..d9f55c168d2 100644 --- a/packages/google-cloud-asset/package.json +++ b/packages/google-cloud-asset/package.json @@ -5,7 +5,7 @@ "license": "Apache-2.0", "author": "Google LLC", "engines": { - "node": ">=12.0.0" + "node": ">=14.0.0" }, "repository": { "type": "git", @@ -48,15 +48,16 @@ "test": "c8 mocha build/test" }, "dependencies": { - "google-gax": "^3.5.8" + "google-gax": "^4.0.3" }, "devDependencies": { "@types/mocha": "^9.0.0", - "@types/node": "^18.0.0", + "@types/node": "^20.4.5", "@types/sinon": "^10.0.0", "c8": "^7.1.0", "codecov": "^3.6.5", - "gts": "^3.1.0", + "gapic-tools": "^0.1.8", + "gts": "^5.0.0", "jsdoc": "^4.0.0", "jsdoc-fresh": "^2.0.0", "jsdoc-region-tag": "^2.0.0", @@ -67,7 +68,7 @@ "pack-n-play": "^1.0.0-2", "sinon": "^15.0.0", "ts-loader": "^9.0.0", - "typescript": "^4.6.4", + "typescript": "^5.1.6", "webpack": "^5.0.0", "webpack-cli": "^5.0.0" }, diff --git a/packages/google-cloud-asset/samples/generated/v1/asset_service.batch_get_assets_history.js b/packages/google-cloud-asset/samples/generated/v1/asset_service.batch_get_assets_history.js index afb1574d9e3..2fc3a703511 100644 --- a/packages/google-cloud-asset/samples/generated/v1/asset_service.batch_get_assets_history.js +++ b/packages/google-cloud-asset/samples/generated/v1/asset_service.batch_get_assets_history.js @@ -42,7 +42,7 @@ function main(parent) { * The request becomes a no-op if the asset name list is empty, and the max * size of the asset name list is 100 in one request. */ - // const assetNames = 'abc123' + // const assetNames = ['abc','def'] /** * Optional. The content type. */ @@ -74,7 +74,7 @@ function main(parent) { * Inventory (https://cloud.google.com/asset-inventory/docs/overview) for all * supported asset types and relationship types. */ - // const relationshipTypes = 'abc123' + // const relationshipTypes = ['abc','def'] // Imports the Asset library const {AssetServiceClient} = require('@google-cloud/asset').v1; diff --git a/packages/google-cloud-asset/samples/generated/v1/asset_service.batch_get_effective_iam_policies.js b/packages/google-cloud-asset/samples/generated/v1/asset_service.batch_get_effective_iam_policies.js index f3f85b5a4a9..f5e8adbc87c 100644 --- a/packages/google-cloud-asset/samples/generated/v1/asset_service.batch_get_effective_iam_policies.js +++ b/packages/google-cloud-asset/samples/generated/v1/asset_service.batch_get_effective_iam_policies.js @@ -46,7 +46,7 @@ function main(scope, names) { * types (https://cloud.google.com/asset-inventory/docs/supported-asset-types#searchable_asset_types). * A maximum of 20 resources' effective policies can be retrieved in a batch. */ - // const names = 'abc123' + // const names = ['abc','def'] // Imports the Asset library const {AssetServiceClient} = require('@google-cloud/asset').v1; diff --git a/packages/google-cloud-asset/samples/generated/v1/asset_service.export_assets.js b/packages/google-cloud-asset/samples/generated/v1/asset_service.export_assets.js index c56d8fbdc96..72636c51a94 100644 --- a/packages/google-cloud-asset/samples/generated/v1/asset_service.export_assets.js +++ b/packages/google-cloud-asset/samples/generated/v1/asset_service.export_assets.js @@ -59,7 +59,7 @@ function main(parent, outputConfig) { * Inventory (https://cloud.google.com/asset-inventory/docs/overview) * for all supported asset types. */ - // const assetTypes = 'abc123' + // const assetTypes = ['abc','def'] /** * Asset content type. If not specified, no content but the asset name will be * returned. @@ -87,7 +87,7 @@ function main(parent, outputConfig) { * Inventory (https://cloud.google.com/asset-inventory/docs/overview) for all * supported asset types and relationship types. */ - // const relationshipTypes = 'abc123' + // const relationshipTypes = ['abc','def'] // Imports the Asset library const {AssetServiceClient} = require('@google-cloud/asset').v1; diff --git a/packages/google-cloud-asset/samples/generated/v1/asset_service.list_assets.js b/packages/google-cloud-asset/samples/generated/v1/asset_service.list_assets.js index 61403e3fae5..654afb78879 100644 --- a/packages/google-cloud-asset/samples/generated/v1/asset_service.list_assets.js +++ b/packages/google-cloud-asset/samples/generated/v1/asset_service.list_assets.js @@ -60,7 +60,7 @@ function main(parent) { * Inventory (https://cloud.google.com/asset-inventory/docs/overview) * for all supported asset types. */ - // const assetTypes = 'abc123' + // const assetTypes = ['abc','def'] /** * Asset content type. If not specified, no content but the asset name will * be returned. @@ -94,7 +94,7 @@ function main(parent) { * Inventory (https://cloud.google.com/asset-inventory/docs/overview) * for all supported asset types and relationship types. */ - // const relationshipTypes = 'abc123' + // const relationshipTypes = ['abc','def'] // Imports the Asset library const {AssetServiceClient} = require('@google-cloud/asset').v1; diff --git a/packages/google-cloud-asset/samples/generated/v1/asset_service.search_all_iam_policies.js b/packages/google-cloud-asset/samples/generated/v1/asset_service.search_all_iam_policies.js index c9e490a41ac..39b36296517 100644 --- a/packages/google-cloud-asset/samples/generated/v1/asset_service.search_all_iam_policies.js +++ b/packages/google-cloud-asset/samples/generated/v1/asset_service.search_all_iam_policies.js @@ -115,7 +115,7 @@ function main(scope) { * regular expression syntax. If the regular expression does not match any * supported asset type, an INVALID_ARGUMENT error will be returned. */ - // const assetTypes = 'abc123' + // const assetTypes = ['abc','def'] /** * Optional. A comma-separated list of fields specifying the sorting order of * the results. The default order is ascending. Add " DESC" after the field diff --git a/packages/google-cloud-asset/samples/generated/v1/asset_service.search_all_resources.js b/packages/google-cloud-asset/samples/generated/v1/asset_service.search_all_resources.js index 147a53cc6fa..d1d3da46fee 100644 --- a/packages/google-cloud-asset/samples/generated/v1/asset_service.search_all_resources.js +++ b/packages/google-cloud-asset/samples/generated/v1/asset_service.search_all_resources.js @@ -107,7 +107,7 @@ function main(scope) { * regular expression syntax. If the regular expression does not match any * supported asset type, an INVALID_ARGUMENT error will be returned. */ - // const assetTypes = 'abc123' + // const assetTypes = ['abc','def'] /** * Optional. The page size for search result pagination. Page size is capped * at 500 even if a larger value is given. If set to zero, server will pick an diff --git a/packages/google-cloud-asset/samples/generated/v1/snippet_metadata_google.cloud.asset.v1.json b/packages/google-cloud-asset/samples/generated/v1/snippet_metadata_google.cloud.asset.v1.json new file mode 100644 index 00000000000..4fd32c12683 --- /dev/null +++ b/packages/google-cloud-asset/samples/generated/v1/snippet_metadata_google.cloud.asset.v1.json @@ -0,0 +1,1183 @@ +{ + "clientLibrary": { + "name": "nodejs-asset", + "version": "4.6.4", + "language": "TYPESCRIPT", + "apis": [ + { + "id": "google.cloud.asset.v1", + "version": "v1" + } + ] + }, + "snippets": [ + { + "regionTag": "cloudasset_v1_generated_AssetService_ExportAssets_async", + "title": "AssetService exportAssets Sample", + "origin": "API_DEFINITION", + "description": " Exports assets with time and resource types to a given Cloud Storage location/BigQuery table. For Cloud Storage location destinations, the output format is newline-delimited JSON. Each line represents a [google.cloud.asset.v1.Asset][google.cloud.asset.v1.Asset] in the JSON format; for BigQuery table destinations, the output table stores the fields in asset Protobuf as columns. This API implements the [google.longrunning.Operation][google.longrunning.Operation] API, which allows you to keep track of the export. We recommend intervals of at least 2 seconds with exponential retry to poll the export operation result. For regular-size resource parent, the export operation usually finishes within 5 minutes.", + "canonical": true, + "file": "asset_service.export_assets.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 111, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ExportAssets", + "fullName": "google.cloud.asset.v1.AssetService.ExportAssets", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "read_time", + "type": ".google.protobuf.Timestamp" + }, + { + "name": "asset_types", + "type": "TYPE_STRING[]" + }, + { + "name": "content_type", + "type": ".google.cloud.asset.v1.ContentType" + }, + { + "name": "output_config", + "type": ".google.cloud.asset.v1.OutputConfig" + }, + { + "name": "relationship_types", + "type": "TYPE_STRING[]" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "AssetServiceClient", + "fullName": "google.cloud.asset.v1.AssetServiceClient" + }, + "method": { + "shortName": "ExportAssets", + "fullName": "google.cloud.asset.v1.AssetService.ExportAssets", + "service": { + "shortName": "AssetService", + "fullName": "google.cloud.asset.v1.AssetService" + } + } + } + }, + { + "regionTag": "cloudasset_v1_generated_AssetService_ListAssets_async", + "title": "AssetService listAssets Sample", + "origin": "API_DEFINITION", + "description": " Lists assets with time and resource types and returns paged results in response.", + "canonical": true, + "file": "asset_service.list_assets.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 118, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListAssets", + "fullName": "google.cloud.asset.v1.AssetService.ListAssets", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "read_time", + "type": ".google.protobuf.Timestamp" + }, + { + "name": "asset_types", + "type": "TYPE_STRING[]" + }, + { + "name": "content_type", + "type": ".google.cloud.asset.v1.ContentType" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "relationship_types", + "type": "TYPE_STRING[]" + } + ], + "resultType": ".google.cloud.asset.v1.ListAssetsResponse", + "client": { + "shortName": "AssetServiceClient", + "fullName": "google.cloud.asset.v1.AssetServiceClient" + }, + "method": { + "shortName": "ListAssets", + "fullName": "google.cloud.asset.v1.AssetService.ListAssets", + "service": { + "shortName": "AssetService", + "fullName": "google.cloud.asset.v1.AssetService" + } + } + } + }, + { + "regionTag": "cloudasset_v1_generated_AssetService_BatchGetAssetsHistory_async", + "title": "AssetService batchGetAssetsHistory Sample", + "origin": "API_DEFINITION", + "description": " Batch gets the update history of assets that overlap a time window. For IAM_POLICY content, this API outputs history when the asset and its attached IAM POLICY both exist. This can create gaps in the output history. Otherwise, this API outputs history with asset in both non-delete or deleted status. If a specified asset does not exist, this API returns an INVALID_ARGUMENT error.", + "canonical": true, + "file": "asset_service.batch_get_assets_history.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 96, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "BatchGetAssetsHistory", + "fullName": "google.cloud.asset.v1.AssetService.BatchGetAssetsHistory", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "asset_names", + "type": "TYPE_STRING[]" + }, + { + "name": "content_type", + "type": ".google.cloud.asset.v1.ContentType" + }, + { + "name": "read_time_window", + "type": ".google.cloud.asset.v1.TimeWindow" + }, + { + "name": "relationship_types", + "type": "TYPE_STRING[]" + } + ], + "resultType": ".google.cloud.asset.v1.BatchGetAssetsHistoryResponse", + "client": { + "shortName": "AssetServiceClient", + "fullName": "google.cloud.asset.v1.AssetServiceClient" + }, + "method": { + "shortName": "BatchGetAssetsHistory", + "fullName": "google.cloud.asset.v1.AssetService.BatchGetAssetsHistory", + "service": { + "shortName": "AssetService", + "fullName": "google.cloud.asset.v1.AssetService" + } + } + } + }, + { + "regionTag": "cloudasset_v1_generated_AssetService_CreateFeed_async", + "title": "AssetService createFeed Sample", + "origin": "API_DEFINITION", + "description": " Creates a feed in a parent project/folder/organization to listen to its asset updates.", + "canonical": true, + "file": "asset_service.create_feed.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 71, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CreateFeed", + "fullName": "google.cloud.asset.v1.AssetService.CreateFeed", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "feed_id", + "type": "TYPE_STRING" + }, + { + "name": "feed", + "type": ".google.cloud.asset.v1.Feed" + } + ], + "resultType": ".google.cloud.asset.v1.Feed", + "client": { + "shortName": "AssetServiceClient", + "fullName": "google.cloud.asset.v1.AssetServiceClient" + }, + "method": { + "shortName": "CreateFeed", + "fullName": "google.cloud.asset.v1.AssetService.CreateFeed", + "service": { + "shortName": "AssetService", + "fullName": "google.cloud.asset.v1.AssetService" + } + } + } + }, + { + "regionTag": "cloudasset_v1_generated_AssetService_GetFeed_async", + "title": "AssetService getFeed Sample", + "origin": "API_DEFINITION", + "description": " Gets details about an asset feed.", + "canonical": true, + "file": "asset_service.get_feed.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 56, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetFeed", + "fullName": "google.cloud.asset.v1.AssetService.GetFeed", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.asset.v1.Feed", + "client": { + "shortName": "AssetServiceClient", + "fullName": "google.cloud.asset.v1.AssetServiceClient" + }, + "method": { + "shortName": "GetFeed", + "fullName": "google.cloud.asset.v1.AssetService.GetFeed", + "service": { + "shortName": "AssetService", + "fullName": "google.cloud.asset.v1.AssetService" + } + } + } + }, + { + "regionTag": "cloudasset_v1_generated_AssetService_ListFeeds_async", + "title": "AssetService listFeeds Sample", + "origin": "API_DEFINITION", + "description": " Lists all asset feeds in a parent project/folder/organization.", + "canonical": true, + "file": "asset_service.list_feeds.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 55, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListFeeds", + "fullName": "google.cloud.asset.v1.AssetService.ListFeeds", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.asset.v1.ListFeedsResponse", + "client": { + "shortName": "AssetServiceClient", + "fullName": "google.cloud.asset.v1.AssetServiceClient" + }, + "method": { + "shortName": "ListFeeds", + "fullName": "google.cloud.asset.v1.AssetService.ListFeeds", + "service": { + "shortName": "AssetService", + "fullName": "google.cloud.asset.v1.AssetService" + } + } + } + }, + { + "regionTag": "cloudasset_v1_generated_AssetService_UpdateFeed_async", + "title": "AssetService updateFeed Sample", + "origin": "API_DEFINITION", + "description": " Updates an asset feed configuration.", + "canonical": true, + "file": "asset_service.update_feed.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 64, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "UpdateFeed", + "fullName": "google.cloud.asset.v1.AssetService.UpdateFeed", + "async": true, + "parameters": [ + { + "name": "feed", + "type": ".google.cloud.asset.v1.Feed" + }, + { + "name": "update_mask", + "type": ".google.protobuf.FieldMask" + } + ], + "resultType": ".google.cloud.asset.v1.Feed", + "client": { + "shortName": "AssetServiceClient", + "fullName": "google.cloud.asset.v1.AssetServiceClient" + }, + "method": { + "shortName": "UpdateFeed", + "fullName": "google.cloud.asset.v1.AssetService.UpdateFeed", + "service": { + "shortName": "AssetService", + "fullName": "google.cloud.asset.v1.AssetService" + } + } + } + }, + { + "regionTag": "cloudasset_v1_generated_AssetService_DeleteFeed_async", + "title": "AssetService deleteFeed Sample", + "origin": "API_DEFINITION", + "description": " Deletes an asset feed.", + "canonical": true, + "file": "asset_service.delete_feed.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 56, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeleteFeed", + "fullName": "google.cloud.asset.v1.AssetService.DeleteFeed", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.protobuf.Empty", + "client": { + "shortName": "AssetServiceClient", + "fullName": "google.cloud.asset.v1.AssetServiceClient" + }, + "method": { + "shortName": "DeleteFeed", + "fullName": "google.cloud.asset.v1.AssetService.DeleteFeed", + "service": { + "shortName": "AssetService", + "fullName": "google.cloud.asset.v1.AssetService" + } + } + } + }, + { + "regionTag": "cloudasset_v1_generated_AssetService_SearchAllResources_async", + "title": "AssetService searchAllResources Sample", + "origin": "API_DEFINITION", + "description": " Searches all Google Cloud resources within the specified scope, such as a project, folder, or organization. The caller must be granted the `cloudasset.assets.searchAllResources` permission on the desired scope, otherwise the request will be rejected.", + "canonical": true, + "file": "asset_service.search_all_resources.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 201, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "SearchAllResources", + "fullName": "google.cloud.asset.v1.AssetService.SearchAllResources", + "async": true, + "parameters": [ + { + "name": "scope", + "type": "TYPE_STRING" + }, + { + "name": "query", + "type": "TYPE_STRING" + }, + { + "name": "asset_types", + "type": "TYPE_STRING[]" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + }, + { + "name": "read_mask", + "type": ".google.protobuf.FieldMask" + } + ], + "resultType": ".google.cloud.asset.v1.SearchAllResourcesResponse", + "client": { + "shortName": "AssetServiceClient", + "fullName": "google.cloud.asset.v1.AssetServiceClient" + }, + "method": { + "shortName": "SearchAllResources", + "fullName": "google.cloud.asset.v1.AssetService.SearchAllResources", + "service": { + "shortName": "AssetService", + "fullName": "google.cloud.asset.v1.AssetService" + } + } + } + }, + { + "regionTag": "cloudasset_v1_generated_AssetService_SearchAllIamPolicies_async", + "title": "AssetService searchAllIamPolicies Sample", + "origin": "API_DEFINITION", + "description": " Searches all IAM policies within the specified scope, such as a project, folder, or organization. The caller must be granted the `cloudasset.assets.searchAllIamPolicies` permission on the desired scope, otherwise the request will be rejected.", + "canonical": true, + "file": "asset_service.search_all_iam_policies.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 152, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "SearchAllIamPolicies", + "fullName": "google.cloud.asset.v1.AssetService.SearchAllIamPolicies", + "async": true, + "parameters": [ + { + "name": "scope", + "type": "TYPE_STRING" + }, + { + "name": "query", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "asset_types", + "type": "TYPE_STRING[]" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.asset.v1.SearchAllIamPoliciesResponse", + "client": { + "shortName": "AssetServiceClient", + "fullName": "google.cloud.asset.v1.AssetServiceClient" + }, + "method": { + "shortName": "SearchAllIamPolicies", + "fullName": "google.cloud.asset.v1.AssetService.SearchAllIamPolicies", + "service": { + "shortName": "AssetService", + "fullName": "google.cloud.asset.v1.AssetService" + } + } + } + }, + { + "regionTag": "cloudasset_v1_generated_AssetService_AnalyzeIamPolicy_async", + "title": "AssetService analyzeIamPolicy Sample", + "origin": "API_DEFINITION", + "description": " Analyzes IAM policies to answer which identities have what accesses on which resources.", + "canonical": true, + "file": "asset_service.analyze_iam_policy.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 81, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "AnalyzeIamPolicy", + "fullName": "google.cloud.asset.v1.AssetService.AnalyzeIamPolicy", + "async": true, + "parameters": [ + { + "name": "analysis_query", + "type": ".google.cloud.asset.v1.IamPolicyAnalysisQuery" + }, + { + "name": "saved_analysis_query", + "type": "TYPE_STRING" + }, + { + "name": "execution_timeout", + "type": ".google.protobuf.Duration" + } + ], + "resultType": ".google.cloud.asset.v1.AnalyzeIamPolicyResponse", + "client": { + "shortName": "AssetServiceClient", + "fullName": "google.cloud.asset.v1.AssetServiceClient" + }, + "method": { + "shortName": "AnalyzeIamPolicy", + "fullName": "google.cloud.asset.v1.AssetService.AnalyzeIamPolicy", + "service": { + "shortName": "AssetService", + "fullName": "google.cloud.asset.v1.AssetService" + } + } + } + }, + { + "regionTag": "cloudasset_v1_generated_AssetService_AnalyzeIamPolicyLongrunning_async", + "title": "AssetService analyzeIamPolicyLongrunning Sample", + "origin": "API_DEFINITION", + "description": " Analyzes IAM policies asynchronously to answer which identities have what accesses on which resources, and writes the analysis results to a Google Cloud Storage or a BigQuery destination. For Cloud Storage destination, the output format is the JSON format that represents a [AnalyzeIamPolicyResponse][google.cloud.asset.v1.AnalyzeIamPolicyResponse]. This method implements the [google.longrunning.Operation][google.longrunning.Operation], which allows you to track the operation status. We recommend intervals of at least 2 seconds with exponential backoff retry to poll the operation result. The metadata contains the metadata for the long-running operation.", + "canonical": true, + "file": "asset_service.analyze_iam_policy_longrunning.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 76, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "AnalyzeIamPolicyLongrunning", + "fullName": "google.cloud.asset.v1.AssetService.AnalyzeIamPolicyLongrunning", + "async": true, + "parameters": [ + { + "name": "analysis_query", + "type": ".google.cloud.asset.v1.IamPolicyAnalysisQuery" + }, + { + "name": "saved_analysis_query", + "type": "TYPE_STRING" + }, + { + "name": "output_config", + "type": ".google.cloud.asset.v1.IamPolicyAnalysisOutputConfig" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "AssetServiceClient", + "fullName": "google.cloud.asset.v1.AssetServiceClient" + }, + "method": { + "shortName": "AnalyzeIamPolicyLongrunning", + "fullName": "google.cloud.asset.v1.AssetService.AnalyzeIamPolicyLongrunning", + "service": { + "shortName": "AssetService", + "fullName": "google.cloud.asset.v1.AssetService" + } + } + } + }, + { + "regionTag": "cloudasset_v1_generated_AssetService_AnalyzeMove_async", + "title": "AssetService analyzeMove Sample", + "origin": "API_DEFINITION", + "description": " Analyze moving a resource to a specified destination without kicking off the actual move. The analysis is best effort depending on the user's permissions of viewing different hierarchical policies and configurations. The policies and configuration are subject to change before the actual resource migration takes place.", + "canonical": true, + "file": "asset_service.analyze_move.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 70, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "AnalyzeMove", + "fullName": "google.cloud.asset.v1.AssetService.AnalyzeMove", + "async": true, + "parameters": [ + { + "name": "resource", + "type": "TYPE_STRING" + }, + { + "name": "destination_parent", + "type": "TYPE_STRING" + }, + { + "name": "view", + "type": ".google.cloud.asset.v1.AnalyzeMoveRequest.AnalysisView" + } + ], + "resultType": ".google.cloud.asset.v1.AnalyzeMoveResponse", + "client": { + "shortName": "AssetServiceClient", + "fullName": "google.cloud.asset.v1.AssetServiceClient" + }, + "method": { + "shortName": "AnalyzeMove", + "fullName": "google.cloud.asset.v1.AssetService.AnalyzeMove", + "service": { + "shortName": "AssetService", + "fullName": "google.cloud.asset.v1.AssetService" + } + } + } + }, + { + "regionTag": "cloudasset_v1_generated_AssetService_QueryAssets_async", + "title": "AssetService queryAssets Sample", + "origin": "API_DEFINITION", + "description": " Issue a job that queries assets using a SQL statement compatible with [BigQuery Standard SQL](http://cloud/bigquery/docs/reference/standard-sql/enabling-standard-sql). If the query execution finishes within timeout and there's no pagination, the full query results will be returned in the `QueryAssetsResponse`. Otherwise, full query results can be obtained by issuing extra requests with the `job_reference` from the a previous `QueryAssets` call. Note, the query result has approximately 10 GB limitation enforced by BigQuery https://cloud.google.com/bigquery/docs/best-practices-performance-output, queries return larger results will result in errors.", + "canonical": true, + "file": "asset_service.query_assets.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 115, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "QueryAssets", + "fullName": "google.cloud.asset.v1.AssetService.QueryAssets", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "statement", + "type": "TYPE_STRING" + }, + { + "name": "job_reference", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "timeout", + "type": ".google.protobuf.Duration" + }, + { + "name": "read_time_window", + "type": ".google.cloud.asset.v1.TimeWindow" + }, + { + "name": "read_time", + "type": ".google.protobuf.Timestamp" + }, + { + "name": "output_config", + "type": ".google.cloud.asset.v1.QueryAssetsOutputConfig" + } + ], + "resultType": ".google.cloud.asset.v1.QueryAssetsResponse", + "client": { + "shortName": "AssetServiceClient", + "fullName": "google.cloud.asset.v1.AssetServiceClient" + }, + "method": { + "shortName": "QueryAssets", + "fullName": "google.cloud.asset.v1.AssetService.QueryAssets", + "service": { + "shortName": "AssetService", + "fullName": "google.cloud.asset.v1.AssetService" + } + } + } + }, + { + "regionTag": "cloudasset_v1_generated_AssetService_CreateSavedQuery_async", + "title": "AssetService createSavedQuery Sample", + "origin": "API_DEFINITION", + "description": " Creates a saved query in a parent project/folder/organization.", + "canonical": true, + "file": "asset_service.create_saved_query.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 74, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CreateSavedQuery", + "fullName": "google.cloud.asset.v1.AssetService.CreateSavedQuery", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "saved_query", + "type": ".google.cloud.asset.v1.SavedQuery" + }, + { + "name": "saved_query_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.asset.v1.SavedQuery", + "client": { + "shortName": "AssetServiceClient", + "fullName": "google.cloud.asset.v1.AssetServiceClient" + }, + "method": { + "shortName": "CreateSavedQuery", + "fullName": "google.cloud.asset.v1.AssetService.CreateSavedQuery", + "service": { + "shortName": "AssetService", + "fullName": "google.cloud.asset.v1.AssetService" + } + } + } + }, + { + "regionTag": "cloudasset_v1_generated_AssetService_GetSavedQuery_async", + "title": "AssetService getSavedQuery Sample", + "origin": "API_DEFINITION", + "description": " Gets details about a saved query.", + "canonical": true, + "file": "asset_service.get_saved_query.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 56, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetSavedQuery", + "fullName": "google.cloud.asset.v1.AssetService.GetSavedQuery", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.asset.v1.SavedQuery", + "client": { + "shortName": "AssetServiceClient", + "fullName": "google.cloud.asset.v1.AssetServiceClient" + }, + "method": { + "shortName": "GetSavedQuery", + "fullName": "google.cloud.asset.v1.AssetService.GetSavedQuery", + "service": { + "shortName": "AssetService", + "fullName": "google.cloud.asset.v1.AssetService" + } + } + } + }, + { + "regionTag": "cloudasset_v1_generated_AssetService_ListSavedQueries_async", + "title": "AssetService listSavedQueries Sample", + "origin": "API_DEFINITION", + "description": " Lists all saved queries in a parent project/folder/organization.", + "canonical": true, + "file": "asset_service.list_saved_queries.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 80, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListSavedQueries", + "fullName": "google.cloud.asset.v1.AssetService.ListSavedQueries", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.asset.v1.ListSavedQueriesResponse", + "client": { + "shortName": "AssetServiceClient", + "fullName": "google.cloud.asset.v1.AssetServiceClient" + }, + "method": { + "shortName": "ListSavedQueries", + "fullName": "google.cloud.asset.v1.AssetService.ListSavedQueries", + "service": { + "shortName": "AssetService", + "fullName": "google.cloud.asset.v1.AssetService" + } + } + } + }, + { + "regionTag": "cloudasset_v1_generated_AssetService_UpdateSavedQuery_async", + "title": "AssetService updateSavedQuery Sample", + "origin": "API_DEFINITION", + "description": " Updates a saved query.", + "canonical": true, + "file": "asset_service.update_saved_query.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 63, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "UpdateSavedQuery", + "fullName": "google.cloud.asset.v1.AssetService.UpdateSavedQuery", + "async": true, + "parameters": [ + { + "name": "saved_query", + "type": ".google.cloud.asset.v1.SavedQuery" + }, + { + "name": "update_mask", + "type": ".google.protobuf.FieldMask" + } + ], + "resultType": ".google.cloud.asset.v1.SavedQuery", + "client": { + "shortName": "AssetServiceClient", + "fullName": "google.cloud.asset.v1.AssetServiceClient" + }, + "method": { + "shortName": "UpdateSavedQuery", + "fullName": "google.cloud.asset.v1.AssetService.UpdateSavedQuery", + "service": { + "shortName": "AssetService", + "fullName": "google.cloud.asset.v1.AssetService" + } + } + } + }, + { + "regionTag": "cloudasset_v1_generated_AssetService_DeleteSavedQuery_async", + "title": "AssetService deleteSavedQuery Sample", + "origin": "API_DEFINITION", + "description": " Deletes a saved query.", + "canonical": true, + "file": "asset_service.delete_saved_query.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 57, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeleteSavedQuery", + "fullName": "google.cloud.asset.v1.AssetService.DeleteSavedQuery", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.protobuf.Empty", + "client": { + "shortName": "AssetServiceClient", + "fullName": "google.cloud.asset.v1.AssetServiceClient" + }, + "method": { + "shortName": "DeleteSavedQuery", + "fullName": "google.cloud.asset.v1.AssetService.DeleteSavedQuery", + "service": { + "shortName": "AssetService", + "fullName": "google.cloud.asset.v1.AssetService" + } + } + } + }, + { + "regionTag": "cloudasset_v1_generated_AssetService_BatchGetEffectiveIamPolicies_async", + "title": "AssetService batchGetEffectiveIamPolicies Sample", + "origin": "API_DEFINITION", + "description": " Gets effective IAM policies for a batch of resources.", + "canonical": true, + "file": "asset_service.batch_get_effective_iam_policies.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 69, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "BatchGetEffectiveIamPolicies", + "fullName": "google.cloud.asset.v1.AssetService.BatchGetEffectiveIamPolicies", + "async": true, + "parameters": [ + { + "name": "scope", + "type": "TYPE_STRING" + }, + { + "name": "names", + "type": "TYPE_STRING[]" + } + ], + "resultType": ".google.cloud.asset.v1.BatchGetEffectiveIamPoliciesResponse", + "client": { + "shortName": "AssetServiceClient", + "fullName": "google.cloud.asset.v1.AssetServiceClient" + }, + "method": { + "shortName": "BatchGetEffectiveIamPolicies", + "fullName": "google.cloud.asset.v1.AssetService.BatchGetEffectiveIamPolicies", + "service": { + "shortName": "AssetService", + "fullName": "google.cloud.asset.v1.AssetService" + } + } + } + }, + { + "regionTag": "cloudasset_v1_generated_AssetService_AnalyzeOrgPolicies_async", + "title": "AssetService analyzeOrgPolicies Sample", + "origin": "API_DEFINITION", + "description": " Analyzes organization policies under a scope.", + "canonical": true, + "file": "asset_service.analyze_org_policies.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 84, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "AnalyzeOrgPolicies", + "fullName": "google.cloud.asset.v1.AssetService.AnalyzeOrgPolicies", + "async": true, + "parameters": [ + { + "name": "scope", + "type": "TYPE_STRING" + }, + { + "name": "constraint", + "type": "TYPE_STRING" + }, + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.asset.v1.AnalyzeOrgPoliciesResponse", + "client": { + "shortName": "AssetServiceClient", + "fullName": "google.cloud.asset.v1.AssetServiceClient" + }, + "method": { + "shortName": "AnalyzeOrgPolicies", + "fullName": "google.cloud.asset.v1.AssetService.AnalyzeOrgPolicies", + "service": { + "shortName": "AssetService", + "fullName": "google.cloud.asset.v1.AssetService" + } + } + } + }, + { + "regionTag": "cloudasset_v1_generated_AssetService_AnalyzeOrgPolicyGovernedContainers_async", + "title": "AssetService analyzeOrgPolicyGovernedContainers Sample", + "origin": "API_DEFINITION", + "description": " Analyzes organization policies governed containers (projects, folders or organization) under a scope.", + "canonical": true, + "file": "asset_service.analyze_org_policy_governed_containers.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 85, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "AnalyzeOrgPolicyGovernedContainers", + "fullName": "google.cloud.asset.v1.AssetService.AnalyzeOrgPolicyGovernedContainers", + "async": true, + "parameters": [ + { + "name": "scope", + "type": "TYPE_STRING" + }, + { + "name": "constraint", + "type": "TYPE_STRING" + }, + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.asset.v1.AnalyzeOrgPolicyGovernedContainersResponse", + "client": { + "shortName": "AssetServiceClient", + "fullName": "google.cloud.asset.v1.AssetServiceClient" + }, + "method": { + "shortName": "AnalyzeOrgPolicyGovernedContainers", + "fullName": "google.cloud.asset.v1.AssetService.AnalyzeOrgPolicyGovernedContainers", + "service": { + "shortName": "AssetService", + "fullName": "google.cloud.asset.v1.AssetService" + } + } + } + }, + { + "regionTag": "cloudasset_v1_generated_AssetService_AnalyzeOrgPolicyGovernedAssets_async", + "title": "AssetService analyzeOrgPolicyGovernedAssets Sample", + "origin": "API_DEFINITION", + "description": " Analyzes organization policies governed assets (Google Cloud resources or policies) under a scope. This RPC supports custom constraints and the following 10 canned constraints: * storage.uniformBucketLevelAccess * iam.disableServiceAccountKeyCreation * iam.allowedPolicyMemberDomains * compute.vmExternalIpAccess * appengine.enforceServiceAccountActAsCheck * gcp.resourceLocations * compute.trustedImageProjects * compute.skipDefaultNetworkCreation * compute.requireOsLogin * compute.disableNestedVirtualization This RPC only returns either resources of types supported by [searchable asset types](https://cloud.google.com/asset-inventory/docs/supported-asset-types#searchable_asset_types), or IAM policies.", + "canonical": true, + "file": "asset_service.analyze_org_policy_governed_assets.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 89, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "AnalyzeOrgPolicyGovernedAssets", + "fullName": "google.cloud.asset.v1.AssetService.AnalyzeOrgPolicyGovernedAssets", + "async": true, + "parameters": [ + { + "name": "scope", + "type": "TYPE_STRING" + }, + { + "name": "constraint", + "type": "TYPE_STRING" + }, + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.asset.v1.AnalyzeOrgPolicyGovernedAssetsResponse", + "client": { + "shortName": "AssetServiceClient", + "fullName": "google.cloud.asset.v1.AssetServiceClient" + }, + "method": { + "shortName": "AnalyzeOrgPolicyGovernedAssets", + "fullName": "google.cloud.asset.v1.AssetService.AnalyzeOrgPolicyGovernedAssets", + "service": { + "shortName": "AssetService", + "fullName": "google.cloud.asset.v1.AssetService" + } + } + } + } + ] +} \ No newline at end of file diff --git a/packages/google-cloud-asset/samples/generated/v1p1beta1/asset_service.search_all_resources.js b/packages/google-cloud-asset/samples/generated/v1p1beta1/asset_service.search_all_resources.js index a2c354417d9..b3df6b43664 100644 --- a/packages/google-cloud-asset/samples/generated/v1p1beta1/asset_service.search_all_resources.js +++ b/packages/google-cloud-asset/samples/generated/v1p1beta1/asset_service.search_all_resources.js @@ -45,7 +45,7 @@ function main(scope) { * Optional. A list of asset types that this request searches for. If empty, * it will search all the supported asset types. */ - // const assetTypes = 'abc123' + // const assetTypes = ['abc','def'] /** * Optional. The page size for search result pagination. Page size is capped * at 500 even if a larger value is given. If set to zero, server will pick an diff --git a/packages/google-cloud-asset/samples/generated/v1p1beta1/snippet_metadata_google.cloud.asset.v1p1beta1.json b/packages/google-cloud-asset/samples/generated/v1p1beta1/snippet_metadata_google.cloud.asset.v1p1beta1.json new file mode 100644 index 00000000000..561740419bf --- /dev/null +++ b/packages/google-cloud-asset/samples/generated/v1p1beta1/snippet_metadata_google.cloud.asset.v1p1beta1.json @@ -0,0 +1,127 @@ +{ + "clientLibrary": { + "name": "nodejs-asset", + "version": "4.6.4", + "language": "TYPESCRIPT", + "apis": [ + { + "id": "google.cloud.asset.v1p1beta1", + "version": "v1p1beta1" + } + ] + }, + "snippets": [ + { + "regionTag": "cloudasset_v1p1beta1_generated_AssetService_SearchAllResources_async", + "title": "AssetService searchAllResources Sample", + "origin": "API_DEFINITION", + "description": " Searches all the resources within a given accessible Resource Manager scope (project/folder/organization). This RPC gives callers especially administrators the ability to search all the resources within a scope, even if they don't have `.get` permission of all the resources. Callers should have `cloud.assets.SearchAllResources` permission on the requested scope, otherwise the request will be rejected.", + "canonical": true, + "file": "asset_service.search_all_resources.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 91, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "SearchAllResources", + "fullName": "google.cloud.asset.v1p1beta1.AssetService.SearchAllResources", + "async": true, + "parameters": [ + { + "name": "scope", + "type": "TYPE_STRING" + }, + { + "name": "query", + "type": "TYPE_STRING" + }, + { + "name": "asset_types", + "type": "TYPE_STRING[]" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.asset.v1p1beta1.SearchAllResourcesResponse", + "client": { + "shortName": "AssetServiceClient", + "fullName": "google.cloud.asset.v1p1beta1.AssetServiceClient" + }, + "method": { + "shortName": "SearchAllResources", + "fullName": "google.cloud.asset.v1p1beta1.AssetService.SearchAllResources", + "service": { + "shortName": "AssetService", + "fullName": "google.cloud.asset.v1p1beta1.AssetService" + } + } + } + }, + { + "regionTag": "cloudasset_v1p1beta1_generated_AssetService_SearchAllIamPolicies_async", + "title": "AssetService searchAllIamPolicies Sample", + "origin": "API_DEFINITION", + "description": " Searches all the IAM policies within a given accessible Resource Manager scope (project/folder/organization). This RPC gives callers especially administrators the ability to search all the IAM policies within a scope, even if they don't have `.getIamPolicy` permission of all the IAM policies. Callers should have `cloud.assets.SearchAllIamPolicies` permission on the requested scope, otherwise the request will be rejected.", + "canonical": true, + "file": "asset_service.search_all_iam_policies.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 81, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "SearchAllIamPolicies", + "fullName": "google.cloud.asset.v1p1beta1.AssetService.SearchAllIamPolicies", + "async": true, + "parameters": [ + { + "name": "scope", + "type": "TYPE_STRING" + }, + { + "name": "query", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.asset.v1p1beta1.SearchAllIamPoliciesResponse", + "client": { + "shortName": "AssetServiceClient", + "fullName": "google.cloud.asset.v1p1beta1.AssetServiceClient" + }, + "method": { + "shortName": "SearchAllIamPolicies", + "fullName": "google.cloud.asset.v1p1beta1.AssetService.SearchAllIamPolicies", + "service": { + "shortName": "AssetService", + "fullName": "google.cloud.asset.v1p1beta1.AssetService" + } + } + } + } + ] +} \ No newline at end of file diff --git a/packages/google-cloud-asset/samples/generated/v1p2beta1/snippet_metadata_google.cloud.asset.v1p2beta1.json b/packages/google-cloud-asset/samples/generated/v1p2beta1/snippet_metadata_google.cloud.asset.v1p2beta1.json new file mode 100644 index 00000000000..17bbb395f53 --- /dev/null +++ b/packages/google-cloud-asset/samples/generated/v1p2beta1/snippet_metadata_google.cloud.asset.v1p2beta1.json @@ -0,0 +1,227 @@ +{ + "clientLibrary": { + "name": "nodejs-asset", + "version": "4.6.4", + "language": "TYPESCRIPT", + "apis": [ + { + "id": "google.cloud.asset.v1p2beta1", + "version": "v1p2beta1" + } + ] + }, + "snippets": [ + { + "regionTag": "cloudasset_v1p2beta1_generated_AssetService_CreateFeed_async", + "title": "AssetService createFeed Sample", + "origin": "API_DEFINITION", + "description": " Creates a feed in a parent project/folder/organization to listen to its asset updates.", + "canonical": true, + "file": "asset_service.create_feed.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 72, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CreateFeed", + "fullName": "google.cloud.asset.v1p2beta1.AssetService.CreateFeed", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "feed_id", + "type": "TYPE_STRING" + }, + { + "name": "feed", + "type": ".google.cloud.asset.v1p2beta1.Feed" + } + ], + "resultType": ".google.cloud.asset.v1p2beta1.Feed", + "client": { + "shortName": "AssetServiceClient", + "fullName": "google.cloud.asset.v1p2beta1.AssetServiceClient" + }, + "method": { + "shortName": "CreateFeed", + "fullName": "google.cloud.asset.v1p2beta1.AssetService.CreateFeed", + "service": { + "shortName": "AssetService", + "fullName": "google.cloud.asset.v1p2beta1.AssetService" + } + } + } + }, + { + "regionTag": "cloudasset_v1p2beta1_generated_AssetService_GetFeed_async", + "title": "AssetService getFeed Sample", + "origin": "API_DEFINITION", + "description": " Gets details about an asset feed.", + "canonical": true, + "file": "asset_service.get_feed.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 56, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetFeed", + "fullName": "google.cloud.asset.v1p2beta1.AssetService.GetFeed", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.asset.v1p2beta1.Feed", + "client": { + "shortName": "AssetServiceClient", + "fullName": "google.cloud.asset.v1p2beta1.AssetServiceClient" + }, + "method": { + "shortName": "GetFeed", + "fullName": "google.cloud.asset.v1p2beta1.AssetService.GetFeed", + "service": { + "shortName": "AssetService", + "fullName": "google.cloud.asset.v1p2beta1.AssetService" + } + } + } + }, + { + "regionTag": "cloudasset_v1p2beta1_generated_AssetService_ListFeeds_async", + "title": "AssetService listFeeds Sample", + "origin": "API_DEFINITION", + "description": " Lists all asset feeds in a parent project/folder/organization.", + "canonical": true, + "file": "asset_service.list_feeds.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 55, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListFeeds", + "fullName": "google.cloud.asset.v1p2beta1.AssetService.ListFeeds", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.asset.v1p2beta1.ListFeedsResponse", + "client": { + "shortName": "AssetServiceClient", + "fullName": "google.cloud.asset.v1p2beta1.AssetServiceClient" + }, + "method": { + "shortName": "ListFeeds", + "fullName": "google.cloud.asset.v1p2beta1.AssetService.ListFeeds", + "service": { + "shortName": "AssetService", + "fullName": "google.cloud.asset.v1p2beta1.AssetService" + } + } + } + }, + { + "regionTag": "cloudasset_v1p2beta1_generated_AssetService_UpdateFeed_async", + "title": "AssetService updateFeed Sample", + "origin": "API_DEFINITION", + "description": " Updates an asset feed configuration.", + "canonical": true, + "file": "asset_service.update_feed.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 64, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "UpdateFeed", + "fullName": "google.cloud.asset.v1p2beta1.AssetService.UpdateFeed", + "async": true, + "parameters": [ + { + "name": "feed", + "type": ".google.cloud.asset.v1p2beta1.Feed" + }, + { + "name": "update_mask", + "type": ".google.protobuf.FieldMask" + } + ], + "resultType": ".google.cloud.asset.v1p2beta1.Feed", + "client": { + "shortName": "AssetServiceClient", + "fullName": "google.cloud.asset.v1p2beta1.AssetServiceClient" + }, + "method": { + "shortName": "UpdateFeed", + "fullName": "google.cloud.asset.v1p2beta1.AssetService.UpdateFeed", + "service": { + "shortName": "AssetService", + "fullName": "google.cloud.asset.v1p2beta1.AssetService" + } + } + } + }, + { + "regionTag": "cloudasset_v1p2beta1_generated_AssetService_DeleteFeed_async", + "title": "AssetService deleteFeed Sample", + "origin": "API_DEFINITION", + "description": " Deletes an asset feed.", + "canonical": true, + "file": "asset_service.delete_feed.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 56, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeleteFeed", + "fullName": "google.cloud.asset.v1p2beta1.AssetService.DeleteFeed", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.protobuf.Empty", + "client": { + "shortName": "AssetServiceClient", + "fullName": "google.cloud.asset.v1p2beta1.AssetServiceClient" + }, + "method": { + "shortName": "DeleteFeed", + "fullName": "google.cloud.asset.v1p2beta1.AssetService.DeleteFeed", + "service": { + "shortName": "AssetService", + "fullName": "google.cloud.asset.v1p2beta1.AssetService" + } + } + } + } + ] +} \ No newline at end of file diff --git a/packages/google-cloud-asset/samples/generated/v1p5beta1/asset_service.list_assets.js b/packages/google-cloud-asset/samples/generated/v1p5beta1/asset_service.list_assets.js index 94e4d91131f..c79af27bb3a 100644 --- a/packages/google-cloud-asset/samples/generated/v1p5beta1/asset_service.list_assets.js +++ b/packages/google-cloud-asset/samples/generated/v1p5beta1/asset_service.list_assets.js @@ -59,7 +59,7 @@ function main(parent) { * Inventory (https://cloud.google.com/asset-inventory/docs/overview) * for all supported asset types. */ - // const assetTypes = 'abc123' + // const assetTypes = ['abc','def'] /** * Asset content type. If not specified, no content but the asset name will * be returned. diff --git a/packages/google-cloud-asset/samples/generated/v1p5beta1/snippet_metadata_google.cloud.asset.v1p5beta1.json b/packages/google-cloud-asset/samples/generated/v1p5beta1/snippet_metadata_google.cloud.asset.v1p5beta1.json new file mode 100644 index 00000000000..18ec64ca924 --- /dev/null +++ b/packages/google-cloud-asset/samples/generated/v1p5beta1/snippet_metadata_google.cloud.asset.v1p5beta1.json @@ -0,0 +1,75 @@ +{ + "clientLibrary": { + "name": "nodejs-asset", + "version": "4.6.4", + "language": "TYPESCRIPT", + "apis": [ + { + "id": "google.cloud.asset.v1p5beta1", + "version": "v1p5beta1" + } + ] + }, + "snippets": [ + { + "regionTag": "cloudasset_v1p5beta1_generated_AssetService_ListAssets_async", + "title": "AssetService listAssets Sample", + "origin": "API_DEFINITION", + "description": " Lists assets with time and resource types and returns paged results in response.", + "canonical": true, + "file": "asset_service.list_assets.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 99, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListAssets", + "fullName": "google.cloud.asset.v1p5beta1.AssetService.ListAssets", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "read_time", + "type": ".google.protobuf.Timestamp" + }, + { + "name": "asset_types", + "type": "TYPE_STRING[]" + }, + { + "name": "content_type", + "type": ".google.cloud.asset.v1p5beta1.ContentType" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.asset.v1p5beta1.ListAssetsResponse", + "client": { + "shortName": "AssetServiceClient", + "fullName": "google.cloud.asset.v1p5beta1.AssetServiceClient" + }, + "method": { + "shortName": "ListAssets", + "fullName": "google.cloud.asset.v1p5beta1.AssetService.ListAssets", + "service": { + "shortName": "AssetService", + "fullName": "google.cloud.asset.v1p5beta1.AssetService" + } + } + } + } + ] +} \ No newline at end of file diff --git a/packages/google-cloud-asset/samples/generated/v1p7beta1/asset_service.export_assets.js b/packages/google-cloud-asset/samples/generated/v1p7beta1/asset_service.export_assets.js index c226bdc0499..55eee85ec7c 100644 --- a/packages/google-cloud-asset/samples/generated/v1p7beta1/asset_service.export_assets.js +++ b/packages/google-cloud-asset/samples/generated/v1p7beta1/asset_service.export_assets.js @@ -59,7 +59,7 @@ function main(parent, outputConfig) { * Inventory (https://cloud.google.com/asset-inventory/docs/overview) * for all supported asset types. */ - // const assetTypes = 'abc123' + // const assetTypes = ['abc','def'] /** * Asset content type. If not specified, no content but the asset name will be * returned. @@ -82,7 +82,7 @@ function main(parent, outputConfig) { * Inventory (https://cloud.google.com/asset-inventory/docs/overview) for all * supported asset types and relationship types. */ - // const relationshipTypes = 'abc123' + // const relationshipTypes = ['abc','def'] // Imports the Asset library const {AssetServiceClient} = require('@google-cloud/asset').v1p7beta1; diff --git a/packages/google-cloud-asset/samples/generated/v1p7beta1/snippet_metadata_google.cloud.asset.v1p7beta1.json b/packages/google-cloud-asset/samples/generated/v1p7beta1/snippet_metadata_google.cloud.asset.v1p7beta1.json new file mode 100644 index 00000000000..4db4d28bdb6 --- /dev/null +++ b/packages/google-cloud-asset/samples/generated/v1p7beta1/snippet_metadata_google.cloud.asset.v1p7beta1.json @@ -0,0 +1,75 @@ +{ + "clientLibrary": { + "name": "nodejs-asset", + "version": "4.6.4", + "language": "TYPESCRIPT", + "apis": [ + { + "id": "google.cloud.asset.v1p7beta1", + "version": "v1p7beta1" + } + ] + }, + "snippets": [ + { + "regionTag": "cloudasset_v1p7beta1_generated_AssetService_ExportAssets_async", + "title": "AssetService exportAssets Sample", + "origin": "API_DEFINITION", + "description": " Exports assets with time and resource types to a given Cloud Storage location/BigQuery table. For Cloud Storage location destinations, the output format is newline-delimited JSON. Each line represents a [google.cloud.asset.v1p7beta1.Asset][google.cloud.asset.v1p7beta1.Asset] in the JSON format; for BigQuery table destinations, the output table stores the fields in asset proto as columns. This API implements the [google.longrunning.Operation][google.longrunning.Operation] API , which allows you to keep track of the export. We recommend intervals of at least 2 seconds with exponential retry to poll the export operation result. For regular-size resource parent, the export operation usually finishes within 5 minutes.", + "canonical": true, + "file": "asset_service.export_assets.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 106, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ExportAssets", + "fullName": "google.cloud.asset.v1p7beta1.AssetService.ExportAssets", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "read_time", + "type": ".google.protobuf.Timestamp" + }, + { + "name": "asset_types", + "type": "TYPE_STRING[]" + }, + { + "name": "content_type", + "type": ".google.cloud.asset.v1p7beta1.ContentType" + }, + { + "name": "output_config", + "type": ".google.cloud.asset.v1p7beta1.OutputConfig" + }, + { + "name": "relationship_types", + "type": "TYPE_STRING[]" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "AssetServiceClient", + "fullName": "google.cloud.asset.v1p7beta1.AssetServiceClient" + }, + "method": { + "shortName": "ExportAssets", + "fullName": "google.cloud.asset.v1p7beta1.AssetService.ExportAssets", + "service": { + "shortName": "AssetService", + "fullName": "google.cloud.asset.v1p7beta1.AssetService" + } + } + } + } + ] +} \ No newline at end of file diff --git a/packages/google-cloud-asset/samples/package.json b/packages/google-cloud-asset/samples/package.json index d9a12305de8..0ed838c8836 100644 --- a/packages/google-cloud-asset/samples/package.json +++ b/packages/google-cloud-asset/samples/package.json @@ -4,7 +4,7 @@ "license": "Apache-2.0", "author": "Google Inc.", "engines": { - "node": ">=12.0.0" + "node": ">=14.0.0" }, "files": [ "*.js" @@ -26,4 +26,4 @@ "chai": "^4.2.0", "mocha": "^8.0.0" } -} +} \ No newline at end of file diff --git a/packages/google-cloud-asset/src/v1/asset_service_client.ts b/packages/google-cloud-asset/src/v1/asset_service_client.ts index f4a47a1d0fe..b5fa6bee69c 100644 --- a/packages/google-cloud-asset/src/v1/asset_service_client.ts +++ b/packages/google-cloud-asset/src/v1/asset_service_client.ts @@ -519,9 +519,8 @@ export class AssetServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.asset.v1.BatchGetAssetsHistoryResponse | BatchGetAssetsHistoryResponse}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.asset.v1.BatchGetAssetsHistoryResponse|BatchGetAssetsHistoryResponse}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/asset_service.batch_get_assets_history.js * region_tag:cloudasset_v1_generated_AssetService_BatchGetAssetsHistory_async @@ -623,9 +622,8 @@ export class AssetServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.asset.v1.Feed | Feed}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.asset.v1.Feed|Feed}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/asset_service.create_feed.js * region_tag:cloudasset_v1_generated_AssetService_CreateFeed_async @@ -709,9 +707,8 @@ export class AssetServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.asset.v1.Feed | Feed}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.asset.v1.Feed|Feed}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/asset_service.get_feed.js * region_tag:cloudasset_v1_generated_AssetService_GetFeed_async @@ -794,9 +791,8 @@ export class AssetServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.asset.v1.ListFeedsResponse | ListFeedsResponse}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.asset.v1.ListFeedsResponse|ListFeedsResponse}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/asset_service.list_feeds.js * region_tag:cloudasset_v1_generated_AssetService_ListFeeds_async @@ -885,9 +881,8 @@ export class AssetServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.asset.v1.Feed | Feed}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.asset.v1.Feed|Feed}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/asset_service.update_feed.js * region_tag:cloudasset_v1_generated_AssetService_UpdateFeed_async @@ -971,9 +966,8 @@ export class AssetServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.protobuf.Empty | Empty}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.protobuf.Empty|Empty}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/asset_service.delete_feed.js * region_tag:cloudasset_v1_generated_AssetService_DeleteFeed_async @@ -1084,9 +1078,8 @@ export class AssetServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.asset.v1.AnalyzeIamPolicyResponse | AnalyzeIamPolicyResponse}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.asset.v1.AnalyzeIamPolicyResponse|AnalyzeIamPolicyResponse}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/asset_service.analyze_iam_policy.js * region_tag:cloudasset_v1_generated_AssetService_AnalyzeIamPolicy_async @@ -1185,9 +1178,8 @@ export class AssetServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.asset.v1.AnalyzeMoveResponse | AnalyzeMoveResponse}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.asset.v1.AnalyzeMoveResponse|AnalyzeMoveResponse}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/asset_service.analyze_move.js * region_tag:cloudasset_v1_generated_AssetService_AnalyzeMove_async @@ -1335,9 +1327,8 @@ export class AssetServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.asset.v1.QueryAssetsResponse | QueryAssetsResponse}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.asset.v1.QueryAssetsResponse|QueryAssetsResponse}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/asset_service.query_assets.js * region_tag:cloudasset_v1_generated_AssetService_QueryAssets_async @@ -1428,16 +1419,15 @@ export class AssetServiceClient { * resource name. * * This value should be 4-63 characters, and valid characters - * are `{@link 0-9|a-z}-`. + * are `{@link protos.0-9|a-z}-`. * * Notice that this field is required in the saved query creation, and the * `name` field of the `saved_query` will be ignored. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.asset.v1.SavedQuery | SavedQuery}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.asset.v1.SavedQuery|SavedQuery}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/asset_service.create_saved_query.js * region_tag:cloudasset_v1_generated_AssetService_CreateSavedQuery_async @@ -1524,9 +1514,8 @@ export class AssetServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.asset.v1.SavedQuery | SavedQuery}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.asset.v1.SavedQuery|SavedQuery}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/asset_service.get_saved_query.js * region_tag:cloudasset_v1_generated_AssetService_GetSavedQuery_async @@ -1616,9 +1605,8 @@ export class AssetServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.asset.v1.SavedQuery | SavedQuery}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.asset.v1.SavedQuery|SavedQuery}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/asset_service.update_saved_query.js * region_tag:cloudasset_v1_generated_AssetService_UpdateSavedQuery_async @@ -1706,9 +1694,8 @@ export class AssetServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.protobuf.Empty | Empty}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.protobuf.Empty|Empty}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/asset_service.delete_saved_query.js * region_tag:cloudasset_v1_generated_AssetService_DeleteSavedQuery_async @@ -1807,9 +1794,8 @@ export class AssetServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.asset.v1.BatchGetEffectiveIamPoliciesResponse | BatchGetEffectiveIamPoliciesResponse}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.asset.v1.BatchGetEffectiveIamPoliciesResponse|BatchGetEffectiveIamPoliciesResponse}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/asset_service.batch_get_effective_iam_policies.js * region_tag:cloudasset_v1_generated_AssetService_BatchGetEffectiveIamPolicies_async @@ -1903,10 +1889,10 @@ export class AssetServiceClient { * Exports assets with time and resource types to a given Cloud Storage * location/BigQuery table. For Cloud Storage location destinations, the * output format is newline-delimited JSON. Each line represents a - * {@link google.cloud.asset.v1.Asset|google.cloud.asset.v1.Asset} in the JSON + * {@link protos.google.cloud.asset.v1.Asset|google.cloud.asset.v1.Asset} in the JSON * format; for BigQuery table destinations, the output table stores the fields * in asset Protobuf as columns. This API implements the - * {@link google.longrunning.Operation|google.longrunning.Operation} API, which + * {@link protos.google.longrunning.Operation|google.longrunning.Operation} API, which * allows you to keep track of the export. We recommend intervals of at least * 2 seconds with exponential retry to poll the export operation result. For * regular-size resource parent, the export operation usually finishes within @@ -1972,8 +1958,7 @@ export class AssetServiceClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/asset_service.export_assets.js * region_tag:cloudasset_v1_generated_AssetService_ExportAssets_async @@ -2068,8 +2053,7 @@ export class AssetServiceClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/asset_service.export_assets.js * region_tag:cloudasset_v1_generated_AssetService_ExportAssets_async @@ -2102,9 +2086,9 @@ export class AssetServiceClient { * accesses on which resources, and writes the analysis results to a Google * Cloud Storage or a BigQuery destination. For Cloud Storage destination, the * output format is the JSON format that represents a - * {@link google.cloud.asset.v1.AnalyzeIamPolicyResponse|AnalyzeIamPolicyResponse}. + * {@link protos.google.cloud.asset.v1.AnalyzeIamPolicyResponse|AnalyzeIamPolicyResponse}. * This method implements the - * {@link google.longrunning.Operation|google.longrunning.Operation}, which allows + * {@link protos.google.longrunning.Operation|google.longrunning.Operation}, which allows * you to track the operation status. We recommend intervals of at least 2 * seconds with exponential backoff retry to poll the operation result. The * metadata contains the metadata for the long-running operation. @@ -2139,8 +2123,7 @@ export class AssetServiceClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/asset_service.analyze_iam_policy_longrunning.js * region_tag:cloudasset_v1_generated_AssetService_AnalyzeIamPolicyLongrunning_async @@ -2239,8 +2222,7 @@ export class AssetServiceClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/asset_service.analyze_iam_policy_longrunning.js * region_tag:cloudasset_v1_generated_AssetService_AnalyzeIamPolicyLongrunning_async @@ -2334,14 +2316,13 @@ export class AssetServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.cloud.asset.v1.Asset | Asset}. + * The first element of the array is Array of {@link protos.google.cloud.asset.v1.Asset|Asset}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `listAssetsAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listAssets( @@ -2475,13 +2456,12 @@ export class AssetServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.cloud.asset.v1.Asset | Asset} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.asset.v1.Asset|Asset} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listAssetsAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listAssetsStream( @@ -2572,12 +2552,11 @@ export class AssetServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.cloud.asset.v1.Asset | Asset}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.asset.v1.Asset|Asset}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1/asset_service.list_assets.js * region_tag:cloudasset_v1_generated_AssetService_ListAssets_async @@ -2762,14 +2741,13 @@ export class AssetServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.cloud.asset.v1.ResourceSearchResult | ResourceSearchResult}. + * The first element of the array is Array of {@link protos.google.cloud.asset.v1.ResourceSearchResult|ResourceSearchResult}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `searchAllResourcesAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ searchAllResources( @@ -3002,13 +2980,12 @@ export class AssetServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.cloud.asset.v1.ResourceSearchResult | ResourceSearchResult} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.asset.v1.ResourceSearchResult|ResourceSearchResult} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `searchAllResourcesAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ searchAllResourcesStream( @@ -3190,12 +3167,11 @@ export class AssetServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.cloud.asset.v1.ResourceSearchResult | ResourceSearchResult}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.asset.v1.ResourceSearchResult|ResourceSearchResult}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1/asset_service.search_all_resources.js * region_tag:cloudasset_v1_generated_AssetService_SearchAllResources_async @@ -3328,14 +3304,13 @@ export class AssetServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.cloud.asset.v1.IamPolicySearchResult | IamPolicySearchResult}. + * The first element of the array is Array of {@link protos.google.cloud.asset.v1.IamPolicySearchResult|IamPolicySearchResult}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `searchAllIamPoliciesAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ searchAllIamPolicies( @@ -3516,13 +3491,12 @@ export class AssetServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.cloud.asset.v1.IamPolicySearchResult | IamPolicySearchResult} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.asset.v1.IamPolicySearchResult|IamPolicySearchResult} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `searchAllIamPoliciesAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ searchAllIamPoliciesStream( @@ -3652,12 +3626,11 @@ export class AssetServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.cloud.asset.v1.IamPolicySearchResult | IamPolicySearchResult}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.asset.v1.IamPolicySearchResult|IamPolicySearchResult}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1/asset_service.search_all_iam_policies.js * region_tag:cloudasset_v1_generated_AssetService_SearchAllIamPolicies_async @@ -3714,14 +3687,13 @@ export class AssetServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.cloud.asset.v1.SavedQuery | SavedQuery}. + * The first element of the array is Array of {@link protos.google.cloud.asset.v1.SavedQuery|SavedQuery}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `listSavedQueriesAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listSavedQueries( @@ -3823,13 +3795,12 @@ export class AssetServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.cloud.asset.v1.SavedQuery | SavedQuery} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.asset.v1.SavedQuery|SavedQuery} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listSavedQueriesAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listSavedQueriesStream( @@ -3886,12 +3857,11 @@ export class AssetServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.cloud.asset.v1.SavedQuery | SavedQuery}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.asset.v1.SavedQuery|SavedQuery}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1/asset_service.list_saved_queries.js * region_tag:cloudasset_v1_generated_AssetService_ListSavedQueries_async @@ -3933,7 +3903,7 @@ export class AssetServiceClient { * constraint. * @param {string} request.filter * The expression to filter - * {@link google.cloud.asset.v1.AnalyzeOrgPoliciesResponse.org_policy_results|AnalyzeOrgPoliciesResponse.org_policy_results}. + * {@link protos.google.cloud.asset.v1.AnalyzeOrgPoliciesResponse.org_policy_results|AnalyzeOrgPoliciesResponse.org_policy_results}. * The only supported field is `consolidated_policy.attached_resource`, and * the only supported operator is `=`. * @@ -3942,21 +3912,20 @@ export class AssetServiceClient { * will return the org policy results of"folders/001". * @param {number} request.pageSize * The maximum number of items to return per page. If unspecified, - * {@link google.cloud.asset.v1.AnalyzeOrgPoliciesResponse.org_policy_results|AnalyzeOrgPoliciesResponse.org_policy_results} + * {@link protos.google.cloud.asset.v1.AnalyzeOrgPoliciesResponse.org_policy_results|AnalyzeOrgPoliciesResponse.org_policy_results} * will contain 20 items with a maximum of 200. * @param {string} request.pageToken * The pagination token to retrieve the next page. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.cloud.asset.v1.AnalyzeOrgPoliciesResponse.OrgPolicyResult | OrgPolicyResult}. + * The first element of the array is Array of {@link protos.google.cloud.asset.v1.AnalyzeOrgPoliciesResponse.OrgPolicyResult|OrgPolicyResult}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `analyzeOrgPoliciesAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ analyzeOrgPolicies( @@ -4049,7 +4018,7 @@ export class AssetServiceClient { * constraint. * @param {string} request.filter * The expression to filter - * {@link google.cloud.asset.v1.AnalyzeOrgPoliciesResponse.org_policy_results|AnalyzeOrgPoliciesResponse.org_policy_results}. + * {@link protos.google.cloud.asset.v1.AnalyzeOrgPoliciesResponse.org_policy_results|AnalyzeOrgPoliciesResponse.org_policy_results}. * The only supported field is `consolidated_policy.attached_resource`, and * the only supported operator is `=`. * @@ -4058,20 +4027,19 @@ export class AssetServiceClient { * will return the org policy results of"folders/001". * @param {number} request.pageSize * The maximum number of items to return per page. If unspecified, - * {@link google.cloud.asset.v1.AnalyzeOrgPoliciesResponse.org_policy_results|AnalyzeOrgPoliciesResponse.org_policy_results} + * {@link protos.google.cloud.asset.v1.AnalyzeOrgPoliciesResponse.org_policy_results|AnalyzeOrgPoliciesResponse.org_policy_results} * will contain 20 items with a maximum of 200. * @param {string} request.pageToken * The pagination token to retrieve the next page. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.cloud.asset.v1.AnalyzeOrgPoliciesResponse.OrgPolicyResult | OrgPolicyResult} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.asset.v1.AnalyzeOrgPoliciesResponse.OrgPolicyResult|OrgPolicyResult} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `analyzeOrgPoliciesAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ analyzeOrgPoliciesStream( @@ -4113,7 +4081,7 @@ export class AssetServiceClient { * constraint. * @param {string} request.filter * The expression to filter - * {@link google.cloud.asset.v1.AnalyzeOrgPoliciesResponse.org_policy_results|AnalyzeOrgPoliciesResponse.org_policy_results}. + * {@link protos.google.cloud.asset.v1.AnalyzeOrgPoliciesResponse.org_policy_results|AnalyzeOrgPoliciesResponse.org_policy_results}. * The only supported field is `consolidated_policy.attached_resource`, and * the only supported operator is `=`. * @@ -4122,19 +4090,18 @@ export class AssetServiceClient { * will return the org policy results of"folders/001". * @param {number} request.pageSize * The maximum number of items to return per page. If unspecified, - * {@link google.cloud.asset.v1.AnalyzeOrgPoliciesResponse.org_policy_results|AnalyzeOrgPoliciesResponse.org_policy_results} + * {@link protos.google.cloud.asset.v1.AnalyzeOrgPoliciesResponse.org_policy_results|AnalyzeOrgPoliciesResponse.org_policy_results} * will contain 20 items with a maximum of 200. * @param {string} request.pageToken * The pagination token to retrieve the next page. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.cloud.asset.v1.AnalyzeOrgPoliciesResponse.OrgPolicyResult | OrgPolicyResult}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.asset.v1.AnalyzeOrgPoliciesResponse.OrgPolicyResult|OrgPolicyResult}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1/asset_service.analyze_org_policies.js * region_tag:cloudasset_v1_generated_AssetService_AnalyzeOrgPolicies_async @@ -4187,21 +4154,20 @@ export class AssetServiceClient { * containers under "folders/001". * @param {number} request.pageSize * The maximum number of items to return per page. If unspecified, - * {@link google.cloud.asset.v1.AnalyzeOrgPolicyGovernedContainersResponse.governed_containers|AnalyzeOrgPolicyGovernedContainersResponse.governed_containers} + * {@link protos.google.cloud.asset.v1.AnalyzeOrgPolicyGovernedContainersResponse.governed_containers|AnalyzeOrgPolicyGovernedContainersResponse.governed_containers} * will contain 100 items with a maximum of 200. * @param {string} request.pageToken * The pagination token to retrieve the next page. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.cloud.asset.v1.AnalyzeOrgPolicyGovernedContainersResponse.GovernedContainer | GovernedContainer}. + * The first element of the array is Array of {@link protos.google.cloud.asset.v1.AnalyzeOrgPolicyGovernedContainersResponse.GovernedContainer|GovernedContainer}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `analyzeOrgPolicyGovernedContainersAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ analyzeOrgPolicyGovernedContainers( @@ -4308,20 +4274,19 @@ export class AssetServiceClient { * containers under "folders/001". * @param {number} request.pageSize * The maximum number of items to return per page. If unspecified, - * {@link google.cloud.asset.v1.AnalyzeOrgPolicyGovernedContainersResponse.governed_containers|AnalyzeOrgPolicyGovernedContainersResponse.governed_containers} + * {@link protos.google.cloud.asset.v1.AnalyzeOrgPolicyGovernedContainersResponse.governed_containers|AnalyzeOrgPolicyGovernedContainersResponse.governed_containers} * will contain 100 items with a maximum of 200. * @param {string} request.pageToken * The pagination token to retrieve the next page. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.cloud.asset.v1.AnalyzeOrgPolicyGovernedContainersResponse.GovernedContainer | GovernedContainer} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.asset.v1.AnalyzeOrgPolicyGovernedContainersResponse.GovernedContainer|GovernedContainer} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `analyzeOrgPolicyGovernedContainersAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ analyzeOrgPolicyGovernedContainersStream( @@ -4374,19 +4339,18 @@ export class AssetServiceClient { * containers under "folders/001". * @param {number} request.pageSize * The maximum number of items to return per page. If unspecified, - * {@link google.cloud.asset.v1.AnalyzeOrgPolicyGovernedContainersResponse.governed_containers|AnalyzeOrgPolicyGovernedContainersResponse.governed_containers} + * {@link protos.google.cloud.asset.v1.AnalyzeOrgPolicyGovernedContainersResponse.governed_containers|AnalyzeOrgPolicyGovernedContainersResponse.governed_containers} * will contain 100 items with a maximum of 200. * @param {string} request.pageToken * The pagination token to retrieve the next page. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.cloud.asset.v1.AnalyzeOrgPolicyGovernedContainersResponse.GovernedContainer | GovernedContainer}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.asset.v1.AnalyzeOrgPolicyGovernedContainersResponse.GovernedContainer|GovernedContainer}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1/asset_service.analyze_org_policy_governed_containers.js * region_tag:cloudasset_v1_generated_AssetService_AnalyzeOrgPolicyGovernedContainers_async @@ -4462,21 +4426,20 @@ export class AssetServiceClient { * return all governed iam policies under folders/12345678, if applicable. * @param {number} request.pageSize * The maximum number of items to return per page. If unspecified, - * {@link google.cloud.asset.v1.AnalyzeOrgPolicyGovernedAssetsResponse.governed_assets|AnalyzeOrgPolicyGovernedAssetsResponse.governed_assets} + * {@link protos.google.cloud.asset.v1.AnalyzeOrgPolicyGovernedAssetsResponse.governed_assets|AnalyzeOrgPolicyGovernedAssetsResponse.governed_assets} * will contain 100 items with a maximum of 200. * @param {string} request.pageToken * The pagination token to retrieve the next page. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.cloud.asset.v1.AnalyzeOrgPolicyGovernedAssetsResponse.GovernedAsset | GovernedAsset}. + * The first element of the array is Array of {@link protos.google.cloud.asset.v1.AnalyzeOrgPolicyGovernedAssetsResponse.GovernedAsset|GovernedAsset}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `analyzeOrgPolicyGovernedAssetsAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ analyzeOrgPolicyGovernedAssets( @@ -4588,20 +4551,19 @@ export class AssetServiceClient { * return all governed iam policies under folders/12345678, if applicable. * @param {number} request.pageSize * The maximum number of items to return per page. If unspecified, - * {@link google.cloud.asset.v1.AnalyzeOrgPolicyGovernedAssetsResponse.governed_assets|AnalyzeOrgPolicyGovernedAssetsResponse.governed_assets} + * {@link protos.google.cloud.asset.v1.AnalyzeOrgPolicyGovernedAssetsResponse.governed_assets|AnalyzeOrgPolicyGovernedAssetsResponse.governed_assets} * will contain 100 items with a maximum of 200. * @param {string} request.pageToken * The pagination token to retrieve the next page. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.cloud.asset.v1.AnalyzeOrgPolicyGovernedAssetsResponse.GovernedAsset | GovernedAsset} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.asset.v1.AnalyzeOrgPolicyGovernedAssetsResponse.GovernedAsset|GovernedAsset} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `analyzeOrgPolicyGovernedAssetsAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ analyzeOrgPolicyGovernedAssetsStream( @@ -4659,19 +4621,18 @@ export class AssetServiceClient { * return all governed iam policies under folders/12345678, if applicable. * @param {number} request.pageSize * The maximum number of items to return per page. If unspecified, - * {@link google.cloud.asset.v1.AnalyzeOrgPolicyGovernedAssetsResponse.governed_assets|AnalyzeOrgPolicyGovernedAssetsResponse.governed_assets} + * {@link protos.google.cloud.asset.v1.AnalyzeOrgPolicyGovernedAssetsResponse.governed_assets|AnalyzeOrgPolicyGovernedAssetsResponse.governed_assets} * will contain 100 items with a maximum of 200. * @param {string} request.pageToken * The pagination token to retrieve the next page. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.cloud.asset.v1.AnalyzeOrgPolicyGovernedAssetsResponse.GovernedAsset | GovernedAsset}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.asset.v1.AnalyzeOrgPolicyGovernedAssetsResponse.GovernedAsset|GovernedAsset}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1/asset_service.analyze_org_policy_governed_assets.js * region_tag:cloudasset_v1_generated_AssetService_AnalyzeOrgPolicyGovernedAssets_async diff --git a/packages/google-cloud-asset/src/v1p1beta1/asset_service_client.ts b/packages/google-cloud-asset/src/v1p1beta1/asset_service_client.ts index 148743e31a9..4373cf72035 100644 --- a/packages/google-cloud-asset/src/v1p1beta1/asset_service_client.ts +++ b/packages/google-cloud-asset/src/v1p1beta1/asset_service_client.ts @@ -367,14 +367,13 @@ export class AssetServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.cloud.asset.v1p1beta1.StandardResourceMetadata | StandardResourceMetadata}. + * The first element of the array is Array of {@link protos.google.cloud.asset.v1p1beta1.StandardResourceMetadata|StandardResourceMetadata}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `searchAllResourcesAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ searchAllResources( @@ -488,13 +487,12 @@ export class AssetServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.cloud.asset.v1p1beta1.StandardResourceMetadata | StandardResourceMetadata} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.asset.v1p1beta1.StandardResourceMetadata|StandardResourceMetadata} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `searchAllResourcesAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ searchAllResourcesStream( @@ -557,12 +555,11 @@ export class AssetServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.cloud.asset.v1p1beta1.StandardResourceMetadata | StandardResourceMetadata}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.asset.v1p1beta1.StandardResourceMetadata|StandardResourceMetadata}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1p1beta1/asset_service.search_all_resources.js * region_tag:cloudasset_v1p1beta1_generated_AssetService_SearchAllResources_async @@ -625,14 +622,13 @@ export class AssetServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.cloud.asset.v1p1beta1.IamPolicySearchResult | IamPolicySearchResult}. + * The first element of the array is Array of {@link protos.google.cloud.asset.v1p1beta1.IamPolicySearchResult|IamPolicySearchResult}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `searchAllIamPoliciesAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ searchAllIamPolicies( @@ -741,13 +737,12 @@ export class AssetServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.cloud.asset.v1p1beta1.IamPolicySearchResult | IamPolicySearchResult} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.asset.v1p1beta1.IamPolicySearchResult|IamPolicySearchResult} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `searchAllIamPoliciesAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ searchAllIamPoliciesStream( @@ -805,12 +800,11 @@ export class AssetServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.cloud.asset.v1p1beta1.IamPolicySearchResult | IamPolicySearchResult}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.asset.v1p1beta1.IamPolicySearchResult|IamPolicySearchResult}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1p1beta1/asset_service.search_all_iam_policies.js * region_tag:cloudasset_v1p1beta1_generated_AssetService_SearchAllIamPolicies_async diff --git a/packages/google-cloud-asset/src/v1p2beta1/asset_service_client.ts b/packages/google-cloud-asset/src/v1p2beta1/asset_service_client.ts index b20309d13b4..463cb43757c 100644 --- a/packages/google-cloud-asset/src/v1p2beta1/asset_service_client.ts +++ b/packages/google-cloud-asset/src/v1p2beta1/asset_service_client.ts @@ -349,9 +349,8 @@ export class AssetServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.asset.v1p2beta1.Feed | Feed}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.asset.v1p2beta1.Feed|Feed}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1p2beta1/asset_service.create_feed.js * region_tag:cloudasset_v1p2beta1_generated_AssetService_CreateFeed_async @@ -437,9 +436,8 @@ export class AssetServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.asset.v1p2beta1.Feed | Feed}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.asset.v1p2beta1.Feed|Feed}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1p2beta1/asset_service.get_feed.js * region_tag:cloudasset_v1p2beta1_generated_AssetService_GetFeed_async @@ -524,9 +522,8 @@ export class AssetServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.asset.v1p2beta1.ListFeedsResponse | ListFeedsResponse}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.asset.v1p2beta1.ListFeedsResponse|ListFeedsResponse}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1p2beta1/asset_service.list_feeds.js * region_tag:cloudasset_v1p2beta1_generated_AssetService_ListFeeds_async @@ -617,9 +614,8 @@ export class AssetServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.asset.v1p2beta1.Feed | Feed}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.asset.v1p2beta1.Feed|Feed}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1p2beta1/asset_service.update_feed.js * region_tag:cloudasset_v1p2beta1_generated_AssetService_UpdateFeed_async @@ -705,9 +701,8 @@ export class AssetServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.protobuf.Empty | Empty}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.protobuf.Empty|Empty}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1p2beta1/asset_service.delete_feed.js * region_tag:cloudasset_v1p2beta1_generated_AssetService_DeleteFeed_async diff --git a/packages/google-cloud-asset/src/v1p5beta1/asset_service_client.ts b/packages/google-cloud-asset/src/v1p5beta1/asset_service_client.ts index 445c4ea0247..3096fcc5f34 100644 --- a/packages/google-cloud-asset/src/v1p5beta1/asset_service_client.ts +++ b/packages/google-cloud-asset/src/v1p5beta1/asset_service_client.ts @@ -382,14 +382,13 @@ export class AssetServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.cloud.asset.v1p5beta1.Asset | Asset}. + * The first element of the array is Array of {@link protos.google.cloud.asset.v1p5beta1.Asset|Asset}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `listAssetsAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listAssets( @@ -514,13 +513,12 @@ export class AssetServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.cloud.asset.v1p5beta1.Asset | Asset} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.asset.v1p5beta1.Asset|Asset} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listAssetsAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listAssetsStream( @@ -594,12 +592,11 @@ export class AssetServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.cloud.asset.v1p5beta1.Asset | Asset}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.asset.v1p5beta1.Asset|Asset}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1p5beta1/asset_service.list_assets.js * region_tag:cloudasset_v1p5beta1_generated_AssetService_ListAssets_async diff --git a/packages/google-cloud-asset/src/v1p7beta1/asset_service_client.ts b/packages/google-cloud-asset/src/v1p7beta1/asset_service_client.ts index cdd382fc6e8..be9f7f9d446 100644 --- a/packages/google-cloud-asset/src/v1p7beta1/asset_service_client.ts +++ b/packages/google-cloud-asset/src/v1p7beta1/asset_service_client.ts @@ -362,10 +362,10 @@ export class AssetServiceClient { * Exports assets with time and resource types to a given Cloud Storage * location/BigQuery table. For Cloud Storage location destinations, the * output format is newline-delimited JSON. Each line represents a - * {@link google.cloud.asset.v1p7beta1.Asset|google.cloud.asset.v1p7beta1.Asset} in + * {@link protos.google.cloud.asset.v1p7beta1.Asset|google.cloud.asset.v1p7beta1.Asset} in * the JSON format; for BigQuery table destinations, the output table stores * the fields in asset proto as columns. This API implements the - * {@link google.longrunning.Operation|google.longrunning.Operation} API , which + * {@link protos.google.longrunning.Operation|google.longrunning.Operation} API , which * allows you to keep track of the export. We recommend intervals of at least * 2 seconds with exponential retry to poll the export operation result. For * regular-size resource parent, the export operation usually finishes within @@ -426,8 +426,7 @@ export class AssetServiceClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1p7beta1/asset_service.export_assets.js * region_tag:cloudasset_v1p7beta1_generated_AssetService_ExportAssets_async @@ -522,8 +521,7 @@ export class AssetServiceClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1p7beta1/asset_service.export_assets.js * region_tag:cloudasset_v1p7beta1_generated_AssetService_ExportAssets_async diff --git a/packages/google-cloud-assuredworkloads/README.md b/packages/google-cloud-assuredworkloads/README.md index 9a609031a4b..f3de0aa6380 100644 --- a/packages/google-cloud-assuredworkloads/README.md +++ b/packages/google-cloud-assuredworkloads/README.md @@ -2,7 +2,7 @@ [//]: # "To regenerate it, use `python -m synthtool`." Google Cloud Platform logo -# [Assured Workloads for Government: Node.js Client](https://github.com/googleapis/google-cloud-node) +# [Assured Workloads for Government: Node.js Client](https://github.com/googleapis/google-cloud-node/tree/main/packages/google-cloud-assuredworkloads) [![release level](https://img.shields.io/badge/release%20level-stable-brightgreen.svg?style=flat)](https://cloud.google.com/terms/launch-stages) [![npm version](https://img.shields.io/npm/v/@google-cloud/assured-workloads.svg)](https://www.npmjs.org/package/@google-cloud/assured-workloads) @@ -83,29 +83,28 @@ listWorkloads(); ## Samples -Samples are in the [`samples/`](https://github.com/googleapis/google-cloud-node/tree/main/samples) directory. Each sample's `README.md` has instructions for running its sample. +Samples are in the [`samples/`](https://github.com/googleapis/google-cloud-node/tree/main/packages/google-cloud-assuredworkloads/samples) directory. Each sample's `README.md` has instructions for running its sample. | Sample | Source Code | Try it | | --------------------------- | --------------------------------- | ------ | -| Assured_workloads_service.acknowledge_violation | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-assuredworkloads/samples/generated/v1/assured_workloads_service.acknowledge_violation.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-assuredworkloads/samples/generated/v1/assured_workloads_service.acknowledge_violation.js,samples/README.md) | -| Assured_workloads_service.create_workload | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-assuredworkloads/samples/generated/v1/assured_workloads_service.create_workload.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-assuredworkloads/samples/generated/v1/assured_workloads_service.create_workload.js,samples/README.md) | -| Assured_workloads_service.delete_workload | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-assuredworkloads/samples/generated/v1/assured_workloads_service.delete_workload.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-assuredworkloads/samples/generated/v1/assured_workloads_service.delete_workload.js,samples/README.md) | -| Assured_workloads_service.get_violation | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-assuredworkloads/samples/generated/v1/assured_workloads_service.get_violation.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-assuredworkloads/samples/generated/v1/assured_workloads_service.get_violation.js,samples/README.md) | -| Assured_workloads_service.get_workload | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-assuredworkloads/samples/generated/v1/assured_workloads_service.get_workload.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-assuredworkloads/samples/generated/v1/assured_workloads_service.get_workload.js,samples/README.md) | -| Assured_workloads_service.list_violations | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-assuredworkloads/samples/generated/v1/assured_workloads_service.list_violations.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-assuredworkloads/samples/generated/v1/assured_workloads_service.list_violations.js,samples/README.md) | -| Assured_workloads_service.list_workloads | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-assuredworkloads/samples/generated/v1/assured_workloads_service.list_workloads.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-assuredworkloads/samples/generated/v1/assured_workloads_service.list_workloads.js,samples/README.md) | -| Assured_workloads_service.restrict_allowed_resources | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-assuredworkloads/samples/generated/v1/assured_workloads_service.restrict_allowed_resources.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-assuredworkloads/samples/generated/v1/assured_workloads_service.restrict_allowed_resources.js,samples/README.md) | -| Assured_workloads_service.update_workload | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-assuredworkloads/samples/generated/v1/assured_workloads_service.update_workload.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-assuredworkloads/samples/generated/v1/assured_workloads_service.update_workload.js,samples/README.md) | -| Assured_workloads_service.analyze_workload_move | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-assuredworkloads/samples/generated/v1beta1/assured_workloads_service.analyze_workload_move.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-assuredworkloads/samples/generated/v1beta1/assured_workloads_service.analyze_workload_move.js,samples/README.md) | -| Assured_workloads_service.create_workload | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-assuredworkloads/samples/generated/v1beta1/assured_workloads_service.create_workload.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-assuredworkloads/samples/generated/v1beta1/assured_workloads_service.create_workload.js,samples/README.md) | -| Assured_workloads_service.delete_workload | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-assuredworkloads/samples/generated/v1beta1/assured_workloads_service.delete_workload.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-assuredworkloads/samples/generated/v1beta1/assured_workloads_service.delete_workload.js,samples/README.md) | -| Assured_workloads_service.get_workload | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-assuredworkloads/samples/generated/v1beta1/assured_workloads_service.get_workload.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-assuredworkloads/samples/generated/v1beta1/assured_workloads_service.get_workload.js,samples/README.md) | -| Assured_workloads_service.list_workloads | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-assuredworkloads/samples/generated/v1beta1/assured_workloads_service.list_workloads.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-assuredworkloads/samples/generated/v1beta1/assured_workloads_service.list_workloads.js,samples/README.md) | -| Assured_workloads_service.restrict_allowed_resources | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-assuredworkloads/samples/generated/v1beta1/assured_workloads_service.restrict_allowed_resources.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-assuredworkloads/samples/generated/v1beta1/assured_workloads_service.restrict_allowed_resources.js,samples/README.md) | -| Assured_workloads_service.restrict_allowed_services | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-assuredworkloads/samples/generated/v1beta1/assured_workloads_service.restrict_allowed_services.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-assuredworkloads/samples/generated/v1beta1/assured_workloads_service.restrict_allowed_services.js,samples/README.md) | -| Assured_workloads_service.update_workload | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-assuredworkloads/samples/generated/v1beta1/assured_workloads_service.update_workload.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-assuredworkloads/samples/generated/v1beta1/assured_workloads_service.update_workload.js,samples/README.md) | -| Quickstart | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-assuredworkloads/samples/quickstart.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-assuredworkloads/samples/quickstart.js,samples/README.md) | -| Quickstart | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-assuredworkloads/samples/test/quickstart.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-assuredworkloads/samples/test/quickstart.js,samples/README.md) | +| Assured_workloads_service.acknowledge_violation | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-assuredworkloads/samples/generated/v1/assured_workloads_service.acknowledge_violation.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-assuredworkloads/samples/generated/v1/assured_workloads_service.acknowledge_violation.js,packages/google-cloud-assuredworkloads/samples/README.md) | +| Assured_workloads_service.create_workload | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-assuredworkloads/samples/generated/v1/assured_workloads_service.create_workload.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-assuredworkloads/samples/generated/v1/assured_workloads_service.create_workload.js,packages/google-cloud-assuredworkloads/samples/README.md) | +| Assured_workloads_service.delete_workload | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-assuredworkloads/samples/generated/v1/assured_workloads_service.delete_workload.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-assuredworkloads/samples/generated/v1/assured_workloads_service.delete_workload.js,packages/google-cloud-assuredworkloads/samples/README.md) | +| Assured_workloads_service.get_violation | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-assuredworkloads/samples/generated/v1/assured_workloads_service.get_violation.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-assuredworkloads/samples/generated/v1/assured_workloads_service.get_violation.js,packages/google-cloud-assuredworkloads/samples/README.md) | +| Assured_workloads_service.get_workload | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-assuredworkloads/samples/generated/v1/assured_workloads_service.get_workload.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-assuredworkloads/samples/generated/v1/assured_workloads_service.get_workload.js,packages/google-cloud-assuredworkloads/samples/README.md) | +| Assured_workloads_service.list_violations | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-assuredworkloads/samples/generated/v1/assured_workloads_service.list_violations.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-assuredworkloads/samples/generated/v1/assured_workloads_service.list_violations.js,packages/google-cloud-assuredworkloads/samples/README.md) | +| Assured_workloads_service.list_workloads | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-assuredworkloads/samples/generated/v1/assured_workloads_service.list_workloads.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-assuredworkloads/samples/generated/v1/assured_workloads_service.list_workloads.js,packages/google-cloud-assuredworkloads/samples/README.md) | +| Assured_workloads_service.restrict_allowed_resources | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-assuredworkloads/samples/generated/v1/assured_workloads_service.restrict_allowed_resources.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-assuredworkloads/samples/generated/v1/assured_workloads_service.restrict_allowed_resources.js,packages/google-cloud-assuredworkloads/samples/README.md) | +| Assured_workloads_service.update_workload | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-assuredworkloads/samples/generated/v1/assured_workloads_service.update_workload.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-assuredworkloads/samples/generated/v1/assured_workloads_service.update_workload.js,packages/google-cloud-assuredworkloads/samples/README.md) | +| Assured_workloads_service.analyze_workload_move | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-assuredworkloads/samples/generated/v1beta1/assured_workloads_service.analyze_workload_move.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-assuredworkloads/samples/generated/v1beta1/assured_workloads_service.analyze_workload_move.js,packages/google-cloud-assuredworkloads/samples/README.md) | +| Assured_workloads_service.create_workload | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-assuredworkloads/samples/generated/v1beta1/assured_workloads_service.create_workload.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-assuredworkloads/samples/generated/v1beta1/assured_workloads_service.create_workload.js,packages/google-cloud-assuredworkloads/samples/README.md) | +| Assured_workloads_service.delete_workload | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-assuredworkloads/samples/generated/v1beta1/assured_workloads_service.delete_workload.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-assuredworkloads/samples/generated/v1beta1/assured_workloads_service.delete_workload.js,packages/google-cloud-assuredworkloads/samples/README.md) | +| Assured_workloads_service.get_workload | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-assuredworkloads/samples/generated/v1beta1/assured_workloads_service.get_workload.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-assuredworkloads/samples/generated/v1beta1/assured_workloads_service.get_workload.js,packages/google-cloud-assuredworkloads/samples/README.md) | +| Assured_workloads_service.list_workloads | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-assuredworkloads/samples/generated/v1beta1/assured_workloads_service.list_workloads.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-assuredworkloads/samples/generated/v1beta1/assured_workloads_service.list_workloads.js,packages/google-cloud-assuredworkloads/samples/README.md) | +| Assured_workloads_service.restrict_allowed_resources | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-assuredworkloads/samples/generated/v1beta1/assured_workloads_service.restrict_allowed_resources.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-assuredworkloads/samples/generated/v1beta1/assured_workloads_service.restrict_allowed_resources.js,packages/google-cloud-assuredworkloads/samples/README.md) | +| Assured_workloads_service.restrict_allowed_services | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-assuredworkloads/samples/generated/v1beta1/assured_workloads_service.restrict_allowed_services.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-assuredworkloads/samples/generated/v1beta1/assured_workloads_service.restrict_allowed_services.js,packages/google-cloud-assuredworkloads/samples/README.md) | +| Assured_workloads_service.update_workload | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-assuredworkloads/samples/generated/v1beta1/assured_workloads_service.update_workload.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-assuredworkloads/samples/generated/v1beta1/assured_workloads_service.update_workload.js,packages/google-cloud-assuredworkloads/samples/README.md) | +| Quickstart | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-assuredworkloads/samples/quickstart.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-assuredworkloads/samples/quickstart.js,packages/google-cloud-assuredworkloads/samples/README.md) | diff --git a/packages/google-cloud-assuredworkloads/package.json b/packages/google-cloud-assuredworkloads/package.json index d1270000219..0a12b079716 100644 --- a/packages/google-cloud-assuredworkloads/package.json +++ b/packages/google-cloud-assuredworkloads/package.json @@ -45,14 +45,15 @@ "test": "c8 mocha build/test" }, "dependencies": { - "google-gax": "^3.5.8" + "google-gax": "^4.0.3" }, "devDependencies": { "@types/mocha": "^9.0.0", - "@types/node": "^18.0.0", + "@types/node": "^20.4.5", "@types/sinon": "^10.0.0", "c8": "^7.3.0", - "gts": "^3.1.0", + "gapic-tools": "^0.1.8", + "gts": "^5.0.0", "jsdoc": "^4.0.0", "jsdoc-fresh": "^2.0.0", "jsdoc-region-tag": "^2.0.0", @@ -63,12 +64,12 @@ "pack-n-play": "^1.0.0-2", "sinon": "^15.0.0", "ts-loader": "^9.0.0", - "typescript": "^4.6.4", + "typescript": "^5.1.6", "webpack": "^5.0.0", "webpack-cli": "^5.0.0" }, "engines": { - "node": ">=12.0.0" + "node": ">=14.0.0" }, "homepage": "https://github.com/googleapis/google-cloud-node/tree/main/packages/google-cloud-assuredworkloads" } diff --git a/packages/google-cloud-assuredworkloads/samples/README.md b/packages/google-cloud-assuredworkloads/samples/README.md index e9a5ea069fd..c5b748acde5 100644 --- a/packages/google-cloud-assuredworkloads/samples/README.md +++ b/packages/google-cloud-assuredworkloads/samples/README.md @@ -30,7 +30,6 @@ * [Assured_workloads_service.restrict_allowed_services](#assured_workloads_service.restrict_allowed_services) * [Assured_workloads_service.update_workload](#assured_workloads_service.update_workload) * [Quickstart](#quickstart) - * [Quickstart](#quickstart) ## Before you begin @@ -348,23 +347,6 @@ __Usage:__ `node packages/google-cloud-assuredworkloads/samples/quickstart.js` ------ - - - - -### Quickstart - -View the [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-assuredworkloads/samples/test/quickstart.js). - -[![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-assuredworkloads/samples/test/quickstart.js,samples/README.md) - -__Usage:__ - - -`node packages/google-cloud-assuredworkloads/samples/test/quickstart.js` - - diff --git a/packages/google-cloud-assuredworkloads/samples/generated/v1/snippet_metadata.google.cloud.assuredworkloads.v1.json b/packages/google-cloud-assuredworkloads/samples/generated/v1/snippet_metadata.google.cloud.assuredworkloads.v1.json index 6a2859854ff..0ccc79df0b4 100644 --- a/packages/google-cloud-assuredworkloads/samples/generated/v1/snippet_metadata.google.cloud.assuredworkloads.v1.json +++ b/packages/google-cloud-assuredworkloads/samples/generated/v1/snippet_metadata.google.cloud.assuredworkloads.v1.json @@ -1,7 +1,7 @@ { "clientLibrary": { "name": "nodejs-assuredworkloads", - "version": "3.6.0", + "version": "3.6.2", "language": "TYPESCRIPT", "apis": [ { diff --git a/packages/google-cloud-assuredworkloads/samples/generated/v1/snippet_metadata_google.cloud.assuredworkloads.v1.json b/packages/google-cloud-assuredworkloads/samples/generated/v1/snippet_metadata_google.cloud.assuredworkloads.v1.json new file mode 100644 index 00000000000..0ccc79df0b4 --- /dev/null +++ b/packages/google-cloud-assuredworkloads/samples/generated/v1/snippet_metadata_google.cloud.assuredworkloads.v1.json @@ -0,0 +1,431 @@ +{ + "clientLibrary": { + "name": "nodejs-assuredworkloads", + "version": "3.6.2", + "language": "TYPESCRIPT", + "apis": [ + { + "id": "google.cloud.assuredworkloads.v1", + "version": "v1" + } + ] + }, + "snippets": [ + { + "regionTag": "assuredworkloads_v1_generated_AssuredWorkloadsService_CreateWorkload_async", + "title": "AssuredWorkloadsService createWorkload Sample", + "origin": "API_DEFINITION", + "description": " Creates Assured Workload.", + "canonical": true, + "file": "assured_workloads_service.create_workload.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 67, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CreateWorkload", + "fullName": "google.cloud.assuredworkloads.v1.AssuredWorkloadsService.CreateWorkload", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "workload", + "type": ".google.cloud.assuredworkloads.v1.Workload" + }, + { + "name": "external_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "AssuredWorkloadsServiceClient", + "fullName": "google.cloud.assuredworkloads.v1.AssuredWorkloadsServiceClient" + }, + "method": { + "shortName": "CreateWorkload", + "fullName": "google.cloud.assuredworkloads.v1.AssuredWorkloadsService.CreateWorkload", + "service": { + "shortName": "AssuredWorkloadsService", + "fullName": "google.cloud.assuredworkloads.v1.AssuredWorkloadsService" + } + } + } + }, + { + "regionTag": "assuredworkloads_v1_generated_AssuredWorkloadsService_UpdateWorkload_async", + "title": "AssuredWorkloadsService updateWorkload Sample", + "origin": "API_DEFINITION", + "description": " Updates an existing workload. Currently allows updating of workload display_name and labels. For force updates don't set etag field in the Workload. Only one update operation per workload can be in progress.", + "canonical": true, + "file": "assured_workloads_service.update_workload.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 61, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "UpdateWorkload", + "fullName": "google.cloud.assuredworkloads.v1.AssuredWorkloadsService.UpdateWorkload", + "async": true, + "parameters": [ + { + "name": "workload", + "type": ".google.cloud.assuredworkloads.v1.Workload" + }, + { + "name": "update_mask", + "type": ".google.protobuf.FieldMask" + } + ], + "resultType": ".google.cloud.assuredworkloads.v1.Workload", + "client": { + "shortName": "AssuredWorkloadsServiceClient", + "fullName": "google.cloud.assuredworkloads.v1.AssuredWorkloadsServiceClient" + }, + "method": { + "shortName": "UpdateWorkload", + "fullName": "google.cloud.assuredworkloads.v1.AssuredWorkloadsService.UpdateWorkload", + "service": { + "shortName": "AssuredWorkloadsService", + "fullName": "google.cloud.assuredworkloads.v1.AssuredWorkloadsService" + } + } + } + }, + { + "regionTag": "assuredworkloads_v1_generated_AssuredWorkloadsService_RestrictAllowedResources_async", + "title": "AssuredWorkloadsService restrictAllowedResources Sample", + "origin": "API_DEFINITION", + "description": " Restrict the list of resources allowed in the Workload environment. The current list of allowed products can be found at https://cloud.google.com/assured-workloads/docs/supported-products In addition to assuredworkloads.workload.update permission, the user should also have orgpolicy.policy.set permission on the folder resource to use this functionality.", + "canonical": true, + "file": "assured_workloads_service.restrict_allowed_resources.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 62, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "RestrictAllowedResources", + "fullName": "google.cloud.assuredworkloads.v1.AssuredWorkloadsService.RestrictAllowedResources", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + }, + { + "name": "restriction_type", + "type": ".google.cloud.assuredworkloads.v1.RestrictAllowedResourcesRequest.RestrictionType" + } + ], + "resultType": ".google.cloud.assuredworkloads.v1.RestrictAllowedResourcesResponse", + "client": { + "shortName": "AssuredWorkloadsServiceClient", + "fullName": "google.cloud.assuredworkloads.v1.AssuredWorkloadsServiceClient" + }, + "method": { + "shortName": "RestrictAllowedResources", + "fullName": "google.cloud.assuredworkloads.v1.AssuredWorkloadsService.RestrictAllowedResources", + "service": { + "shortName": "AssuredWorkloadsService", + "fullName": "google.cloud.assuredworkloads.v1.AssuredWorkloadsService" + } + } + } + }, + { + "regionTag": "assuredworkloads_v1_generated_AssuredWorkloadsService_DeleteWorkload_async", + "title": "AssuredWorkloadsService deleteWorkload Sample", + "origin": "API_DEFINITION", + "description": " Deletes the workload. Make sure that workload's direct children are already in a deleted state, otherwise the request will fail with a FAILED_PRECONDITION error.", + "canonical": true, + "file": "assured_workloads_service.delete_workload.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 60, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeleteWorkload", + "fullName": "google.cloud.assuredworkloads.v1.AssuredWorkloadsService.DeleteWorkload", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + }, + { + "name": "etag", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.protobuf.Empty", + "client": { + "shortName": "AssuredWorkloadsServiceClient", + "fullName": "google.cloud.assuredworkloads.v1.AssuredWorkloadsServiceClient" + }, + "method": { + "shortName": "DeleteWorkload", + "fullName": "google.cloud.assuredworkloads.v1.AssuredWorkloadsService.DeleteWorkload", + "service": { + "shortName": "AssuredWorkloadsService", + "fullName": "google.cloud.assuredworkloads.v1.AssuredWorkloadsService" + } + } + } + }, + { + "regionTag": "assuredworkloads_v1_generated_AssuredWorkloadsService_GetWorkload_async", + "title": "AssuredWorkloadsService getWorkload Sample", + "origin": "API_DEFINITION", + "description": " Gets Assured Workload associated with a CRM Node", + "canonical": true, + "file": "assured_workloads_service.get_workload.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 57, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetWorkload", + "fullName": "google.cloud.assuredworkloads.v1.AssuredWorkloadsService.GetWorkload", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.assuredworkloads.v1.Workload", + "client": { + "shortName": "AssuredWorkloadsServiceClient", + "fullName": "google.cloud.assuredworkloads.v1.AssuredWorkloadsServiceClient" + }, + "method": { + "shortName": "GetWorkload", + "fullName": "google.cloud.assuredworkloads.v1.AssuredWorkloadsService.GetWorkload", + "service": { + "shortName": "AssuredWorkloadsService", + "fullName": "google.cloud.assuredworkloads.v1.AssuredWorkloadsService" + } + } + } + }, + { + "regionTag": "assuredworkloads_v1_generated_AssuredWorkloadsService_ListWorkloads_async", + "title": "AssuredWorkloadsService listWorkloads Sample", + "origin": "API_DEFINITION", + "description": " Lists Assured Workloads under a CRM Node.", + "canonical": true, + "file": "assured_workloads_service.list_workloads.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 71, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListWorkloads", + "fullName": "google.cloud.assuredworkloads.v1.AssuredWorkloadsService.ListWorkloads", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "filter", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.assuredworkloads.v1.ListWorkloadsResponse", + "client": { + "shortName": "AssuredWorkloadsServiceClient", + "fullName": "google.cloud.assuredworkloads.v1.AssuredWorkloadsServiceClient" + }, + "method": { + "shortName": "ListWorkloads", + "fullName": "google.cloud.assuredworkloads.v1.AssuredWorkloadsService.ListWorkloads", + "service": { + "shortName": "AssuredWorkloadsService", + "fullName": "google.cloud.assuredworkloads.v1.AssuredWorkloadsService" + } + } + } + }, + { + "regionTag": "assuredworkloads_v1_generated_AssuredWorkloadsService_ListViolations_async", + "title": "AssuredWorkloadsService listViolations Sample", + "origin": "API_DEFINITION", + "description": " Lists the Violations in the AssuredWorkload Environment. Callers may also choose to read across multiple Workloads as per [AIP-159](https://google.aip.dev/159) by using '-' (the hyphen or dash character) as a wildcard character instead of workload-id in the parent. Format `organizations/{org_id}/locations/{location}/workloads/-`", + "canonical": true, + "file": "assured_workloads_service.list_violations.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 74, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListViolations", + "fullName": "google.cloud.assuredworkloads.v1.AssuredWorkloadsService.ListViolations", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "interval", + "type": ".google.cloud.assuredworkloads.v1.TimeWindow" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "filter", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.assuredworkloads.v1.ListViolationsResponse", + "client": { + "shortName": "AssuredWorkloadsServiceClient", + "fullName": "google.cloud.assuredworkloads.v1.AssuredWorkloadsServiceClient" + }, + "method": { + "shortName": "ListViolations", + "fullName": "google.cloud.assuredworkloads.v1.AssuredWorkloadsService.ListViolations", + "service": { + "shortName": "AssuredWorkloadsService", + "fullName": "google.cloud.assuredworkloads.v1.AssuredWorkloadsService" + } + } + } + }, + { + "regionTag": "assuredworkloads_v1_generated_AssuredWorkloadsService_GetViolation_async", + "title": "AssuredWorkloadsService getViolation Sample", + "origin": "API_DEFINITION", + "description": " Retrieves Assured Workload Violation based on ID.", + "canonical": true, + "file": "assured_workloads_service.get_violation.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 55, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetViolation", + "fullName": "google.cloud.assuredworkloads.v1.AssuredWorkloadsService.GetViolation", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.assuredworkloads.v1.Violation", + "client": { + "shortName": "AssuredWorkloadsServiceClient", + "fullName": "google.cloud.assuredworkloads.v1.AssuredWorkloadsServiceClient" + }, + "method": { + "shortName": "GetViolation", + "fullName": "google.cloud.assuredworkloads.v1.AssuredWorkloadsService.GetViolation", + "service": { + "shortName": "AssuredWorkloadsService", + "fullName": "google.cloud.assuredworkloads.v1.AssuredWorkloadsService" + } + } + } + }, + { + "regionTag": "assuredworkloads_v1_generated_AssuredWorkloadsService_AcknowledgeViolation_async", + "title": "AssuredWorkloadsService acknowledgeViolation Sample", + "origin": "API_DEFINITION", + "description": " Acknowledges an existing violation. By acknowledging a violation, users acknowledge the existence of a compliance violation in their workload and decide to ignore it due to a valid business justification. Acknowledgement is a permanent operation and it cannot be reverted.", + "canonical": true, + "file": "assured_workloads_service.acknowledge_violation.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 70, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "AcknowledgeViolation", + "fullName": "google.cloud.assuredworkloads.v1.AssuredWorkloadsService.AcknowledgeViolation", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + }, + { + "name": "comment", + "type": "TYPE_STRING" + }, + { + "name": "non_compliant_org_policy", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.assuredworkloads.v1.AcknowledgeViolationResponse", + "client": { + "shortName": "AssuredWorkloadsServiceClient", + "fullName": "google.cloud.assuredworkloads.v1.AssuredWorkloadsServiceClient" + }, + "method": { + "shortName": "AcknowledgeViolation", + "fullName": "google.cloud.assuredworkloads.v1.AssuredWorkloadsService.AcknowledgeViolation", + "service": { + "shortName": "AssuredWorkloadsService", + "fullName": "google.cloud.assuredworkloads.v1.AssuredWorkloadsService" + } + } + } + } + ] +} \ No newline at end of file diff --git a/packages/google-cloud-assuredworkloads/samples/generated/v1beta1/snippet_metadata.google.cloud.assuredworkloads.v1beta1.json b/packages/google-cloud-assuredworkloads/samples/generated/v1beta1/snippet_metadata.google.cloud.assuredworkloads.v1beta1.json index d7ee837c471..07b88481b6d 100644 --- a/packages/google-cloud-assuredworkloads/samples/generated/v1beta1/snippet_metadata.google.cloud.assuredworkloads.v1beta1.json +++ b/packages/google-cloud-assuredworkloads/samples/generated/v1beta1/snippet_metadata.google.cloud.assuredworkloads.v1beta1.json @@ -1,7 +1,7 @@ { "clientLibrary": { "name": "nodejs-assuredworkloads", - "version": "3.6.0", + "version": "3.6.2", "language": "TYPESCRIPT", "apis": [ { diff --git a/packages/google-cloud-assuredworkloads/samples/generated/v1beta1/snippet_metadata_google.cloud.assuredworkloads.v1beta1.json b/packages/google-cloud-assuredworkloads/samples/generated/v1beta1/snippet_metadata_google.cloud.assuredworkloads.v1beta1.json new file mode 100644 index 00000000000..07b88481b6d --- /dev/null +++ b/packages/google-cloud-assuredworkloads/samples/generated/v1beta1/snippet_metadata_google.cloud.assuredworkloads.v1beta1.json @@ -0,0 +1,335 @@ +{ + "clientLibrary": { + "name": "nodejs-assuredworkloads", + "version": "3.6.2", + "language": "TYPESCRIPT", + "apis": [ + { + "id": "google.cloud.assuredworkloads.v1beta1", + "version": "v1beta1" + } + ] + }, + "snippets": [ + { + "regionTag": "assuredworkloads_v1beta1_generated_AssuredWorkloadsService_CreateWorkload_async", + "title": "AssuredWorkloadsService createWorkload Sample", + "origin": "API_DEFINITION", + "description": " Creates Assured Workload.", + "canonical": true, + "file": "assured_workloads_service.create_workload.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 67, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CreateWorkload", + "fullName": "google.cloud.assuredworkloads.v1beta1.AssuredWorkloadsService.CreateWorkload", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "workload", + "type": ".google.cloud.assuredworkloads.v1beta1.Workload" + }, + { + "name": "external_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "AssuredWorkloadsServiceClient", + "fullName": "google.cloud.assuredworkloads.v1beta1.AssuredWorkloadsServiceClient" + }, + "method": { + "shortName": "CreateWorkload", + "fullName": "google.cloud.assuredworkloads.v1beta1.AssuredWorkloadsService.CreateWorkload", + "service": { + "shortName": "AssuredWorkloadsService", + "fullName": "google.cloud.assuredworkloads.v1beta1.AssuredWorkloadsService" + } + } + } + }, + { + "regionTag": "assuredworkloads_v1beta1_generated_AssuredWorkloadsService_UpdateWorkload_async", + "title": "AssuredWorkloadsService updateWorkload Sample", + "origin": "API_DEFINITION", + "description": " Updates an existing workload. Currently allows updating of workload display_name and labels. For force updates don't set etag field in the Workload. Only one update operation per workload can be in progress.", + "canonical": true, + "file": "assured_workloads_service.update_workload.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 61, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "UpdateWorkload", + "fullName": "google.cloud.assuredworkloads.v1beta1.AssuredWorkloadsService.UpdateWorkload", + "async": true, + "parameters": [ + { + "name": "workload", + "type": ".google.cloud.assuredworkloads.v1beta1.Workload" + }, + { + "name": "update_mask", + "type": ".google.protobuf.FieldMask" + } + ], + "resultType": ".google.cloud.assuredworkloads.v1beta1.Workload", + "client": { + "shortName": "AssuredWorkloadsServiceClient", + "fullName": "google.cloud.assuredworkloads.v1beta1.AssuredWorkloadsServiceClient" + }, + "method": { + "shortName": "UpdateWorkload", + "fullName": "google.cloud.assuredworkloads.v1beta1.AssuredWorkloadsService.UpdateWorkload", + "service": { + "shortName": "AssuredWorkloadsService", + "fullName": "google.cloud.assuredworkloads.v1beta1.AssuredWorkloadsService" + } + } + } + }, + { + "regionTag": "assuredworkloads_v1beta1_generated_AssuredWorkloadsService_RestrictAllowedResources_async", + "title": "AssuredWorkloadsService restrictAllowedResources Sample", + "origin": "API_DEFINITION", + "description": " Restrict the list of resources allowed in the Workload environment. The current list of allowed products can be found at https://cloud.google.com/assured-workloads/docs/supported-products In addition to assuredworkloads.workload.update permission, the user should also have orgpolicy.policy.set permission on the folder resource to use this functionality.", + "canonical": true, + "file": "assured_workloads_service.restrict_allowed_resources.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 62, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "RestrictAllowedResources", + "fullName": "google.cloud.assuredworkloads.v1beta1.AssuredWorkloadsService.RestrictAllowedResources", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + }, + { + "name": "restriction_type", + "type": ".google.cloud.assuredworkloads.v1beta1.RestrictAllowedResourcesRequest.RestrictionType" + } + ], + "resultType": ".google.cloud.assuredworkloads.v1beta1.RestrictAllowedResourcesResponse", + "client": { + "shortName": "AssuredWorkloadsServiceClient", + "fullName": "google.cloud.assuredworkloads.v1beta1.AssuredWorkloadsServiceClient" + }, + "method": { + "shortName": "RestrictAllowedResources", + "fullName": "google.cloud.assuredworkloads.v1beta1.AssuredWorkloadsService.RestrictAllowedResources", + "service": { + "shortName": "AssuredWorkloadsService", + "fullName": "google.cloud.assuredworkloads.v1beta1.AssuredWorkloadsService" + } + } + } + }, + { + "regionTag": "assuredworkloads_v1beta1_generated_AssuredWorkloadsService_DeleteWorkload_async", + "title": "AssuredWorkloadsService deleteWorkload Sample", + "origin": "API_DEFINITION", + "description": " Deletes the workload. Make sure that workload's direct children are already in a deleted state, otherwise the request will fail with a FAILED_PRECONDITION error. In addition to assuredworkloads.workload.delete permission, the user should also have orgpolicy.policy.set permission on the deleted folder to remove Assured Workloads OrgPolicies.", + "canonical": true, + "file": "assured_workloads_service.delete_workload.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 60, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeleteWorkload", + "fullName": "google.cloud.assuredworkloads.v1beta1.AssuredWorkloadsService.DeleteWorkload", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + }, + { + "name": "etag", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.protobuf.Empty", + "client": { + "shortName": "AssuredWorkloadsServiceClient", + "fullName": "google.cloud.assuredworkloads.v1beta1.AssuredWorkloadsServiceClient" + }, + "method": { + "shortName": "DeleteWorkload", + "fullName": "google.cloud.assuredworkloads.v1beta1.AssuredWorkloadsService.DeleteWorkload", + "service": { + "shortName": "AssuredWorkloadsService", + "fullName": "google.cloud.assuredworkloads.v1beta1.AssuredWorkloadsService" + } + } + } + }, + { + "regionTag": "assuredworkloads_v1beta1_generated_AssuredWorkloadsService_GetWorkload_async", + "title": "AssuredWorkloadsService getWorkload Sample", + "origin": "API_DEFINITION", + "description": " Gets Assured Workload associated with a CRM Node", + "canonical": true, + "file": "assured_workloads_service.get_workload.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 57, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetWorkload", + "fullName": "google.cloud.assuredworkloads.v1beta1.AssuredWorkloadsService.GetWorkload", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.assuredworkloads.v1beta1.Workload", + "client": { + "shortName": "AssuredWorkloadsServiceClient", + "fullName": "google.cloud.assuredworkloads.v1beta1.AssuredWorkloadsServiceClient" + }, + "method": { + "shortName": "GetWorkload", + "fullName": "google.cloud.assuredworkloads.v1beta1.AssuredWorkloadsService.GetWorkload", + "service": { + "shortName": "AssuredWorkloadsService", + "fullName": "google.cloud.assuredworkloads.v1beta1.AssuredWorkloadsService" + } + } + } + }, + { + "regionTag": "assuredworkloads_v1beta1_generated_AssuredWorkloadsService_AnalyzeWorkloadMove_async", + "title": "AssuredWorkloadsService analyzeWorkloadMove Sample", + "origin": "API_DEFINITION", + "description": " Analyze if the source Assured Workloads can be moved to the target Assured Workload", + "canonical": true, + "file": "assured_workloads_service.analyze_workload_move.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 75, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "AnalyzeWorkloadMove", + "fullName": "google.cloud.assuredworkloads.v1beta1.AssuredWorkloadsService.AnalyzeWorkloadMove", + "async": true, + "parameters": [ + { + "name": "source", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "target", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.assuredworkloads.v1beta1.AnalyzeWorkloadMoveResponse", + "client": { + "shortName": "AssuredWorkloadsServiceClient", + "fullName": "google.cloud.assuredworkloads.v1beta1.AssuredWorkloadsServiceClient" + }, + "method": { + "shortName": "AnalyzeWorkloadMove", + "fullName": "google.cloud.assuredworkloads.v1beta1.AssuredWorkloadsService.AnalyzeWorkloadMove", + "service": { + "shortName": "AssuredWorkloadsService", + "fullName": "google.cloud.assuredworkloads.v1beta1.AssuredWorkloadsService" + } + } + } + }, + { + "regionTag": "assuredworkloads_v1beta1_generated_AssuredWorkloadsService_ListWorkloads_async", + "title": "AssuredWorkloadsService listWorkloads Sample", + "origin": "API_DEFINITION", + "description": " Lists Assured Workloads under a CRM Node.", + "canonical": true, + "file": "assured_workloads_service.list_workloads.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 71, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListWorkloads", + "fullName": "google.cloud.assuredworkloads.v1beta1.AssuredWorkloadsService.ListWorkloads", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "filter", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.assuredworkloads.v1beta1.ListWorkloadsResponse", + "client": { + "shortName": "AssuredWorkloadsServiceClient", + "fullName": "google.cloud.assuredworkloads.v1beta1.AssuredWorkloadsServiceClient" + }, + "method": { + "shortName": "ListWorkloads", + "fullName": "google.cloud.assuredworkloads.v1beta1.AssuredWorkloadsService.ListWorkloads", + "service": { + "shortName": "AssuredWorkloadsService", + "fullName": "google.cloud.assuredworkloads.v1beta1.AssuredWorkloadsService" + } + } + } + } + ] +} \ No newline at end of file diff --git a/packages/google-cloud-assuredworkloads/samples/package.json b/packages/google-cloud-assuredworkloads/samples/package.json index be780e4011d..8cf560f2021 100644 --- a/packages/google-cloud-assuredworkloads/samples/package.json +++ b/packages/google-cloud-assuredworkloads/samples/package.json @@ -4,7 +4,7 @@ "license": "Apache-2.0", "author": "Google LLC", "engines": { - "node": ">=12.0.0" + "node": ">=14.0.0" }, "files": [ "*.js" @@ -20,4 +20,4 @@ "chai": "^4.2.0", "mocha": "^8.1.1" } -} +} \ No newline at end of file diff --git a/packages/google-cloud-assuredworkloads/src/v1/assured_workloads_service_client.ts b/packages/google-cloud-assuredworkloads/src/v1/assured_workloads_service_client.ts index afe0cb0ee84..664c79d5aac 100644 --- a/packages/google-cloud-assuredworkloads/src/v1/assured_workloads_service_client.ts +++ b/packages/google-cloud-assuredworkloads/src/v1/assured_workloads_service_client.ts @@ -415,9 +415,8 @@ export class AssuredWorkloadsServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.assuredworkloads.v1.Workload | Workload}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.assuredworkloads.v1.Workload|Workload}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/assured_workloads_service.update_workload.js * region_tag:assuredworkloads_v1_generated_AssuredWorkloadsService_UpdateWorkload_async @@ -523,9 +522,8 @@ export class AssuredWorkloadsServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.assuredworkloads.v1.RestrictAllowedResourcesResponse | RestrictAllowedResourcesResponse}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.assuredworkloads.v1.RestrictAllowedResourcesResponse|RestrictAllowedResourcesResponse}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/assured_workloads_service.restrict_allowed_resources.js * region_tag:assuredworkloads_v1_generated_AssuredWorkloadsService_RestrictAllowedResources_async @@ -631,9 +629,8 @@ export class AssuredWorkloadsServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.protobuf.Empty | Empty}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.protobuf.Empty|Empty}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/assured_workloads_service.delete_workload.js * region_tag:assuredworkloads_v1_generated_AssuredWorkloadsService_DeleteWorkload_async @@ -732,9 +729,8 @@ export class AssuredWorkloadsServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.assuredworkloads.v1.Workload | Workload}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.assuredworkloads.v1.Workload|Workload}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/assured_workloads_service.get_workload.js * region_tag:assuredworkloads_v1_generated_AssuredWorkloadsService_GetWorkload_async @@ -825,9 +821,8 @@ export class AssuredWorkloadsServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.assuredworkloads.v1.Violation | Violation}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.assuredworkloads.v1.Violation|Violation}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/assured_workloads_service.get_violation.js * region_tag:assuredworkloads_v1_generated_AssuredWorkloadsService_GetViolation_async @@ -927,9 +922,8 @@ export class AssuredWorkloadsServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.assuredworkloads.v1.AcknowledgeViolationResponse | AcknowledgeViolationResponse}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.assuredworkloads.v1.AcknowledgeViolationResponse|AcknowledgeViolationResponse}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/assured_workloads_service.acknowledge_violation.js * region_tag:assuredworkloads_v1_generated_AssuredWorkloadsService_AcknowledgeViolation_async @@ -1032,8 +1026,7 @@ export class AssuredWorkloadsServiceClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/assured_workloads_service.create_workload.js * region_tag:assuredworkloads_v1_generated_AssuredWorkloadsService_CreateWorkload_async @@ -1128,8 +1121,7 @@ export class AssuredWorkloadsServiceClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/assured_workloads_service.create_workload.js * region_tag:assuredworkloads_v1_generated_AssuredWorkloadsService_CreateWorkload_async @@ -1177,14 +1169,13 @@ export class AssuredWorkloadsServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.cloud.assuredworkloads.v1.Workload | Workload}. + * The first element of the array is Array of {@link protos.google.cloud.assuredworkloads.v1.Workload|Workload}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `listWorkloadsAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listWorkloads( @@ -1281,13 +1272,12 @@ export class AssuredWorkloadsServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.cloud.assuredworkloads.v1.Workload | Workload} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.assuredworkloads.v1.Workload|Workload} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listWorkloadsAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listWorkloadsStream( @@ -1333,12 +1323,11 @@ export class AssuredWorkloadsServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.cloud.assuredworkloads.v1.Workload | Workload}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.assuredworkloads.v1.Workload|Workload}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1/assured_workloads_service.list_workloads.js * region_tag:assuredworkloads_v1_generated_AssuredWorkloadsService_ListWorkloads_async @@ -1389,14 +1378,13 @@ export class AssuredWorkloadsServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.cloud.assuredworkloads.v1.Violation | Violation}. + * The first element of the array is Array of {@link protos.google.cloud.assuredworkloads.v1.Violation|Violation}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `listViolationsAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listViolations( @@ -1490,13 +1478,12 @@ export class AssuredWorkloadsServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.cloud.assuredworkloads.v1.Violation | Violation} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.assuredworkloads.v1.Violation|Violation} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listViolationsAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listViolationsStream( @@ -1539,12 +1526,11 @@ export class AssuredWorkloadsServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.cloud.assuredworkloads.v1.Violation | Violation}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.assuredworkloads.v1.Violation|Violation}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1/assured_workloads_service.list_violations.js * region_tag:assuredworkloads_v1_generated_AssuredWorkloadsService_ListViolations_async diff --git a/packages/google-cloud-assuredworkloads/src/v1beta1/assured_workloads_service_client.ts b/packages/google-cloud-assuredworkloads/src/v1beta1/assured_workloads_service_client.ts index ab2456ffea5..dcb8dd844e6 100644 --- a/packages/google-cloud-assuredworkloads/src/v1beta1/assured_workloads_service_client.ts +++ b/packages/google-cloud-assuredworkloads/src/v1beta1/assured_workloads_service_client.ts @@ -399,9 +399,8 @@ export class AssuredWorkloadsServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.assuredworkloads.v1beta1.Workload | Workload}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.assuredworkloads.v1beta1.Workload|Workload}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/assured_workloads_service.update_workload.js * region_tag:assuredworkloads_v1beta1_generated_AssuredWorkloadsService_UpdateWorkload_async @@ -503,9 +502,8 @@ export class AssuredWorkloadsServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.assuredworkloads.v1beta1.RestrictAllowedResourcesResponse | RestrictAllowedResourcesResponse}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.assuredworkloads.v1beta1.RestrictAllowedResourcesResponse|RestrictAllowedResourcesResponse}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/assured_workloads_service.restrict_allowed_resources.js * region_tag:assuredworkloads_v1beta1_generated_AssuredWorkloadsService_RestrictAllowedResources_async @@ -614,9 +612,8 @@ export class AssuredWorkloadsServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.protobuf.Empty | Empty}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.protobuf.Empty|Empty}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/assured_workloads_service.delete_workload.js * region_tag:assuredworkloads_v1beta1_generated_AssuredWorkloadsService_DeleteWorkload_async @@ -715,9 +712,8 @@ export class AssuredWorkloadsServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.assuredworkloads.v1beta1.Workload | Workload}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.assuredworkloads.v1beta1.Workload|Workload}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/assured_workloads_service.get_workload.js * region_tag:assuredworkloads_v1beta1_generated_AssuredWorkloadsService_GetWorkload_async @@ -827,9 +823,8 @@ export class AssuredWorkloadsServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.assuredworkloads.v1beta1.AnalyzeWorkloadMoveResponse | AnalyzeWorkloadMoveResponse}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.assuredworkloads.v1beta1.AnalyzeWorkloadMoveResponse|AnalyzeWorkloadMoveResponse}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/assured_workloads_service.analyze_workload_move.js * region_tag:assuredworkloads_v1beta1_generated_AssuredWorkloadsService_AnalyzeWorkloadMove_async @@ -932,8 +927,7 @@ export class AssuredWorkloadsServiceClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/assured_workloads_service.create_workload.js * region_tag:assuredworkloads_v1beta1_generated_AssuredWorkloadsService_CreateWorkload_async @@ -1028,8 +1022,7 @@ export class AssuredWorkloadsServiceClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/assured_workloads_service.create_workload.js * region_tag:assuredworkloads_v1beta1_generated_AssuredWorkloadsService_CreateWorkload_async @@ -1077,14 +1070,13 @@ export class AssuredWorkloadsServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.cloud.assuredworkloads.v1beta1.Workload | Workload}. + * The first element of the array is Array of {@link protos.google.cloud.assuredworkloads.v1beta1.Workload|Workload}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `listWorkloadsAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listWorkloads( @@ -1177,13 +1169,12 @@ export class AssuredWorkloadsServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.cloud.assuredworkloads.v1beta1.Workload | Workload} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.assuredworkloads.v1beta1.Workload|Workload} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listWorkloadsAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listWorkloadsStream( @@ -1225,12 +1216,11 @@ export class AssuredWorkloadsServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.cloud.assuredworkloads.v1beta1.Workload | Workload}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.assuredworkloads.v1beta1.Workload|Workload}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/assured_workloads_service.list_workloads.js * region_tag:assuredworkloads_v1beta1_generated_AssuredWorkloadsService_ListWorkloads_async diff --git a/packages/google-cloud-baremetalsolution/README.md b/packages/google-cloud-baremetalsolution/README.md index 67f407185a8..bffef17ee2a 100644 --- a/packages/google-cloud-baremetalsolution/README.md +++ b/packages/google-cloud-baremetalsolution/README.md @@ -2,7 +2,7 @@ [//]: # "To regenerate it, use `python -m synthtool`." Google Cloud Platform logo -# [Bare Metal Solution API: Node.js Client](https://github.com/googleapis/google-cloud-node) +# [Bare Metal Solution API: Node.js Client](https://github.com/googleapis/google-cloud-node/tree/main/packages/google-cloud-baremetalsolution) [![release level](https://img.shields.io/badge/release%20level-preview-yellow.svg?style=flat)](https://cloud.google.com/terms/launch-stages) [![npm version](https://img.shields.io/npm/v/@google-cloud/bare-metal-solution.svg)](https://www.npmjs.org/package/@google-cloud/bare-metal-solution) @@ -58,32 +58,31 @@ npm install @google-cloud/bare-metal-solution ## Samples -Samples are in the [`samples/`](https://github.com/googleapis/google-cloud-node/tree/main/samples) directory. Each sample's `README.md` has instructions for running its sample. +Samples are in the [`samples/`](https://github.com/googleapis/google-cloud-node/tree/main/packages/google-cloud-baremetalsolution/samples) directory. Each sample's `README.md` has instructions for running its sample. | Sample | Source Code | Try it | | --------------------------- | --------------------------------- | ------ | -| Bare_metal_solution.detach_lun | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-baremetalsolution/samples/generated/v2/bare_metal_solution.detach_lun.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-baremetalsolution/samples/generated/v2/bare_metal_solution.detach_lun.js,samples/README.md) | -| Bare_metal_solution.get_instance | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-baremetalsolution/samples/generated/v2/bare_metal_solution.get_instance.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-baremetalsolution/samples/generated/v2/bare_metal_solution.get_instance.js,samples/README.md) | -| Bare_metal_solution.get_lun | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-baremetalsolution/samples/generated/v2/bare_metal_solution.get_lun.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-baremetalsolution/samples/generated/v2/bare_metal_solution.get_lun.js,samples/README.md) | -| Bare_metal_solution.get_network | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-baremetalsolution/samples/generated/v2/bare_metal_solution.get_network.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-baremetalsolution/samples/generated/v2/bare_metal_solution.get_network.js,samples/README.md) | -| Bare_metal_solution.get_nfs_share | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-baremetalsolution/samples/generated/v2/bare_metal_solution.get_nfs_share.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-baremetalsolution/samples/generated/v2/bare_metal_solution.get_nfs_share.js,samples/README.md) | -| Bare_metal_solution.get_volume | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-baremetalsolution/samples/generated/v2/bare_metal_solution.get_volume.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-baremetalsolution/samples/generated/v2/bare_metal_solution.get_volume.js,samples/README.md) | -| Bare_metal_solution.list_instances | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-baremetalsolution/samples/generated/v2/bare_metal_solution.list_instances.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-baremetalsolution/samples/generated/v2/bare_metal_solution.list_instances.js,samples/README.md) | -| Bare_metal_solution.list_luns | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-baremetalsolution/samples/generated/v2/bare_metal_solution.list_luns.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-baremetalsolution/samples/generated/v2/bare_metal_solution.list_luns.js,samples/README.md) | -| Bare_metal_solution.list_network_usage | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-baremetalsolution/samples/generated/v2/bare_metal_solution.list_network_usage.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-baremetalsolution/samples/generated/v2/bare_metal_solution.list_network_usage.js,samples/README.md) | -| Bare_metal_solution.list_networks | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-baremetalsolution/samples/generated/v2/bare_metal_solution.list_networks.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-baremetalsolution/samples/generated/v2/bare_metal_solution.list_networks.js,samples/README.md) | -| Bare_metal_solution.list_nfs_shares | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-baremetalsolution/samples/generated/v2/bare_metal_solution.list_nfs_shares.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-baremetalsolution/samples/generated/v2/bare_metal_solution.list_nfs_shares.js,samples/README.md) | -| Bare_metal_solution.list_volumes | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-baremetalsolution/samples/generated/v2/bare_metal_solution.list_volumes.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-baremetalsolution/samples/generated/v2/bare_metal_solution.list_volumes.js,samples/README.md) | -| Bare_metal_solution.reset_instance | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-baremetalsolution/samples/generated/v2/bare_metal_solution.reset_instance.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-baremetalsolution/samples/generated/v2/bare_metal_solution.reset_instance.js,samples/README.md) | -| Bare_metal_solution.resize_volume | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-baremetalsolution/samples/generated/v2/bare_metal_solution.resize_volume.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-baremetalsolution/samples/generated/v2/bare_metal_solution.resize_volume.js,samples/README.md) | -| Bare_metal_solution.start_instance | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-baremetalsolution/samples/generated/v2/bare_metal_solution.start_instance.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-baremetalsolution/samples/generated/v2/bare_metal_solution.start_instance.js,samples/README.md) | -| Bare_metal_solution.stop_instance | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-baremetalsolution/samples/generated/v2/bare_metal_solution.stop_instance.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-baremetalsolution/samples/generated/v2/bare_metal_solution.stop_instance.js,samples/README.md) | -| Bare_metal_solution.update_instance | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-baremetalsolution/samples/generated/v2/bare_metal_solution.update_instance.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-baremetalsolution/samples/generated/v2/bare_metal_solution.update_instance.js,samples/README.md) | -| Bare_metal_solution.update_network | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-baremetalsolution/samples/generated/v2/bare_metal_solution.update_network.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-baremetalsolution/samples/generated/v2/bare_metal_solution.update_network.js,samples/README.md) | -| Bare_metal_solution.update_nfs_share | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-baremetalsolution/samples/generated/v2/bare_metal_solution.update_nfs_share.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-baremetalsolution/samples/generated/v2/bare_metal_solution.update_nfs_share.js,samples/README.md) | -| Bare_metal_solution.update_volume | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-baremetalsolution/samples/generated/v2/bare_metal_solution.update_volume.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-baremetalsolution/samples/generated/v2/bare_metal_solution.update_volume.js,samples/README.md) | -| Quickstart | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-baremetalsolution/samples/quickstart.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-baremetalsolution/samples/quickstart.js,samples/README.md) | -| Quickstart | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-baremetalsolution/samples/test/quickstart.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-baremetalsolution/samples/test/quickstart.js,samples/README.md) | +| Bare_metal_solution.detach_lun | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-baremetalsolution/samples/generated/v2/bare_metal_solution.detach_lun.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-baremetalsolution/samples/generated/v2/bare_metal_solution.detach_lun.js,packages/google-cloud-baremetalsolution/samples/README.md) | +| Bare_metal_solution.get_instance | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-baremetalsolution/samples/generated/v2/bare_metal_solution.get_instance.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-baremetalsolution/samples/generated/v2/bare_metal_solution.get_instance.js,packages/google-cloud-baremetalsolution/samples/README.md) | +| Bare_metal_solution.get_lun | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-baremetalsolution/samples/generated/v2/bare_metal_solution.get_lun.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-baremetalsolution/samples/generated/v2/bare_metal_solution.get_lun.js,packages/google-cloud-baremetalsolution/samples/README.md) | +| Bare_metal_solution.get_network | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-baremetalsolution/samples/generated/v2/bare_metal_solution.get_network.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-baremetalsolution/samples/generated/v2/bare_metal_solution.get_network.js,packages/google-cloud-baremetalsolution/samples/README.md) | +| Bare_metal_solution.get_nfs_share | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-baremetalsolution/samples/generated/v2/bare_metal_solution.get_nfs_share.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-baremetalsolution/samples/generated/v2/bare_metal_solution.get_nfs_share.js,packages/google-cloud-baremetalsolution/samples/README.md) | +| Bare_metal_solution.get_volume | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-baremetalsolution/samples/generated/v2/bare_metal_solution.get_volume.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-baremetalsolution/samples/generated/v2/bare_metal_solution.get_volume.js,packages/google-cloud-baremetalsolution/samples/README.md) | +| Bare_metal_solution.list_instances | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-baremetalsolution/samples/generated/v2/bare_metal_solution.list_instances.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-baremetalsolution/samples/generated/v2/bare_metal_solution.list_instances.js,packages/google-cloud-baremetalsolution/samples/README.md) | +| Bare_metal_solution.list_luns | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-baremetalsolution/samples/generated/v2/bare_metal_solution.list_luns.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-baremetalsolution/samples/generated/v2/bare_metal_solution.list_luns.js,packages/google-cloud-baremetalsolution/samples/README.md) | +| Bare_metal_solution.list_network_usage | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-baremetalsolution/samples/generated/v2/bare_metal_solution.list_network_usage.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-baremetalsolution/samples/generated/v2/bare_metal_solution.list_network_usage.js,packages/google-cloud-baremetalsolution/samples/README.md) | +| Bare_metal_solution.list_networks | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-baremetalsolution/samples/generated/v2/bare_metal_solution.list_networks.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-baremetalsolution/samples/generated/v2/bare_metal_solution.list_networks.js,packages/google-cloud-baremetalsolution/samples/README.md) | +| Bare_metal_solution.list_nfs_shares | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-baremetalsolution/samples/generated/v2/bare_metal_solution.list_nfs_shares.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-baremetalsolution/samples/generated/v2/bare_metal_solution.list_nfs_shares.js,packages/google-cloud-baremetalsolution/samples/README.md) | +| Bare_metal_solution.list_volumes | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-baremetalsolution/samples/generated/v2/bare_metal_solution.list_volumes.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-baremetalsolution/samples/generated/v2/bare_metal_solution.list_volumes.js,packages/google-cloud-baremetalsolution/samples/README.md) | +| Bare_metal_solution.reset_instance | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-baremetalsolution/samples/generated/v2/bare_metal_solution.reset_instance.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-baremetalsolution/samples/generated/v2/bare_metal_solution.reset_instance.js,packages/google-cloud-baremetalsolution/samples/README.md) | +| Bare_metal_solution.resize_volume | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-baremetalsolution/samples/generated/v2/bare_metal_solution.resize_volume.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-baremetalsolution/samples/generated/v2/bare_metal_solution.resize_volume.js,packages/google-cloud-baremetalsolution/samples/README.md) | +| Bare_metal_solution.start_instance | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-baremetalsolution/samples/generated/v2/bare_metal_solution.start_instance.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-baremetalsolution/samples/generated/v2/bare_metal_solution.start_instance.js,packages/google-cloud-baremetalsolution/samples/README.md) | +| Bare_metal_solution.stop_instance | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-baremetalsolution/samples/generated/v2/bare_metal_solution.stop_instance.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-baremetalsolution/samples/generated/v2/bare_metal_solution.stop_instance.js,packages/google-cloud-baremetalsolution/samples/README.md) | +| Bare_metal_solution.update_instance | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-baremetalsolution/samples/generated/v2/bare_metal_solution.update_instance.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-baremetalsolution/samples/generated/v2/bare_metal_solution.update_instance.js,packages/google-cloud-baremetalsolution/samples/README.md) | +| Bare_metal_solution.update_network | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-baremetalsolution/samples/generated/v2/bare_metal_solution.update_network.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-baremetalsolution/samples/generated/v2/bare_metal_solution.update_network.js,packages/google-cloud-baremetalsolution/samples/README.md) | +| Bare_metal_solution.update_nfs_share | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-baremetalsolution/samples/generated/v2/bare_metal_solution.update_nfs_share.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-baremetalsolution/samples/generated/v2/bare_metal_solution.update_nfs_share.js,packages/google-cloud-baremetalsolution/samples/README.md) | +| Bare_metal_solution.update_volume | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-baremetalsolution/samples/generated/v2/bare_metal_solution.update_volume.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-baremetalsolution/samples/generated/v2/bare_metal_solution.update_volume.js,packages/google-cloud-baremetalsolution/samples/README.md) | +| Quickstart | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-baremetalsolution/samples/quickstart.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-baremetalsolution/samples/quickstart.js,packages/google-cloud-baremetalsolution/samples/README.md) | diff --git a/packages/google-cloud-baremetalsolution/package.json b/packages/google-cloud-baremetalsolution/package.json index 3643f43d65b..514eba7b623 100644 --- a/packages/google-cloud-baremetalsolution/package.json +++ b/packages/google-cloud-baremetalsolution/package.json @@ -45,14 +45,15 @@ "test": "c8 mocha build/test" }, "dependencies": { - "google-gax": "^3.5.8" + "google-gax": "^4.0.3" }, "devDependencies": { "@types/mocha": "^9.0.0", - "@types/node": "^18.0.0", + "@types/node": "^20.4.5", "@types/sinon": "^10.0.0", "c8": "^7.7.2", - "gts": "^3.1.0", + "gapic-tools": "^0.1.8", + "gts": "^5.0.0", "jsdoc": "^4.0.0", "jsdoc-fresh": "^2.0.0", "jsdoc-region-tag": "^2.0.0", @@ -63,12 +64,12 @@ "pack-n-play": "^1.0.0-2", "sinon": "^15.0.0", "ts-loader": "^9.1.2", - "typescript": "^4.2.4", + "typescript": "^5.1.6", "webpack": "^5.36.2", "webpack-cli": "^5.0.0" }, "engines": { - "node": ">=v12.0.0" + "node": ">=14.0.0" }, "homepage": "https://github.com/googleapis/google-cloud-node/tree/main/packages/google-cloud-baremetalsolution" } diff --git a/packages/google-cloud-baremetalsolution/samples/README.md b/packages/google-cloud-baremetalsolution/samples/README.md index 1e87bf3c211..49138f097b2 100644 --- a/packages/google-cloud-baremetalsolution/samples/README.md +++ b/packages/google-cloud-baremetalsolution/samples/README.md @@ -33,7 +33,6 @@ * [Bare_metal_solution.update_nfs_share](#bare_metal_solution.update_nfs_share) * [Bare_metal_solution.update_volume](#bare_metal_solution.update_volume) * [Quickstart](#quickstart) - * [Quickstart](#quickstart) ## Before you begin @@ -402,23 +401,6 @@ __Usage:__ `node packages/google-cloud-baremetalsolution/samples/quickstart.js` ------ - - - - -### Quickstart - -View the [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-baremetalsolution/samples/test/quickstart.js). - -[![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-baremetalsolution/samples/test/quickstart.js,samples/README.md) - -__Usage:__ - - -`node packages/google-cloud-baremetalsolution/samples/test/quickstart.js` - - diff --git a/packages/google-cloud-baremetalsolution/samples/generated/v2/snippet_metadata.google.cloud.baremetalsolution.v2.json b/packages/google-cloud-baremetalsolution/samples/generated/v2/snippet_metadata.google.cloud.baremetalsolution.v2.json index 4df6beb48e7..f9edeeda552 100644 --- a/packages/google-cloud-baremetalsolution/samples/generated/v2/snippet_metadata.google.cloud.baremetalsolution.v2.json +++ b/packages/google-cloud-baremetalsolution/samples/generated/v2/snippet_metadata.google.cloud.baremetalsolution.v2.json @@ -1,7 +1,7 @@ { "clientLibrary": { "name": "nodejs-baremetalsolution", - "version": "0.3.0", + "version": "0.3.2", "language": "TYPESCRIPT", "apis": [ { diff --git a/packages/google-cloud-baremetalsolution/samples/generated/v2/snippet_metadata_google.cloud.baremetalsolution.v2.json b/packages/google-cloud-baremetalsolution/samples/generated/v2/snippet_metadata_google.cloud.baremetalsolution.v2.json new file mode 100644 index 00000000000..f9edeeda552 --- /dev/null +++ b/packages/google-cloud-baremetalsolution/samples/generated/v2/snippet_metadata_google.cloud.baremetalsolution.v2.json @@ -0,0 +1,895 @@ +{ + "clientLibrary": { + "name": "nodejs-baremetalsolution", + "version": "0.3.2", + "language": "TYPESCRIPT", + "apis": [ + { + "id": "google.cloud.baremetalsolution.v2", + "version": "v2" + } + ] + }, + "snippets": [ + { + "regionTag": "baremetalsolution_v2_generated_BareMetalSolution_ListInstances_async", + "title": "BareMetalSolution listInstances Sample", + "origin": "API_DEFINITION", + "description": " List servers in a given project and location.", + "canonical": true, + "file": "bare_metal_solution.list_instances.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 68, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListInstances", + "fullName": "google.cloud.baremetalsolution.v2.BareMetalSolution.ListInstances", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "filter", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.baremetalsolution.v2.ListInstancesResponse", + "client": { + "shortName": "BareMetalSolutionClient", + "fullName": "google.cloud.baremetalsolution.v2.BareMetalSolutionClient" + }, + "method": { + "shortName": "ListInstances", + "fullName": "google.cloud.baremetalsolution.v2.BareMetalSolution.ListInstances", + "service": { + "shortName": "BareMetalSolution", + "fullName": "google.cloud.baremetalsolution.v2.BareMetalSolution" + } + } + } + }, + { + "regionTag": "baremetalsolution_v2_generated_BareMetalSolution_GetInstance_async", + "title": "BareMetalSolution getInstance Sample", + "origin": "API_DEFINITION", + "description": " Get details about a single server.", + "canonical": true, + "file": "bare_metal_solution.get_instance.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 53, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetInstance", + "fullName": "google.cloud.baremetalsolution.v2.BareMetalSolution.GetInstance", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.baremetalsolution.v2.Instance", + "client": { + "shortName": "BareMetalSolutionClient", + "fullName": "google.cloud.baremetalsolution.v2.BareMetalSolutionClient" + }, + "method": { + "shortName": "GetInstance", + "fullName": "google.cloud.baremetalsolution.v2.BareMetalSolution.GetInstance", + "service": { + "shortName": "BareMetalSolution", + "fullName": "google.cloud.baremetalsolution.v2.BareMetalSolution" + } + } + } + }, + { + "regionTag": "baremetalsolution_v2_generated_BareMetalSolution_UpdateInstance_async", + "title": "BareMetalSolution updateInstance Sample", + "origin": "API_DEFINITION", + "description": " Update details of a single server.", + "canonical": true, + "file": "bare_metal_solution.update_instance.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 64, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "UpdateInstance", + "fullName": "google.cloud.baremetalsolution.v2.BareMetalSolution.UpdateInstance", + "async": true, + "parameters": [ + { + "name": "instance", + "type": ".google.cloud.baremetalsolution.v2.Instance" + }, + { + "name": "update_mask", + "type": ".google.protobuf.FieldMask" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "BareMetalSolutionClient", + "fullName": "google.cloud.baremetalsolution.v2.BareMetalSolutionClient" + }, + "method": { + "shortName": "UpdateInstance", + "fullName": "google.cloud.baremetalsolution.v2.BareMetalSolution.UpdateInstance", + "service": { + "shortName": "BareMetalSolution", + "fullName": "google.cloud.baremetalsolution.v2.BareMetalSolution" + } + } + } + }, + { + "regionTag": "baremetalsolution_v2_generated_BareMetalSolution_ResetInstance_async", + "title": "BareMetalSolution resetInstance Sample", + "origin": "API_DEFINITION", + "description": " Perform an ungraceful, hard reset on a server. Equivalent to shutting the power off and then turning it back on.", + "canonical": true, + "file": "bare_metal_solution.reset_instance.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 54, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ResetInstance", + "fullName": "google.cloud.baremetalsolution.v2.BareMetalSolution.ResetInstance", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "BareMetalSolutionClient", + "fullName": "google.cloud.baremetalsolution.v2.BareMetalSolutionClient" + }, + "method": { + "shortName": "ResetInstance", + "fullName": "google.cloud.baremetalsolution.v2.BareMetalSolution.ResetInstance", + "service": { + "shortName": "BareMetalSolution", + "fullName": "google.cloud.baremetalsolution.v2.BareMetalSolution" + } + } + } + }, + { + "regionTag": "baremetalsolution_v2_generated_BareMetalSolution_StartInstance_async", + "title": "BareMetalSolution startInstance Sample", + "origin": "API_DEFINITION", + "description": " Starts a server that was shutdown.", + "canonical": true, + "file": "bare_metal_solution.start_instance.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 54, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "StartInstance", + "fullName": "google.cloud.baremetalsolution.v2.BareMetalSolution.StartInstance", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "BareMetalSolutionClient", + "fullName": "google.cloud.baremetalsolution.v2.BareMetalSolutionClient" + }, + "method": { + "shortName": "StartInstance", + "fullName": "google.cloud.baremetalsolution.v2.BareMetalSolution.StartInstance", + "service": { + "shortName": "BareMetalSolution", + "fullName": "google.cloud.baremetalsolution.v2.BareMetalSolution" + } + } + } + }, + { + "regionTag": "baremetalsolution_v2_generated_BareMetalSolution_StopInstance_async", + "title": "BareMetalSolution stopInstance Sample", + "origin": "API_DEFINITION", + "description": " Stop a running server.", + "canonical": true, + "file": "bare_metal_solution.stop_instance.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 54, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "StopInstance", + "fullName": "google.cloud.baremetalsolution.v2.BareMetalSolution.StopInstance", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "BareMetalSolutionClient", + "fullName": "google.cloud.baremetalsolution.v2.BareMetalSolutionClient" + }, + "method": { + "shortName": "StopInstance", + "fullName": "google.cloud.baremetalsolution.v2.BareMetalSolution.StopInstance", + "service": { + "shortName": "BareMetalSolution", + "fullName": "google.cloud.baremetalsolution.v2.BareMetalSolution" + } + } + } + }, + { + "regionTag": "baremetalsolution_v2_generated_BareMetalSolution_DetachLun_async", + "title": "BareMetalSolution detachLun Sample", + "origin": "API_DEFINITION", + "description": " Detach LUN from Instance.", + "canonical": true, + "file": "bare_metal_solution.detach_lun.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 59, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DetachLun", + "fullName": "google.cloud.baremetalsolution.v2.BareMetalSolution.DetachLun", + "async": true, + "parameters": [ + { + "name": "instance", + "type": "TYPE_STRING" + }, + { + "name": "lun", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "BareMetalSolutionClient", + "fullName": "google.cloud.baremetalsolution.v2.BareMetalSolutionClient" + }, + "method": { + "shortName": "DetachLun", + "fullName": "google.cloud.baremetalsolution.v2.BareMetalSolution.DetachLun", + "service": { + "shortName": "BareMetalSolution", + "fullName": "google.cloud.baremetalsolution.v2.BareMetalSolution" + } + } + } + }, + { + "regionTag": "baremetalsolution_v2_generated_BareMetalSolution_ListVolumes_async", + "title": "BareMetalSolution listVolumes Sample", + "origin": "API_DEFINITION", + "description": " List storage volumes in a given project and location.", + "canonical": true, + "file": "bare_metal_solution.list_volumes.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 68, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListVolumes", + "fullName": "google.cloud.baremetalsolution.v2.BareMetalSolution.ListVolumes", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "filter", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.baremetalsolution.v2.ListVolumesResponse", + "client": { + "shortName": "BareMetalSolutionClient", + "fullName": "google.cloud.baremetalsolution.v2.BareMetalSolutionClient" + }, + "method": { + "shortName": "ListVolumes", + "fullName": "google.cloud.baremetalsolution.v2.BareMetalSolution.ListVolumes", + "service": { + "shortName": "BareMetalSolution", + "fullName": "google.cloud.baremetalsolution.v2.BareMetalSolution" + } + } + } + }, + { + "regionTag": "baremetalsolution_v2_generated_BareMetalSolution_GetVolume_async", + "title": "BareMetalSolution getVolume Sample", + "origin": "API_DEFINITION", + "description": " Get details of a single storage volume.", + "canonical": true, + "file": "bare_metal_solution.get_volume.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 53, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetVolume", + "fullName": "google.cloud.baremetalsolution.v2.BareMetalSolution.GetVolume", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.baremetalsolution.v2.Volume", + "client": { + "shortName": "BareMetalSolutionClient", + "fullName": "google.cloud.baremetalsolution.v2.BareMetalSolutionClient" + }, + "method": { + "shortName": "GetVolume", + "fullName": "google.cloud.baremetalsolution.v2.BareMetalSolution.GetVolume", + "service": { + "shortName": "BareMetalSolution", + "fullName": "google.cloud.baremetalsolution.v2.BareMetalSolution" + } + } + } + }, + { + "regionTag": "baremetalsolution_v2_generated_BareMetalSolution_UpdateVolume_async", + "title": "BareMetalSolution updateVolume Sample", + "origin": "API_DEFINITION", + "description": " Update details of a single storage volume.", + "canonical": true, + "file": "bare_metal_solution.update_volume.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 66, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "UpdateVolume", + "fullName": "google.cloud.baremetalsolution.v2.BareMetalSolution.UpdateVolume", + "async": true, + "parameters": [ + { + "name": "volume", + "type": ".google.cloud.baremetalsolution.v2.Volume" + }, + { + "name": "update_mask", + "type": ".google.protobuf.FieldMask" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "BareMetalSolutionClient", + "fullName": "google.cloud.baremetalsolution.v2.BareMetalSolutionClient" + }, + "method": { + "shortName": "UpdateVolume", + "fullName": "google.cloud.baremetalsolution.v2.BareMetalSolution.UpdateVolume", + "service": { + "shortName": "BareMetalSolution", + "fullName": "google.cloud.baremetalsolution.v2.BareMetalSolution" + } + } + } + }, + { + "regionTag": "baremetalsolution_v2_generated_BareMetalSolution_ResizeVolume_async", + "title": "BareMetalSolution resizeVolume Sample", + "origin": "API_DEFINITION", + "description": " Emergency Volume resize.", + "canonical": true, + "file": "bare_metal_solution.resize_volume.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 58, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ResizeVolume", + "fullName": "google.cloud.baremetalsolution.v2.BareMetalSolution.ResizeVolume", + "async": true, + "parameters": [ + { + "name": "volume", + "type": "TYPE_STRING" + }, + { + "name": "size_gib", + "type": "TYPE_INT64" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "BareMetalSolutionClient", + "fullName": "google.cloud.baremetalsolution.v2.BareMetalSolutionClient" + }, + "method": { + "shortName": "ResizeVolume", + "fullName": "google.cloud.baremetalsolution.v2.BareMetalSolution.ResizeVolume", + "service": { + "shortName": "BareMetalSolution", + "fullName": "google.cloud.baremetalsolution.v2.BareMetalSolution" + } + } + } + }, + { + "regionTag": "baremetalsolution_v2_generated_BareMetalSolution_ListNetworks_async", + "title": "BareMetalSolution listNetworks Sample", + "origin": "API_DEFINITION", + "description": " List network in a given project and location.", + "canonical": true, + "file": "bare_metal_solution.list_networks.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 68, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListNetworks", + "fullName": "google.cloud.baremetalsolution.v2.BareMetalSolution.ListNetworks", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "filter", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.baremetalsolution.v2.ListNetworksResponse", + "client": { + "shortName": "BareMetalSolutionClient", + "fullName": "google.cloud.baremetalsolution.v2.BareMetalSolutionClient" + }, + "method": { + "shortName": "ListNetworks", + "fullName": "google.cloud.baremetalsolution.v2.BareMetalSolution.ListNetworks", + "service": { + "shortName": "BareMetalSolution", + "fullName": "google.cloud.baremetalsolution.v2.BareMetalSolution" + } + } + } + }, + { + "regionTag": "baremetalsolution_v2_generated_BareMetalSolution_ListNetworkUsage_async", + "title": "BareMetalSolution listNetworkUsage Sample", + "origin": "API_DEFINITION", + "description": " List all Networks (and used IPs for each Network) in the vendor account associated with the specified project.", + "canonical": true, + "file": "bare_metal_solution.list_network_usage.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 53, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListNetworkUsage", + "fullName": "google.cloud.baremetalsolution.v2.BareMetalSolution.ListNetworkUsage", + "async": true, + "parameters": [ + { + "name": "location", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.baremetalsolution.v2.ListNetworkUsageResponse", + "client": { + "shortName": "BareMetalSolutionClient", + "fullName": "google.cloud.baremetalsolution.v2.BareMetalSolutionClient" + }, + "method": { + "shortName": "ListNetworkUsage", + "fullName": "google.cloud.baremetalsolution.v2.BareMetalSolution.ListNetworkUsage", + "service": { + "shortName": "BareMetalSolution", + "fullName": "google.cloud.baremetalsolution.v2.BareMetalSolution" + } + } + } + }, + { + "regionTag": "baremetalsolution_v2_generated_BareMetalSolution_GetNetwork_async", + "title": "BareMetalSolution getNetwork Sample", + "origin": "API_DEFINITION", + "description": " Get details of a single network.", + "canonical": true, + "file": "bare_metal_solution.get_network.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 53, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetNetwork", + "fullName": "google.cloud.baremetalsolution.v2.BareMetalSolution.GetNetwork", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.baremetalsolution.v2.Network", + "client": { + "shortName": "BareMetalSolutionClient", + "fullName": "google.cloud.baremetalsolution.v2.BareMetalSolutionClient" + }, + "method": { + "shortName": "GetNetwork", + "fullName": "google.cloud.baremetalsolution.v2.BareMetalSolution.GetNetwork", + "service": { + "shortName": "BareMetalSolution", + "fullName": "google.cloud.baremetalsolution.v2.BareMetalSolution" + } + } + } + }, + { + "regionTag": "baremetalsolution_v2_generated_BareMetalSolution_UpdateNetwork_async", + "title": "BareMetalSolution updateNetwork Sample", + "origin": "API_DEFINITION", + "description": " Update details of a single network.", + "canonical": true, + "file": "bare_metal_solution.update_network.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 62, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "UpdateNetwork", + "fullName": "google.cloud.baremetalsolution.v2.BareMetalSolution.UpdateNetwork", + "async": true, + "parameters": [ + { + "name": "network", + "type": ".google.cloud.baremetalsolution.v2.Network" + }, + { + "name": "update_mask", + "type": ".google.protobuf.FieldMask" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "BareMetalSolutionClient", + "fullName": "google.cloud.baremetalsolution.v2.BareMetalSolutionClient" + }, + "method": { + "shortName": "UpdateNetwork", + "fullName": "google.cloud.baremetalsolution.v2.BareMetalSolution.UpdateNetwork", + "service": { + "shortName": "BareMetalSolution", + "fullName": "google.cloud.baremetalsolution.v2.BareMetalSolution" + } + } + } + }, + { + "regionTag": "baremetalsolution_v2_generated_BareMetalSolution_GetLun_async", + "title": "BareMetalSolution getLun Sample", + "origin": "API_DEFINITION", + "description": " Get details of a single storage logical unit number(LUN).", + "canonical": true, + "file": "bare_metal_solution.get_lun.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 53, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetLun", + "fullName": "google.cloud.baremetalsolution.v2.BareMetalSolution.GetLun", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.baremetalsolution.v2.Lun", + "client": { + "shortName": "BareMetalSolutionClient", + "fullName": "google.cloud.baremetalsolution.v2.BareMetalSolutionClient" + }, + "method": { + "shortName": "GetLun", + "fullName": "google.cloud.baremetalsolution.v2.BareMetalSolution.GetLun", + "service": { + "shortName": "BareMetalSolution", + "fullName": "google.cloud.baremetalsolution.v2.BareMetalSolution" + } + } + } + }, + { + "regionTag": "baremetalsolution_v2_generated_BareMetalSolution_ListLuns_async", + "title": "BareMetalSolution listLuns Sample", + "origin": "API_DEFINITION", + "description": " List storage volume luns for given storage volume.", + "canonical": true, + "file": "bare_metal_solution.list_luns.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 64, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListLuns", + "fullName": "google.cloud.baremetalsolution.v2.BareMetalSolution.ListLuns", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.baremetalsolution.v2.ListLunsResponse", + "client": { + "shortName": "BareMetalSolutionClient", + "fullName": "google.cloud.baremetalsolution.v2.BareMetalSolutionClient" + }, + "method": { + "shortName": "ListLuns", + "fullName": "google.cloud.baremetalsolution.v2.BareMetalSolution.ListLuns", + "service": { + "shortName": "BareMetalSolution", + "fullName": "google.cloud.baremetalsolution.v2.BareMetalSolution" + } + } + } + }, + { + "regionTag": "baremetalsolution_v2_generated_BareMetalSolution_GetNfsShare_async", + "title": "BareMetalSolution getNfsShare Sample", + "origin": "API_DEFINITION", + "description": " Get details of a single NFS share.", + "canonical": true, + "file": "bare_metal_solution.get_nfs_share.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 53, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetNfsShare", + "fullName": "google.cloud.baremetalsolution.v2.BareMetalSolution.GetNfsShare", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.baremetalsolution.v2.NfsShare", + "client": { + "shortName": "BareMetalSolutionClient", + "fullName": "google.cloud.baremetalsolution.v2.BareMetalSolutionClient" + }, + "method": { + "shortName": "GetNfsShare", + "fullName": "google.cloud.baremetalsolution.v2.BareMetalSolution.GetNfsShare", + "service": { + "shortName": "BareMetalSolution", + "fullName": "google.cloud.baremetalsolution.v2.BareMetalSolution" + } + } + } + }, + { + "regionTag": "baremetalsolution_v2_generated_BareMetalSolution_ListNfsShares_async", + "title": "BareMetalSolution listNfsShares Sample", + "origin": "API_DEFINITION", + "description": " List NFS shares.", + "canonical": true, + "file": "bare_metal_solution.list_nfs_shares.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 68, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListNfsShares", + "fullName": "google.cloud.baremetalsolution.v2.BareMetalSolution.ListNfsShares", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "filter", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.baremetalsolution.v2.ListNfsSharesResponse", + "client": { + "shortName": "BareMetalSolutionClient", + "fullName": "google.cloud.baremetalsolution.v2.BareMetalSolutionClient" + }, + "method": { + "shortName": "ListNfsShares", + "fullName": "google.cloud.baremetalsolution.v2.BareMetalSolution.ListNfsShares", + "service": { + "shortName": "BareMetalSolution", + "fullName": "google.cloud.baremetalsolution.v2.BareMetalSolution" + } + } + } + }, + { + "regionTag": "baremetalsolution_v2_generated_BareMetalSolution_UpdateNfsShare_async", + "title": "BareMetalSolution updateNfsShare Sample", + "origin": "API_DEFINITION", + "description": " Update details of a single NFS share.", + "canonical": true, + "file": "bare_metal_solution.update_nfs_share.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 62, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "UpdateNfsShare", + "fullName": "google.cloud.baremetalsolution.v2.BareMetalSolution.UpdateNfsShare", + "async": true, + "parameters": [ + { + "name": "nfs_share", + "type": ".google.cloud.baremetalsolution.v2.NfsShare" + }, + { + "name": "update_mask", + "type": ".google.protobuf.FieldMask" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "BareMetalSolutionClient", + "fullName": "google.cloud.baremetalsolution.v2.BareMetalSolutionClient" + }, + "method": { + "shortName": "UpdateNfsShare", + "fullName": "google.cloud.baremetalsolution.v2.BareMetalSolution.UpdateNfsShare", + "service": { + "shortName": "BareMetalSolution", + "fullName": "google.cloud.baremetalsolution.v2.BareMetalSolution" + } + } + } + } + ] +} \ No newline at end of file diff --git a/packages/google-cloud-baremetalsolution/samples/package.json b/packages/google-cloud-baremetalsolution/samples/package.json index 3267243f131..99e27601e24 100644 --- a/packages/google-cloud-baremetalsolution/samples/package.json +++ b/packages/google-cloud-baremetalsolution/samples/package.json @@ -4,7 +4,7 @@ "license": "Apache-2.0", "author": "Google LLC", "engines": { - "node": ">=10" + "node": ">=14.0.0" }, "files": [ "*.js" @@ -20,4 +20,4 @@ "chai": "^4.2.0", "mocha": "^8.0.0" } -} +} \ No newline at end of file diff --git a/packages/google-cloud-baremetalsolution/src/v2/bare_metal_solution_client.ts b/packages/google-cloud-baremetalsolution/src/v2/bare_metal_solution_client.ts index 83e3bcedd8d..35658881c84 100644 --- a/packages/google-cloud-baremetalsolution/src/v2/bare_metal_solution_client.ts +++ b/packages/google-cloud-baremetalsolution/src/v2/bare_metal_solution_client.ts @@ -545,9 +545,8 @@ export class BareMetalSolutionClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.baremetalsolution.v2.Instance | Instance}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.baremetalsolution.v2.Instance|Instance}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v2/bare_metal_solution.get_instance.js * region_tag:baremetalsolution_v2_generated_BareMetalSolution_GetInstance_async @@ -636,9 +635,8 @@ export class BareMetalSolutionClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.baremetalsolution.v2.Volume | Volume}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.baremetalsolution.v2.Volume|Volume}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v2/bare_metal_solution.get_volume.js * region_tag:baremetalsolution_v2_generated_BareMetalSolution_GetVolume_async @@ -728,9 +726,8 @@ export class BareMetalSolutionClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.baremetalsolution.v2.ListNetworkUsageResponse | ListNetworkUsageResponse}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.baremetalsolution.v2.ListNetworkUsageResponse|ListNetworkUsageResponse}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v2/bare_metal_solution.list_network_usage.js * region_tag:baremetalsolution_v2_generated_BareMetalSolution_ListNetworkUsage_async @@ -825,9 +822,8 @@ export class BareMetalSolutionClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.baremetalsolution.v2.Network | Network}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.baremetalsolution.v2.Network|Network}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v2/bare_metal_solution.get_network.js * region_tag:baremetalsolution_v2_generated_BareMetalSolution_GetNetwork_async @@ -916,9 +912,8 @@ export class BareMetalSolutionClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.baremetalsolution.v2.Lun | Lun}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.baremetalsolution.v2.Lun|Lun}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v2/bare_metal_solution.get_lun.js * region_tag:baremetalsolution_v2_generated_BareMetalSolution_GetLun_async @@ -1007,9 +1002,8 @@ export class BareMetalSolutionClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.baremetalsolution.v2.NfsShare | NfsShare}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.baremetalsolution.v2.NfsShare|NfsShare}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v2/bare_metal_solution.get_nfs_share.js * region_tag:baremetalsolution_v2_generated_BareMetalSolution_GetNfsShare_async @@ -1111,8 +1105,7 @@ export class BareMetalSolutionClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v2/bare_metal_solution.update_instance.js * region_tag:baremetalsolution_v2_generated_BareMetalSolution_UpdateInstance_async @@ -1207,8 +1200,7 @@ export class BareMetalSolutionClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v2/bare_metal_solution.update_instance.js * region_tag:baremetalsolution_v2_generated_BareMetalSolution_UpdateInstance_async @@ -1250,8 +1242,7 @@ export class BareMetalSolutionClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v2/bare_metal_solution.reset_instance.js * region_tag:baremetalsolution_v2_generated_BareMetalSolution_ResetInstance_async @@ -1346,8 +1337,7 @@ export class BareMetalSolutionClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v2/bare_metal_solution.reset_instance.js * region_tag:baremetalsolution_v2_generated_BareMetalSolution_ResetInstance_async @@ -1388,8 +1378,7 @@ export class BareMetalSolutionClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v2/bare_metal_solution.start_instance.js * region_tag:baremetalsolution_v2_generated_BareMetalSolution_StartInstance_async @@ -1484,8 +1473,7 @@ export class BareMetalSolutionClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v2/bare_metal_solution.start_instance.js * region_tag:baremetalsolution_v2_generated_BareMetalSolution_StartInstance_async @@ -1526,8 +1514,7 @@ export class BareMetalSolutionClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v2/bare_metal_solution.stop_instance.js * region_tag:baremetalsolution_v2_generated_BareMetalSolution_StopInstance_async @@ -1622,8 +1609,7 @@ export class BareMetalSolutionClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v2/bare_metal_solution.stop_instance.js * region_tag:baremetalsolution_v2_generated_BareMetalSolution_StopInstance_async @@ -1666,8 +1652,7 @@ export class BareMetalSolutionClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v2/bare_metal_solution.detach_lun.js * region_tag:baremetalsolution_v2_generated_BareMetalSolution_DetachLun_async @@ -1762,8 +1747,7 @@ export class BareMetalSolutionClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v2/bare_metal_solution.detach_lun.js * region_tag:baremetalsolution_v2_generated_BareMetalSolution_DetachLun_async @@ -1815,8 +1799,7 @@ export class BareMetalSolutionClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v2/bare_metal_solution.update_volume.js * region_tag:baremetalsolution_v2_generated_BareMetalSolution_UpdateVolume_async @@ -1911,8 +1894,7 @@ export class BareMetalSolutionClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v2/bare_metal_solution.update_volume.js * region_tag:baremetalsolution_v2_generated_BareMetalSolution_UpdateVolume_async @@ -1955,8 +1937,7 @@ export class BareMetalSolutionClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v2/bare_metal_solution.resize_volume.js * region_tag:baremetalsolution_v2_generated_BareMetalSolution_ResizeVolume_async @@ -2051,8 +2032,7 @@ export class BareMetalSolutionClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v2/bare_metal_solution.resize_volume.js * region_tag:baremetalsolution_v2_generated_BareMetalSolution_ResizeVolume_async @@ -2100,8 +2080,7 @@ export class BareMetalSolutionClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v2/bare_metal_solution.update_network.js * region_tag:baremetalsolution_v2_generated_BareMetalSolution_UpdateNetwork_async @@ -2196,8 +2175,7 @@ export class BareMetalSolutionClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v2/bare_metal_solution.update_network.js * region_tag:baremetalsolution_v2_generated_BareMetalSolution_UpdateNetwork_async @@ -2245,8 +2223,7 @@ export class BareMetalSolutionClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v2/bare_metal_solution.update_nfs_share.js * region_tag:baremetalsolution_v2_generated_BareMetalSolution_UpdateNfsShare_async @@ -2341,8 +2318,7 @@ export class BareMetalSolutionClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v2/bare_metal_solution.update_nfs_share.js * region_tag:baremetalsolution_v2_generated_BareMetalSolution_UpdateNfsShare_async @@ -2387,14 +2363,13 @@ export class BareMetalSolutionClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.cloud.baremetalsolution.v2.Instance | Instance}. + * The first element of the array is Array of {@link protos.google.cloud.baremetalsolution.v2.Instance|Instance}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `listInstancesAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listInstances( @@ -2488,13 +2463,12 @@ export class BareMetalSolutionClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.cloud.baremetalsolution.v2.Instance | Instance} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.baremetalsolution.v2.Instance|Instance} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listInstancesAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listInstancesStream( @@ -2537,12 +2511,11 @@ export class BareMetalSolutionClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.cloud.baremetalsolution.v2.Instance | Instance}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.baremetalsolution.v2.Instance|Instance}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v2/bare_metal_solution.list_instances.js * region_tag:baremetalsolution_v2_generated_BareMetalSolution_ListInstances_async @@ -2585,14 +2558,13 @@ export class BareMetalSolutionClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.cloud.baremetalsolution.v2.Volume | Volume}. + * The first element of the array is Array of {@link protos.google.cloud.baremetalsolution.v2.Volume|Volume}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `listVolumesAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listVolumes( @@ -2686,13 +2658,12 @@ export class BareMetalSolutionClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.cloud.baremetalsolution.v2.Volume | Volume} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.baremetalsolution.v2.Volume|Volume} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listVolumesAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listVolumesStream( @@ -2735,12 +2706,11 @@ export class BareMetalSolutionClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.cloud.baremetalsolution.v2.Volume | Volume}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.baremetalsolution.v2.Volume|Volume}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v2/bare_metal_solution.list_volumes.js * region_tag:baremetalsolution_v2_generated_BareMetalSolution_ListVolumes_async @@ -2783,14 +2753,13 @@ export class BareMetalSolutionClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.cloud.baremetalsolution.v2.Network | Network}. + * The first element of the array is Array of {@link protos.google.cloud.baremetalsolution.v2.Network|Network}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `listNetworksAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listNetworks( @@ -2884,13 +2853,12 @@ export class BareMetalSolutionClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.cloud.baremetalsolution.v2.Network | Network} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.baremetalsolution.v2.Network|Network} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listNetworksAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listNetworksStream( @@ -2933,12 +2901,11 @@ export class BareMetalSolutionClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.cloud.baremetalsolution.v2.Network | Network}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.baremetalsolution.v2.Network|Network}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v2/bare_metal_solution.list_networks.js * region_tag:baremetalsolution_v2_generated_BareMetalSolution_ListNetworks_async @@ -2979,14 +2946,13 @@ export class BareMetalSolutionClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.cloud.baremetalsolution.v2.Lun | Lun}. + * The first element of the array is Array of {@link protos.google.cloud.baremetalsolution.v2.Lun|Lun}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `listLunsAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listLuns( @@ -3078,13 +3044,12 @@ export class BareMetalSolutionClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.cloud.baremetalsolution.v2.Lun | Lun} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.baremetalsolution.v2.Lun|Lun} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listLunsAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listLunsStream( @@ -3125,12 +3090,11 @@ export class BareMetalSolutionClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.cloud.baremetalsolution.v2.Lun | Lun}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.baremetalsolution.v2.Lun|Lun}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v2/bare_metal_solution.list_luns.js * region_tag:baremetalsolution_v2_generated_BareMetalSolution_ListLuns_async @@ -3173,14 +3137,13 @@ export class BareMetalSolutionClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.cloud.baremetalsolution.v2.NfsShare | NfsShare}. + * The first element of the array is Array of {@link protos.google.cloud.baremetalsolution.v2.NfsShare|NfsShare}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `listNfsSharesAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listNfsShares( @@ -3274,13 +3237,12 @@ export class BareMetalSolutionClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.cloud.baremetalsolution.v2.NfsShare | NfsShare} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.baremetalsolution.v2.NfsShare|NfsShare} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listNfsSharesAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listNfsSharesStream( @@ -3323,12 +3285,11 @@ export class BareMetalSolutionClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.cloud.baremetalsolution.v2.NfsShare | NfsShare}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.baremetalsolution.v2.NfsShare|NfsShare}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v2/bare_metal_solution.list_nfs_shares.js * region_tag:baremetalsolution_v2_generated_BareMetalSolution_ListNfsShares_async @@ -3393,7 +3354,7 @@ export class BareMetalSolutionClient { IamProtos.google.iam.v1.GetIamPolicyRequest | null | undefined, {} | null | undefined > - ): Promise { + ): Promise<[IamProtos.google.iam.v1.Policy]> { return this.iamClient.getIamPolicy(request, options, callback); } @@ -3414,8 +3375,7 @@ export class BareMetalSolutionClient { * @param {string[]} request.permissions * The set of permissions to check for the `resource`. Permissions with * wildcards (such as '*' or 'storage.*') are not allowed. For more - * information see - * [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). + * information see {@link https://cloud.google.com/iam/docs/overview#permissions | IAM Overview }. * @param {Object} [options] * Optional parameters. You can override the default settings for this call, e.g, timeout, * retries, paginations, etc. See {@link https://googleapis.github.io/gax-nodejs/interfaces/CallOptions.html | gax.CallOptions} for the details. @@ -3441,7 +3401,7 @@ export class BareMetalSolutionClient { IamProtos.google.iam.v1.SetIamPolicyRequest | null | undefined, {} | null | undefined > - ): Promise { + ): Promise<[IamProtos.google.iam.v1.Policy]> { return this.iamClient.setIamPolicy(request, options, callback); } @@ -3462,8 +3422,7 @@ export class BareMetalSolutionClient { * @param {string[]} request.permissions * The set of permissions to check for the `resource`. Permissions with * wildcards (such as '*' or 'storage.*') are not allowed. For more - * information see - * [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). + * information see {@link https://cloud.google.com/iam/docs/overview#permissions | IAM Overview }. * @param {Object} [options] * Optional parameters. You can override the default settings for this call, e.g, timeout, * retries, paginations, etc. See {@link https://googleapis.github.io/gax-nodejs/interfaces/CallOptions.html | gax.CallOptions} for the details. @@ -3490,7 +3449,7 @@ export class BareMetalSolutionClient { IamProtos.google.iam.v1.TestIamPermissionsRequest | null | undefined, {} | null | undefined > - ): Promise { + ): Promise<[IamProtos.google.iam.v1.TestIamPermissionsResponse]> { return this.iamClient.testIamPermissions(request, options, callback); } @@ -3505,8 +3464,7 @@ export class BareMetalSolutionClient { * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html | CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing {@link google.cloud.location.Location | Location}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example * ``` @@ -3552,12 +3510,11 @@ export class BareMetalSolutionClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing * {@link google.cloud.location.Location | Location}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example * ``` diff --git a/packages/google-cloud-beyondcorp-appconnections/README.md b/packages/google-cloud-beyondcorp-appconnections/README.md index 715a1b673c5..84e8bb32301 100644 --- a/packages/google-cloud-beyondcorp-appconnections/README.md +++ b/packages/google-cloud-beyondcorp-appconnections/README.md @@ -2,7 +2,7 @@ [//]: # "To regenerate it, use `python -m synthtool`." Google Cloud Platform logo -# [BeyondCorp API: Node.js Client](https://github.com/googleapis/google-cloud-node) +# [BeyondCorp API: Node.js Client](https://github.com/googleapis/google-cloud-node/tree/main/packages/google-cloud-beyondcorp-appconnections) [![release level](https://img.shields.io/badge/release%20level-preview-yellow.svg?style=flat)](https://cloud.google.com/terms/launch-stages) [![npm version](https://img.shields.io/npm/v/@google-cloud/appconnections.svg)](https://www.npmjs.org/package/@google-cloud/appconnections) @@ -121,18 +121,17 @@ callListAppConnections(); ## Samples -Samples are in the [`samples/`](https://github.com/googleapis/google-cloud-node/tree/main/samples) directory. Each sample's `README.md` has instructions for running its sample. +Samples are in the [`samples/`](https://github.com/googleapis/google-cloud-node/tree/main/packages/google-cloud-beyondcorp-appconnections/samples) directory. Each sample's `README.md` has instructions for running its sample. | Sample | Source Code | Try it | | --------------------------- | --------------------------------- | ------ | -| App_connections_service.create_app_connection | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-beyondcorp-appconnections/samples/generated/v1/app_connections_service.create_app_connection.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-beyondcorp-appconnections/samples/generated/v1/app_connections_service.create_app_connection.js,samples/README.md) | -| App_connections_service.delete_app_connection | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-beyondcorp-appconnections/samples/generated/v1/app_connections_service.delete_app_connection.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-beyondcorp-appconnections/samples/generated/v1/app_connections_service.delete_app_connection.js,samples/README.md) | -| App_connections_service.get_app_connection | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-beyondcorp-appconnections/samples/generated/v1/app_connections_service.get_app_connection.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-beyondcorp-appconnections/samples/generated/v1/app_connections_service.get_app_connection.js,samples/README.md) | -| App_connections_service.list_app_connections | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-beyondcorp-appconnections/samples/generated/v1/app_connections_service.list_app_connections.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-beyondcorp-appconnections/samples/generated/v1/app_connections_service.list_app_connections.js,samples/README.md) | -| App_connections_service.resolve_app_connections | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-beyondcorp-appconnections/samples/generated/v1/app_connections_service.resolve_app_connections.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-beyondcorp-appconnections/samples/generated/v1/app_connections_service.resolve_app_connections.js,samples/README.md) | -| App_connections_service.update_app_connection | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-beyondcorp-appconnections/samples/generated/v1/app_connections_service.update_app_connection.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-beyondcorp-appconnections/samples/generated/v1/app_connections_service.update_app_connection.js,samples/README.md) | -| Quickstart | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-beyondcorp-appconnections/samples/quickstart.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-beyondcorp-appconnections/samples/quickstart.js,samples/README.md) | -| Quickstart | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-beyondcorp-appconnections/samples/test/quickstart.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-beyondcorp-appconnections/samples/test/quickstart.js,samples/README.md) | +| App_connections_service.create_app_connection | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-beyondcorp-appconnections/samples/generated/v1/app_connections_service.create_app_connection.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-beyondcorp-appconnections/samples/generated/v1/app_connections_service.create_app_connection.js,packages/google-cloud-beyondcorp-appconnections/samples/README.md) | +| App_connections_service.delete_app_connection | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-beyondcorp-appconnections/samples/generated/v1/app_connections_service.delete_app_connection.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-beyondcorp-appconnections/samples/generated/v1/app_connections_service.delete_app_connection.js,packages/google-cloud-beyondcorp-appconnections/samples/README.md) | +| App_connections_service.get_app_connection | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-beyondcorp-appconnections/samples/generated/v1/app_connections_service.get_app_connection.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-beyondcorp-appconnections/samples/generated/v1/app_connections_service.get_app_connection.js,packages/google-cloud-beyondcorp-appconnections/samples/README.md) | +| App_connections_service.list_app_connections | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-beyondcorp-appconnections/samples/generated/v1/app_connections_service.list_app_connections.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-beyondcorp-appconnections/samples/generated/v1/app_connections_service.list_app_connections.js,packages/google-cloud-beyondcorp-appconnections/samples/README.md) | +| App_connections_service.resolve_app_connections | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-beyondcorp-appconnections/samples/generated/v1/app_connections_service.resolve_app_connections.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-beyondcorp-appconnections/samples/generated/v1/app_connections_service.resolve_app_connections.js,packages/google-cloud-beyondcorp-appconnections/samples/README.md) | +| App_connections_service.update_app_connection | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-beyondcorp-appconnections/samples/generated/v1/app_connections_service.update_app_connection.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-beyondcorp-appconnections/samples/generated/v1/app_connections_service.update_app_connection.js,packages/google-cloud-beyondcorp-appconnections/samples/README.md) | +| Quickstart | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-beyondcorp-appconnections/samples/quickstart.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-beyondcorp-appconnections/samples/quickstart.js,packages/google-cloud-beyondcorp-appconnections/samples/README.md) | diff --git a/packages/google-cloud-beyondcorp-appconnections/package.json b/packages/google-cloud-beyondcorp-appconnections/package.json index 4a23e7a2795..fbbb19cf44f 100644 --- a/packages/google-cloud-beyondcorp-appconnections/package.json +++ b/packages/google-cloud-beyondcorp-appconnections/package.json @@ -46,14 +46,15 @@ "test": "c8 mocha build/test" }, "dependencies": { - "google-gax": "^3.5.8" + "google-gax": "^4.0.3" }, "devDependencies": { "@types/mocha": "^9.0.0", - "@types/node": "^18.0.0", + "@types/node": "^20.4.5", "@types/sinon": "^10.0.0", "c8": "^7.3.5", - "gts": "^3.1.0", + "gapic-tools": "^0.1.8", + "gts": "^5.0.0", "jsdoc": "^4.0.0", "jsdoc-fresh": "^2.0.0", "jsdoc-region-tag": "^2.0.0", @@ -64,11 +65,11 @@ "pack-n-play": "^1.0.0-2", "sinon": "^15.0.0", "ts-loader": "^9.0.0", - "typescript": "^4.6.4", + "typescript": "^5.1.6", "webpack": "^5.9.0", "webpack-cli": "^5.0.0" }, "engines": { - "node": ">=12.0.0" + "node": ">=14.0.0" } } diff --git a/packages/google-cloud-beyondcorp-appconnections/samples/README.md b/packages/google-cloud-beyondcorp-appconnections/samples/README.md index 06b957bf82a..41b96737af0 100644 --- a/packages/google-cloud-beyondcorp-appconnections/samples/README.md +++ b/packages/google-cloud-beyondcorp-appconnections/samples/README.md @@ -19,7 +19,6 @@ * [App_connections_service.resolve_app_connections](#app_connections_service.resolve_app_connections) * [App_connections_service.update_app_connection](#app_connections_service.update_app_connection) * [Quickstart](#quickstart) - * [Quickstart](#quickstart) ## Before you begin @@ -150,23 +149,6 @@ __Usage:__ `node packages/google-cloud-beyondcorp-appconnections/samples/quickstart.js` ------ - - - - -### Quickstart - -View the [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-beyondcorp-appconnections/samples/test/quickstart.js). - -[![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-beyondcorp-appconnections/samples/test/quickstart.js,samples/README.md) - -__Usage:__ - - -`node packages/google-cloud-beyondcorp-appconnections/samples/test/quickstart.js` - - diff --git a/packages/google-cloud-beyondcorp-appconnections/samples/generated/v1/snippet_metadata.google.cloud.beyondcorp.appconnections.v1.json b/packages/google-cloud-beyondcorp-appconnections/samples/generated/v1/snippet_metadata.google.cloud.beyondcorp.appconnections.v1.json index 282b8b2e15a..0e2594e3f7c 100644 --- a/packages/google-cloud-beyondcorp-appconnections/samples/generated/v1/snippet_metadata.google.cloud.beyondcorp.appconnections.v1.json +++ b/packages/google-cloud-beyondcorp-appconnections/samples/generated/v1/snippet_metadata.google.cloud.beyondcorp.appconnections.v1.json @@ -1,7 +1,7 @@ { "clientLibrary": { "name": "nodejs-appconnections", - "version": "0.3.1", + "version": "0.3.2", "language": "TYPESCRIPT", "apis": [ { diff --git a/packages/google-cloud-beyondcorp-appconnections/samples/generated/v1/snippet_metadata_google.cloud.beyondcorp.appconnections.v1.json b/packages/google-cloud-beyondcorp-appconnections/samples/generated/v1/snippet_metadata_google.cloud.beyondcorp.appconnections.v1.json new file mode 100644 index 00000000000..0e2594e3f7c --- /dev/null +++ b/packages/google-cloud-beyondcorp-appconnections/samples/generated/v1/snippet_metadata_google.cloud.beyondcorp.appconnections.v1.json @@ -0,0 +1,323 @@ +{ + "clientLibrary": { + "name": "nodejs-appconnections", + "version": "0.3.2", + "language": "TYPESCRIPT", + "apis": [ + { + "id": "google.cloud.beyondcorp.appconnections.v1", + "version": "v1" + } + ] + }, + "snippets": [ + { + "regionTag": "beyondcorp_v1_generated_AppConnectionsService_ListAppConnections_async", + "title": "AppConnectionsService listAppConnections Sample", + "origin": "API_DEFINITION", + "description": " Lists AppConnections in a given project and location.", + "canonical": true, + "file": "app_connections_service.list_app_connections.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 81, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListAppConnections", + "fullName": "google.cloud.beyondcorp.appconnections.v1.AppConnectionsService.ListAppConnections", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.beyondcorp.appconnections.v1.ListAppConnectionsResponse", + "client": { + "shortName": "AppConnectionsServiceClient", + "fullName": "google.cloud.beyondcorp.appconnections.v1.AppConnectionsServiceClient" + }, + "method": { + "shortName": "ListAppConnections", + "fullName": "google.cloud.beyondcorp.appconnections.v1.AppConnectionsService.ListAppConnections", + "service": { + "shortName": "AppConnectionsService", + "fullName": "google.cloud.beyondcorp.appconnections.v1.AppConnectionsService" + } + } + } + }, + { + "regionTag": "beyondcorp_v1_generated_AppConnectionsService_GetAppConnection_async", + "title": "AppConnectionsService getAppConnection Sample", + "origin": "API_DEFINITION", + "description": " Gets details of a single AppConnection.", + "canonical": true, + "file": "app_connections_service.get_app_connection.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 54, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetAppConnection", + "fullName": "google.cloud.beyondcorp.appconnections.v1.AppConnectionsService.GetAppConnection", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.beyondcorp.appconnections.v1.AppConnection", + "client": { + "shortName": "AppConnectionsServiceClient", + "fullName": "google.cloud.beyondcorp.appconnections.v1.AppConnectionsServiceClient" + }, + "method": { + "shortName": "GetAppConnection", + "fullName": "google.cloud.beyondcorp.appconnections.v1.AppConnectionsService.GetAppConnection", + "service": { + "shortName": "AppConnectionsService", + "fullName": "google.cloud.beyondcorp.appconnections.v1.AppConnectionsService" + } + } + } + }, + { + "regionTag": "beyondcorp_v1_generated_AppConnectionsService_CreateAppConnection_async", + "title": "AppConnectionsService createAppConnection Sample", + "origin": "API_DEFINITION", + "description": " Creates a new AppConnection in a given project and location.", + "canonical": true, + "file": "app_connections_service.create_app_connection.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 86, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CreateAppConnection", + "fullName": "google.cloud.beyondcorp.appconnections.v1.AppConnectionsService.CreateAppConnection", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "app_connection_id", + "type": "TYPE_STRING" + }, + { + "name": "app_connection", + "type": ".google.cloud.beyondcorp.appconnections.v1.AppConnection" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "validate_only", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "AppConnectionsServiceClient", + "fullName": "google.cloud.beyondcorp.appconnections.v1.AppConnectionsServiceClient" + }, + "method": { + "shortName": "CreateAppConnection", + "fullName": "google.cloud.beyondcorp.appconnections.v1.AppConnectionsService.CreateAppConnection", + "service": { + "shortName": "AppConnectionsService", + "fullName": "google.cloud.beyondcorp.appconnections.v1.AppConnectionsService" + } + } + } + }, + { + "regionTag": "beyondcorp_v1_generated_AppConnectionsService_UpdateAppConnection_async", + "title": "AppConnectionsService updateAppConnection Sample", + "origin": "API_DEFINITION", + "description": " Updates the parameters of a single AppConnection.", + "canonical": true, + "file": "app_connections_service.update_app_connection.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 89, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "UpdateAppConnection", + "fullName": "google.cloud.beyondcorp.appconnections.v1.AppConnectionsService.UpdateAppConnection", + "async": true, + "parameters": [ + { + "name": "update_mask", + "type": ".google.protobuf.FieldMask" + }, + { + "name": "app_connection", + "type": ".google.cloud.beyondcorp.appconnections.v1.AppConnection" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "validate_only", + "type": "TYPE_BOOL" + }, + { + "name": "allow_missing", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "AppConnectionsServiceClient", + "fullName": "google.cloud.beyondcorp.appconnections.v1.AppConnectionsServiceClient" + }, + "method": { + "shortName": "UpdateAppConnection", + "fullName": "google.cloud.beyondcorp.appconnections.v1.AppConnectionsService.UpdateAppConnection", + "service": { + "shortName": "AppConnectionsService", + "fullName": "google.cloud.beyondcorp.appconnections.v1.AppConnectionsService" + } + } + } + }, + { + "regionTag": "beyondcorp_v1_generated_AppConnectionsService_DeleteAppConnection_async", + "title": "AppConnectionsService deleteAppConnection Sample", + "origin": "API_DEFINITION", + "description": " Deletes a single AppConnection.", + "canonical": true, + "file": "app_connections_service.delete_app_connection.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 74, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeleteAppConnection", + "fullName": "google.cloud.beyondcorp.appconnections.v1.AppConnectionsService.DeleteAppConnection", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "validate_only", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "AppConnectionsServiceClient", + "fullName": "google.cloud.beyondcorp.appconnections.v1.AppConnectionsServiceClient" + }, + "method": { + "shortName": "DeleteAppConnection", + "fullName": "google.cloud.beyondcorp.appconnections.v1.AppConnectionsService.DeleteAppConnection", + "service": { + "shortName": "AppConnectionsService", + "fullName": "google.cloud.beyondcorp.appconnections.v1.AppConnectionsService" + } + } + } + }, + { + "regionTag": "beyondcorp_v1_generated_AppConnectionsService_ResolveAppConnections_async", + "title": "AppConnectionsService resolveAppConnections Sample", + "origin": "API_DEFINITION", + "description": " Resolves AppConnections details for a given AppConnector. An internal method called by a connector to find AppConnections to connect to.", + "canonical": true, + "file": "app_connections_service.resolve_app_connections.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 77, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ResolveAppConnections", + "fullName": "google.cloud.beyondcorp.appconnections.v1.AppConnectionsService.ResolveAppConnections", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "app_connector_id", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.beyondcorp.appconnections.v1.ResolveAppConnectionsResponse", + "client": { + "shortName": "AppConnectionsServiceClient", + "fullName": "google.cloud.beyondcorp.appconnections.v1.AppConnectionsServiceClient" + }, + "method": { + "shortName": "ResolveAppConnections", + "fullName": "google.cloud.beyondcorp.appconnections.v1.AppConnectionsService.ResolveAppConnections", + "service": { + "shortName": "AppConnectionsService", + "fullName": "google.cloud.beyondcorp.appconnections.v1.AppConnectionsService" + } + } + } + } + ] +} \ No newline at end of file diff --git a/packages/google-cloud-beyondcorp-appconnections/samples/package.json b/packages/google-cloud-beyondcorp-appconnections/samples/package.json index 7e6213dd17e..9091ee5d4b0 100644 --- a/packages/google-cloud-beyondcorp-appconnections/samples/package.json +++ b/packages/google-cloud-beyondcorp-appconnections/samples/package.json @@ -4,7 +4,7 @@ "license": "Apache-2.0", "author": "Google LLC", "engines": { - "node": ">=12.0.0" + "node": ">=14.0.0" }, "files": [ "*.js" @@ -21,4 +21,4 @@ "chai": "^4.2.0", "mocha": "^8.0.0" } -} +} \ No newline at end of file diff --git a/packages/google-cloud-beyondcorp-appconnections/src/v1/app_connections_service_client.ts b/packages/google-cloud-beyondcorp-appconnections/src/v1/app_connections_service_client.ts index 5513fe5f094..9b30b91dc7a 100644 --- a/packages/google-cloud-beyondcorp-appconnections/src/v1/app_connections_service_client.ts +++ b/packages/google-cloud-beyondcorp-appconnections/src/v1/app_connections_service_client.ts @@ -533,9 +533,8 @@ export class AppConnectionsServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.beyondcorp.appconnections.v1.AppConnection | AppConnection}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.beyondcorp.appconnections.v1.AppConnection|AppConnection}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/app_connections_service.get_app_connection.js * region_tag:beyondcorp_v1_generated_AppConnectionsService_GetAppConnection_async @@ -632,7 +631,7 @@ export class AppConnectionsServiceClient { * @param {string} [request.appConnectionId] * Optional. User-settable AppConnection resource ID. * * Must start with a letter. - * * Must contain between 4-63 characters from `/{@link 0-9|a-z}-/`. + * * Must contain between 4-63 characters from `/{@link protos.0-9|a-z}-/`. * * Must end with a number or a letter. * @param {google.cloud.beyondcorp.appconnections.v1.AppConnection} request.appConnection * Required. A BeyondCorp AppConnection resource. @@ -659,8 +658,7 @@ export class AppConnectionsServiceClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/app_connections_service.create_app_connection.js * region_tag:beyondcorp_v1_generated_AppConnectionsService_CreateAppConnection_async @@ -755,8 +753,7 @@ export class AppConnectionsServiceClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/app_connections_service.create_app_connection.js * region_tag:beyondcorp_v1_generated_AppConnectionsService_CreateAppConnection_async @@ -825,8 +822,7 @@ export class AppConnectionsServiceClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/app_connections_service.update_app_connection.js * region_tag:beyondcorp_v1_generated_AppConnectionsService_UpdateAppConnection_async @@ -921,8 +917,7 @@ export class AppConnectionsServiceClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/app_connections_service.update_app_connection.js * region_tag:beyondcorp_v1_generated_AppConnectionsService_UpdateAppConnection_async @@ -981,8 +976,7 @@ export class AppConnectionsServiceClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/app_connections_service.delete_app_connection.js * region_tag:beyondcorp_v1_generated_AppConnectionsService_DeleteAppConnection_async @@ -1077,8 +1071,7 @@ export class AppConnectionsServiceClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/app_connections_service.delete_app_connection.js * region_tag:beyondcorp_v1_generated_AppConnectionsService_DeleteAppConnection_async @@ -1119,7 +1112,7 @@ export class AppConnectionsServiceClient { * If not specified, a default value of 50 will be used by the service. * Regardless of the page_size value, the response may include a partial list * and a caller should only rely on response's - * {@link BeyondCorp.ListAppConnectionsResponse.next_page_token|next_page_token} to + * {@link protos.BeyondCorp.ListAppConnectionsResponse.next_page_token|next_page_token} to * determine if there are more instances left to be queried. * @param {string} [request.pageToken] * Optional. The next_page_token value returned from a previous @@ -1134,14 +1127,13 @@ export class AppConnectionsServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.cloud.beyondcorp.appconnections.v1.AppConnection | AppConnection}. + * The first element of the array is Array of {@link protos.google.cloud.beyondcorp.appconnections.v1.AppConnection|AppConnection}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `listAppConnectionsAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listAppConnections( @@ -1231,7 +1223,7 @@ export class AppConnectionsServiceClient { * If not specified, a default value of 50 will be used by the service. * Regardless of the page_size value, the response may include a partial list * and a caller should only rely on response's - * {@link BeyondCorp.ListAppConnectionsResponse.next_page_token|next_page_token} to + * {@link protos.BeyondCorp.ListAppConnectionsResponse.next_page_token|next_page_token} to * determine if there are more instances left to be queried. * @param {string} [request.pageToken] * Optional. The next_page_token value returned from a previous @@ -1246,13 +1238,12 @@ export class AppConnectionsServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.cloud.beyondcorp.appconnections.v1.AppConnection | AppConnection} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.beyondcorp.appconnections.v1.AppConnection|AppConnection} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listAppConnectionsAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listAppConnectionsStream( @@ -1291,7 +1282,7 @@ export class AppConnectionsServiceClient { * If not specified, a default value of 50 will be used by the service. * Regardless of the page_size value, the response may include a partial list * and a caller should only rely on response's - * {@link BeyondCorp.ListAppConnectionsResponse.next_page_token|next_page_token} to + * {@link protos.BeyondCorp.ListAppConnectionsResponse.next_page_token|next_page_token} to * determine if there are more instances left to be queried. * @param {string} [request.pageToken] * Optional. The next_page_token value returned from a previous @@ -1306,12 +1297,11 @@ export class AppConnectionsServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.cloud.beyondcorp.appconnections.v1.AppConnection | AppConnection}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.beyondcorp.appconnections.v1.AppConnection|AppConnection}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1/app_connections_service.list_app_connections.js * region_tag:beyondcorp_v1_generated_AppConnectionsService_ListAppConnections_async @@ -1356,7 +1346,7 @@ export class AppConnectionsServiceClient { * If not specified, a default value of 50 will be used by the service. * Regardless of the page_size value, the response may include a partial list * and a caller should only rely on response's - * {@link BeyondCorp.ResolveAppConnectionsResponse.next_page_token|next_page_token} + * {@link protos.BeyondCorp.ResolveAppConnectionsResponse.next_page_token|next_page_token} * to determine if there are more instances left to be queried. * @param {string} [request.pageToken] * Optional. The next_page_token value returned from a previous @@ -1364,14 +1354,13 @@ export class AppConnectionsServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.cloud.beyondcorp.appconnections.v1.ResolveAppConnectionsResponse.AppConnectionDetails | AppConnectionDetails}. + * The first element of the array is Array of {@link protos.google.cloud.beyondcorp.appconnections.v1.ResolveAppConnectionsResponse.AppConnectionDetails|AppConnectionDetails}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `resolveAppConnectionsAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ resolveAppConnections( @@ -1465,7 +1454,7 @@ export class AppConnectionsServiceClient { * If not specified, a default value of 50 will be used by the service. * Regardless of the page_size value, the response may include a partial list * and a caller should only rely on response's - * {@link BeyondCorp.ResolveAppConnectionsResponse.next_page_token|next_page_token} + * {@link protos.BeyondCorp.ResolveAppConnectionsResponse.next_page_token|next_page_token} * to determine if there are more instances left to be queried. * @param {string} [request.pageToken] * Optional. The next_page_token value returned from a previous @@ -1473,13 +1462,12 @@ export class AppConnectionsServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.cloud.beyondcorp.appconnections.v1.ResolveAppConnectionsResponse.AppConnectionDetails | AppConnectionDetails} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.beyondcorp.appconnections.v1.ResolveAppConnectionsResponse.AppConnectionDetails|AppConnectionDetails} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `resolveAppConnectionsAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ resolveAppConnectionsStream( @@ -1522,7 +1510,7 @@ export class AppConnectionsServiceClient { * If not specified, a default value of 50 will be used by the service. * Regardless of the page_size value, the response may include a partial list * and a caller should only rely on response's - * {@link BeyondCorp.ResolveAppConnectionsResponse.next_page_token|next_page_token} + * {@link protos.BeyondCorp.ResolveAppConnectionsResponse.next_page_token|next_page_token} * to determine if there are more instances left to be queried. * @param {string} [request.pageToken] * Optional. The next_page_token value returned from a previous @@ -1530,12 +1518,11 @@ export class AppConnectionsServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.cloud.beyondcorp.appconnections.v1.ResolveAppConnectionsResponse.AppConnectionDetails | AppConnectionDetails}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.beyondcorp.appconnections.v1.ResolveAppConnectionsResponse.AppConnectionDetails|AppConnectionDetails}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1/app_connections_service.resolve_app_connections.js * region_tag:beyondcorp_v1_generated_AppConnectionsService_ResolveAppConnections_async @@ -1600,7 +1587,7 @@ export class AppConnectionsServiceClient { IamProtos.google.iam.v1.GetIamPolicyRequest | null | undefined, {} | null | undefined > - ): Promise { + ): Promise<[IamProtos.google.iam.v1.Policy]> { return this.iamClient.getIamPolicy(request, options, callback); } @@ -1621,8 +1608,7 @@ export class AppConnectionsServiceClient { * @param {string[]} request.permissions * The set of permissions to check for the `resource`. Permissions with * wildcards (such as '*' or 'storage.*') are not allowed. For more - * information see - * [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). + * information see {@link https://cloud.google.com/iam/docs/overview#permissions | IAM Overview }. * @param {Object} [options] * Optional parameters. You can override the default settings for this call, e.g, timeout, * retries, paginations, etc. See {@link https://googleapis.github.io/gax-nodejs/interfaces/CallOptions.html | gax.CallOptions} for the details. @@ -1648,7 +1634,7 @@ export class AppConnectionsServiceClient { IamProtos.google.iam.v1.SetIamPolicyRequest | null | undefined, {} | null | undefined > - ): Promise { + ): Promise<[IamProtos.google.iam.v1.Policy]> { return this.iamClient.setIamPolicy(request, options, callback); } @@ -1669,8 +1655,7 @@ export class AppConnectionsServiceClient { * @param {string[]} request.permissions * The set of permissions to check for the `resource`. Permissions with * wildcards (such as '*' or 'storage.*') are not allowed. For more - * information see - * [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). + * information see {@link https://cloud.google.com/iam/docs/overview#permissions | IAM Overview }. * @param {Object} [options] * Optional parameters. You can override the default settings for this call, e.g, timeout, * retries, paginations, etc. See {@link https://googleapis.github.io/gax-nodejs/interfaces/CallOptions.html | gax.CallOptions} for the details. @@ -1697,7 +1682,7 @@ export class AppConnectionsServiceClient { IamProtos.google.iam.v1.TestIamPermissionsRequest | null | undefined, {} | null | undefined > - ): Promise { + ): Promise<[IamProtos.google.iam.v1.TestIamPermissionsResponse]> { return this.iamClient.testIamPermissions(request, options, callback); } @@ -1712,8 +1697,7 @@ export class AppConnectionsServiceClient { * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html | CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing {@link google.cloud.location.Location | Location}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example * ``` @@ -1759,12 +1743,11 @@ export class AppConnectionsServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing * {@link google.cloud.location.Location | Location}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example * ``` diff --git a/packages/google-cloud-beyondcorp-appconnectors/README.md b/packages/google-cloud-beyondcorp-appconnectors/README.md index ba34d3374a5..805706488c3 100644 --- a/packages/google-cloud-beyondcorp-appconnectors/README.md +++ b/packages/google-cloud-beyondcorp-appconnectors/README.md @@ -2,7 +2,7 @@ [//]: # "To regenerate it, use `python -m synthtool`." Google Cloud Platform logo -# [BeyondCorp API: Node.js Client](https://github.com/googleapis/google-cloud-node) +# [BeyondCorp API: Node.js Client](https://github.com/googleapis/google-cloud-node/tree/main/packages/google-cloud-beyondcorp-appconnectors) [![release level](https://img.shields.io/badge/release%20level-preview-yellow.svg?style=flat)](https://cloud.google.com/terms/launch-stages) [![npm version](https://img.shields.io/npm/v/@google-cloud/appconnectors.svg)](https://www.npmjs.org/package/@google-cloud/appconnectors) @@ -119,18 +119,17 @@ callListAppConnectors(); ## Samples -Samples are in the [`samples/`](https://github.com/googleapis/google-cloud-node/tree/main/samples) directory. Each sample's `README.md` has instructions for running its sample. +Samples are in the [`samples/`](https://github.com/googleapis/google-cloud-node/tree/main/packages/google-cloud-beyondcorp-appconnectors/samples) directory. Each sample's `README.md` has instructions for running its sample. | Sample | Source Code | Try it | | --------------------------- | --------------------------------- | ------ | -| App_connectors_service.create_app_connector | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-beyondcorp-appconnectors/samples/generated/v1/app_connectors_service.create_app_connector.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-beyondcorp-appconnectors/samples/generated/v1/app_connectors_service.create_app_connector.js,samples/README.md) | -| App_connectors_service.delete_app_connector | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-beyondcorp-appconnectors/samples/generated/v1/app_connectors_service.delete_app_connector.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-beyondcorp-appconnectors/samples/generated/v1/app_connectors_service.delete_app_connector.js,samples/README.md) | -| App_connectors_service.get_app_connector | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-beyondcorp-appconnectors/samples/generated/v1/app_connectors_service.get_app_connector.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-beyondcorp-appconnectors/samples/generated/v1/app_connectors_service.get_app_connector.js,samples/README.md) | -| App_connectors_service.list_app_connectors | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-beyondcorp-appconnectors/samples/generated/v1/app_connectors_service.list_app_connectors.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-beyondcorp-appconnectors/samples/generated/v1/app_connectors_service.list_app_connectors.js,samples/README.md) | -| App_connectors_service.report_status | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-beyondcorp-appconnectors/samples/generated/v1/app_connectors_service.report_status.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-beyondcorp-appconnectors/samples/generated/v1/app_connectors_service.report_status.js,samples/README.md) | -| App_connectors_service.update_app_connector | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-beyondcorp-appconnectors/samples/generated/v1/app_connectors_service.update_app_connector.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-beyondcorp-appconnectors/samples/generated/v1/app_connectors_service.update_app_connector.js,samples/README.md) | -| Quickstart | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-beyondcorp-appconnectors/samples/quickstart.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-beyondcorp-appconnectors/samples/quickstart.js,samples/README.md) | -| Quickstart | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-beyondcorp-appconnectors/samples/test/quickstart.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-beyondcorp-appconnectors/samples/test/quickstart.js,samples/README.md) | +| App_connectors_service.create_app_connector | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-beyondcorp-appconnectors/samples/generated/v1/app_connectors_service.create_app_connector.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-beyondcorp-appconnectors/samples/generated/v1/app_connectors_service.create_app_connector.js,packages/google-cloud-beyondcorp-appconnectors/samples/README.md) | +| App_connectors_service.delete_app_connector | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-beyondcorp-appconnectors/samples/generated/v1/app_connectors_service.delete_app_connector.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-beyondcorp-appconnectors/samples/generated/v1/app_connectors_service.delete_app_connector.js,packages/google-cloud-beyondcorp-appconnectors/samples/README.md) | +| App_connectors_service.get_app_connector | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-beyondcorp-appconnectors/samples/generated/v1/app_connectors_service.get_app_connector.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-beyondcorp-appconnectors/samples/generated/v1/app_connectors_service.get_app_connector.js,packages/google-cloud-beyondcorp-appconnectors/samples/README.md) | +| App_connectors_service.list_app_connectors | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-beyondcorp-appconnectors/samples/generated/v1/app_connectors_service.list_app_connectors.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-beyondcorp-appconnectors/samples/generated/v1/app_connectors_service.list_app_connectors.js,packages/google-cloud-beyondcorp-appconnectors/samples/README.md) | +| App_connectors_service.report_status | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-beyondcorp-appconnectors/samples/generated/v1/app_connectors_service.report_status.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-beyondcorp-appconnectors/samples/generated/v1/app_connectors_service.report_status.js,packages/google-cloud-beyondcorp-appconnectors/samples/README.md) | +| App_connectors_service.update_app_connector | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-beyondcorp-appconnectors/samples/generated/v1/app_connectors_service.update_app_connector.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-beyondcorp-appconnectors/samples/generated/v1/app_connectors_service.update_app_connector.js,packages/google-cloud-beyondcorp-appconnectors/samples/README.md) | +| Quickstart | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-beyondcorp-appconnectors/samples/quickstart.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-beyondcorp-appconnectors/samples/quickstart.js,packages/google-cloud-beyondcorp-appconnectors/samples/README.md) | diff --git a/packages/google-cloud-beyondcorp-appconnectors/package.json b/packages/google-cloud-beyondcorp-appconnectors/package.json index 1b7e6f60f1f..090d13c41b4 100644 --- a/packages/google-cloud-beyondcorp-appconnectors/package.json +++ b/packages/google-cloud-beyondcorp-appconnectors/package.json @@ -46,14 +46,15 @@ "test": "c8 mocha build/test" }, "dependencies": { - "google-gax": "^3.5.8" + "google-gax": "^4.0.3" }, "devDependencies": { "@types/mocha": "^9.0.0", - "@types/node": "^18.0.0", + "@types/node": "^20.4.5", "@types/sinon": "^10.0.0", "c8": "^7.3.5", - "gts": "^3.1.0", + "gapic-tools": "^0.1.8", + "gts": "^5.0.0", "jsdoc": "^4.0.0", "jsdoc-fresh": "^2.0.0", "jsdoc-region-tag": "^2.0.0", @@ -64,11 +65,11 @@ "pack-n-play": "^1.0.0-2", "sinon": "^15.0.0", "ts-loader": "^9.0.0", - "typescript": "^4.6.4", + "typescript": "^5.1.6", "webpack": "^5.9.0", "webpack-cli": "^5.0.0" }, "engines": { - "node": ">=12.0.0" + "node": ">=14.0.0" } } diff --git a/packages/google-cloud-beyondcorp-appconnectors/samples/README.md b/packages/google-cloud-beyondcorp-appconnectors/samples/README.md index 756d1c60be4..fb76d98a5bf 100644 --- a/packages/google-cloud-beyondcorp-appconnectors/samples/README.md +++ b/packages/google-cloud-beyondcorp-appconnectors/samples/README.md @@ -19,7 +19,6 @@ * [App_connectors_service.report_status](#app_connectors_service.report_status) * [App_connectors_service.update_app_connector](#app_connectors_service.update_app_connector) * [Quickstart](#quickstart) - * [Quickstart](#quickstart) ## Before you begin @@ -150,23 +149,6 @@ __Usage:__ `node packages/google-cloud-beyondcorp-appconnectors/samples/quickstart.js` ------ - - - - -### Quickstart - -View the [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-beyondcorp-appconnectors/samples/test/quickstart.js). - -[![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-beyondcorp-appconnectors/samples/test/quickstart.js,samples/README.md) - -__Usage:__ - - -`node packages/google-cloud-beyondcorp-appconnectors/samples/test/quickstart.js` - - diff --git a/packages/google-cloud-beyondcorp-appconnectors/samples/generated/v1/snippet_metadata.google.cloud.beyondcorp.appconnectors.v1.json b/packages/google-cloud-beyondcorp-appconnectors/samples/generated/v1/snippet_metadata.google.cloud.beyondcorp.appconnectors.v1.json index 59c17415b19..17d95cc393c 100644 --- a/packages/google-cloud-beyondcorp-appconnectors/samples/generated/v1/snippet_metadata.google.cloud.beyondcorp.appconnectors.v1.json +++ b/packages/google-cloud-beyondcorp-appconnectors/samples/generated/v1/snippet_metadata.google.cloud.beyondcorp.appconnectors.v1.json @@ -1,7 +1,7 @@ { "clientLibrary": { "name": "nodejs-appconnectors", - "version": "0.4.1", + "version": "0.4.2", "language": "TYPESCRIPT", "apis": [ { diff --git a/packages/google-cloud-beyondcorp-appconnectors/samples/generated/v1/snippet_metadata_google.cloud.beyondcorp.appconnectors.v1.json b/packages/google-cloud-beyondcorp-appconnectors/samples/generated/v1/snippet_metadata_google.cloud.beyondcorp.appconnectors.v1.json new file mode 100644 index 00000000000..17d95cc393c --- /dev/null +++ b/packages/google-cloud-beyondcorp-appconnectors/samples/generated/v1/snippet_metadata_google.cloud.beyondcorp.appconnectors.v1.json @@ -0,0 +1,319 @@ +{ + "clientLibrary": { + "name": "nodejs-appconnectors", + "version": "0.4.2", + "language": "TYPESCRIPT", + "apis": [ + { + "id": "google.cloud.beyondcorp.appconnectors.v1", + "version": "v1" + } + ] + }, + "snippets": [ + { + "regionTag": "beyondcorp_v1_generated_AppConnectorsService_ListAppConnectors_async", + "title": "AppConnectorsService listAppConnectors Sample", + "origin": "API_DEFINITION", + "description": " Lists AppConnectors in a given project and location.", + "canonical": true, + "file": "app_connectors_service.list_app_connectors.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 81, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListAppConnectors", + "fullName": "google.cloud.beyondcorp.appconnectors.v1.AppConnectorsService.ListAppConnectors", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.beyondcorp.appconnectors.v1.ListAppConnectorsResponse", + "client": { + "shortName": "AppConnectorsServiceClient", + "fullName": "google.cloud.beyondcorp.appconnectors.v1.AppConnectorsServiceClient" + }, + "method": { + "shortName": "ListAppConnectors", + "fullName": "google.cloud.beyondcorp.appconnectors.v1.AppConnectorsService.ListAppConnectors", + "service": { + "shortName": "AppConnectorsService", + "fullName": "google.cloud.beyondcorp.appconnectors.v1.AppConnectorsService" + } + } + } + }, + { + "regionTag": "beyondcorp_v1_generated_AppConnectorsService_GetAppConnector_async", + "title": "AppConnectorsService getAppConnector Sample", + "origin": "API_DEFINITION", + "description": " Gets details of a single AppConnector.", + "canonical": true, + "file": "app_connectors_service.get_app_connector.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 54, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetAppConnector", + "fullName": "google.cloud.beyondcorp.appconnectors.v1.AppConnectorsService.GetAppConnector", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.beyondcorp.appconnectors.v1.AppConnector", + "client": { + "shortName": "AppConnectorsServiceClient", + "fullName": "google.cloud.beyondcorp.appconnectors.v1.AppConnectorsServiceClient" + }, + "method": { + "shortName": "GetAppConnector", + "fullName": "google.cloud.beyondcorp.appconnectors.v1.AppConnectorsService.GetAppConnector", + "service": { + "shortName": "AppConnectorsService", + "fullName": "google.cloud.beyondcorp.appconnectors.v1.AppConnectorsService" + } + } + } + }, + { + "regionTag": "beyondcorp_v1_generated_AppConnectorsService_CreateAppConnector_async", + "title": "AppConnectorsService createAppConnector Sample", + "origin": "API_DEFINITION", + "description": " Creates a new AppConnector in a given project and location.", + "canonical": true, + "file": "app_connectors_service.create_app_connector.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 86, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CreateAppConnector", + "fullName": "google.cloud.beyondcorp.appconnectors.v1.AppConnectorsService.CreateAppConnector", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "app_connector_id", + "type": "TYPE_STRING" + }, + { + "name": "app_connector", + "type": ".google.cloud.beyondcorp.appconnectors.v1.AppConnector" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "validate_only", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "AppConnectorsServiceClient", + "fullName": "google.cloud.beyondcorp.appconnectors.v1.AppConnectorsServiceClient" + }, + "method": { + "shortName": "CreateAppConnector", + "fullName": "google.cloud.beyondcorp.appconnectors.v1.AppConnectorsService.CreateAppConnector", + "service": { + "shortName": "AppConnectorsService", + "fullName": "google.cloud.beyondcorp.appconnectors.v1.AppConnectorsService" + } + } + } + }, + { + "regionTag": "beyondcorp_v1_generated_AppConnectorsService_UpdateAppConnector_async", + "title": "AppConnectorsService updateAppConnector Sample", + "origin": "API_DEFINITION", + "description": " Updates the parameters of a single AppConnector.", + "canonical": true, + "file": "app_connectors_service.update_app_connector.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 83, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "UpdateAppConnector", + "fullName": "google.cloud.beyondcorp.appconnectors.v1.AppConnectorsService.UpdateAppConnector", + "async": true, + "parameters": [ + { + "name": "update_mask", + "type": ".google.protobuf.FieldMask" + }, + { + "name": "app_connector", + "type": ".google.cloud.beyondcorp.appconnectors.v1.AppConnector" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "validate_only", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "AppConnectorsServiceClient", + "fullName": "google.cloud.beyondcorp.appconnectors.v1.AppConnectorsServiceClient" + }, + "method": { + "shortName": "UpdateAppConnector", + "fullName": "google.cloud.beyondcorp.appconnectors.v1.AppConnectorsService.UpdateAppConnector", + "service": { + "shortName": "AppConnectorsService", + "fullName": "google.cloud.beyondcorp.appconnectors.v1.AppConnectorsService" + } + } + } + }, + { + "regionTag": "beyondcorp_v1_generated_AppConnectorsService_DeleteAppConnector_async", + "title": "AppConnectorsService deleteAppConnector Sample", + "origin": "API_DEFINITION", + "description": " Deletes a single AppConnector.", + "canonical": true, + "file": "app_connectors_service.delete_app_connector.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 74, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeleteAppConnector", + "fullName": "google.cloud.beyondcorp.appconnectors.v1.AppConnectorsService.DeleteAppConnector", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "validate_only", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "AppConnectorsServiceClient", + "fullName": "google.cloud.beyondcorp.appconnectors.v1.AppConnectorsServiceClient" + }, + "method": { + "shortName": "DeleteAppConnector", + "fullName": "google.cloud.beyondcorp.appconnectors.v1.AppConnectorsService.DeleteAppConnector", + "service": { + "shortName": "AppConnectorsService", + "fullName": "google.cloud.beyondcorp.appconnectors.v1.AppConnectorsService" + } + } + } + }, + { + "regionTag": "beyondcorp_v1_generated_AppConnectorsService_ReportStatus_async", + "title": "AppConnectorsService reportStatus Sample", + "origin": "API_DEFINITION", + "description": " Report status for a given connector.", + "canonical": true, + "file": "app_connectors_service.report_status.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 79, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ReportStatus", + "fullName": "google.cloud.beyondcorp.appconnectors.v1.AppConnectorsService.ReportStatus", + "async": true, + "parameters": [ + { + "name": "app_connector", + "type": "TYPE_STRING" + }, + { + "name": "resource_info", + "type": ".google.cloud.beyondcorp.appconnectors.v1.ResourceInfo" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "validate_only", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "AppConnectorsServiceClient", + "fullName": "google.cloud.beyondcorp.appconnectors.v1.AppConnectorsServiceClient" + }, + "method": { + "shortName": "ReportStatus", + "fullName": "google.cloud.beyondcorp.appconnectors.v1.AppConnectorsService.ReportStatus", + "service": { + "shortName": "AppConnectorsService", + "fullName": "google.cloud.beyondcorp.appconnectors.v1.AppConnectorsService" + } + } + } + } + ] +} \ No newline at end of file diff --git a/packages/google-cloud-beyondcorp-appconnectors/samples/package.json b/packages/google-cloud-beyondcorp-appconnectors/samples/package.json index 2756ce93b67..2d95f18fc0f 100644 --- a/packages/google-cloud-beyondcorp-appconnectors/samples/package.json +++ b/packages/google-cloud-beyondcorp-appconnectors/samples/package.json @@ -4,7 +4,7 @@ "license": "Apache-2.0", "author": "Google LLC", "engines": { - "node": ">=12.0.0" + "node": ">=14.0.0" }, "files": [ "*.js" @@ -20,4 +20,4 @@ "chai": "^4.3.6", "mocha": "^8.0.0" } -} +} \ No newline at end of file diff --git a/packages/google-cloud-beyondcorp-appconnectors/src/v1/app_connectors_service_client.ts b/packages/google-cloud-beyondcorp-appconnectors/src/v1/app_connectors_service_client.ts index 2aa6cd90355..f29fc07bd8f 100644 --- a/packages/google-cloud-beyondcorp-appconnectors/src/v1/app_connectors_service_client.ts +++ b/packages/google-cloud-beyondcorp-appconnectors/src/v1/app_connectors_service_client.ts @@ -535,9 +535,8 @@ export class AppConnectorsServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.beyondcorp.appconnectors.v1.AppConnector | AppConnector}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.beyondcorp.appconnectors.v1.AppConnector|AppConnector}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/app_connectors_service.get_app_connector.js * region_tag:beyondcorp_v1_generated_AppConnectorsService_GetAppConnector_async @@ -635,7 +634,7 @@ export class AppConnectorsServiceClient { * Optional. User-settable AppConnector resource ID. * * * Must start with a letter. - * * Must contain between 4-63 characters from `/{@link 0-9|a-z}-/`. + * * Must contain between 4-63 characters from `/{@link protos.0-9|a-z}-/`. * * Must end with a number or a letter. * @param {google.cloud.beyondcorp.appconnectors.v1.AppConnector} request.appConnector * Required. A BeyondCorp AppConnector resource. @@ -662,8 +661,7 @@ export class AppConnectorsServiceClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/app_connectors_service.create_app_connector.js * region_tag:beyondcorp_v1_generated_AppConnectorsService_CreateAppConnector_async @@ -758,8 +756,7 @@ export class AppConnectorsServiceClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/app_connectors_service.create_app_connector.js * region_tag:beyondcorp_v1_generated_AppConnectorsService_CreateAppConnector_async @@ -824,8 +821,7 @@ export class AppConnectorsServiceClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/app_connectors_service.update_app_connector.js * region_tag:beyondcorp_v1_generated_AppConnectorsService_UpdateAppConnector_async @@ -920,8 +916,7 @@ export class AppConnectorsServiceClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/app_connectors_service.update_app_connector.js * region_tag:beyondcorp_v1_generated_AppConnectorsService_UpdateAppConnector_async @@ -980,8 +975,7 @@ export class AppConnectorsServiceClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/app_connectors_service.delete_app_connector.js * region_tag:beyondcorp_v1_generated_AppConnectorsService_DeleteAppConnector_async @@ -1076,8 +1070,7 @@ export class AppConnectorsServiceClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/app_connectors_service.delete_app_connector.js * region_tag:beyondcorp_v1_generated_AppConnectorsService_DeleteAppConnector_async @@ -1138,8 +1131,7 @@ export class AppConnectorsServiceClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/app_connectors_service.report_status.js * region_tag:beyondcorp_v1_generated_AppConnectorsService_ReportStatus_async @@ -1234,8 +1226,7 @@ export class AppConnectorsServiceClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/app_connectors_service.report_status.js * region_tag:beyondcorp_v1_generated_AppConnectorsService_ReportStatus_async @@ -1276,7 +1267,7 @@ export class AppConnectorsServiceClient { * If not specified, a default value of 50 will be used by the service. * Regardless of the page_size value, the response may include a partial list * and a caller should only rely on response's - * {@link BeyondCorp.ListAppConnectorsResponse.next_page_token|next_page_token} to + * {@link protos.BeyondCorp.ListAppConnectorsResponse.next_page_token|next_page_token} to * determine if there are more instances left to be queried. * @param {string} [request.pageToken] * Optional. The next_page_token value returned from a previous @@ -1291,14 +1282,13 @@ export class AppConnectorsServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.cloud.beyondcorp.appconnectors.v1.AppConnector | AppConnector}. + * The first element of the array is Array of {@link protos.google.cloud.beyondcorp.appconnectors.v1.AppConnector|AppConnector}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `listAppConnectorsAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listAppConnectors( @@ -1388,7 +1378,7 @@ export class AppConnectorsServiceClient { * If not specified, a default value of 50 will be used by the service. * Regardless of the page_size value, the response may include a partial list * and a caller should only rely on response's - * {@link BeyondCorp.ListAppConnectorsResponse.next_page_token|next_page_token} to + * {@link protos.BeyondCorp.ListAppConnectorsResponse.next_page_token|next_page_token} to * determine if there are more instances left to be queried. * @param {string} [request.pageToken] * Optional. The next_page_token value returned from a previous @@ -1403,13 +1393,12 @@ export class AppConnectorsServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.cloud.beyondcorp.appconnectors.v1.AppConnector | AppConnector} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.beyondcorp.appconnectors.v1.AppConnector|AppConnector} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listAppConnectorsAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listAppConnectorsStream( @@ -1448,7 +1437,7 @@ export class AppConnectorsServiceClient { * If not specified, a default value of 50 will be used by the service. * Regardless of the page_size value, the response may include a partial list * and a caller should only rely on response's - * {@link BeyondCorp.ListAppConnectorsResponse.next_page_token|next_page_token} to + * {@link protos.BeyondCorp.ListAppConnectorsResponse.next_page_token|next_page_token} to * determine if there are more instances left to be queried. * @param {string} [request.pageToken] * Optional. The next_page_token value returned from a previous @@ -1463,12 +1452,11 @@ export class AppConnectorsServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.cloud.beyondcorp.appconnectors.v1.AppConnector | AppConnector}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.beyondcorp.appconnectors.v1.AppConnector|AppConnector}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1/app_connectors_service.list_app_connectors.js * region_tag:beyondcorp_v1_generated_AppConnectorsService_ListAppConnectors_async @@ -1533,7 +1521,7 @@ export class AppConnectorsServiceClient { IamProtos.google.iam.v1.GetIamPolicyRequest | null | undefined, {} | null | undefined > - ): Promise { + ): Promise<[IamProtos.google.iam.v1.Policy]> { return this.iamClient.getIamPolicy(request, options, callback); } @@ -1554,8 +1542,7 @@ export class AppConnectorsServiceClient { * @param {string[]} request.permissions * The set of permissions to check for the `resource`. Permissions with * wildcards (such as '*' or 'storage.*') are not allowed. For more - * information see - * [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). + * information see {@link https://cloud.google.com/iam/docs/overview#permissions | IAM Overview }. * @param {Object} [options] * Optional parameters. You can override the default settings for this call, e.g, timeout, * retries, paginations, etc. See {@link https://googleapis.github.io/gax-nodejs/interfaces/CallOptions.html | gax.CallOptions} for the details. @@ -1581,7 +1568,7 @@ export class AppConnectorsServiceClient { IamProtos.google.iam.v1.SetIamPolicyRequest | null | undefined, {} | null | undefined > - ): Promise { + ): Promise<[IamProtos.google.iam.v1.Policy]> { return this.iamClient.setIamPolicy(request, options, callback); } @@ -1602,8 +1589,7 @@ export class AppConnectorsServiceClient { * @param {string[]} request.permissions * The set of permissions to check for the `resource`. Permissions with * wildcards (such as '*' or 'storage.*') are not allowed. For more - * information see - * [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). + * information see {@link https://cloud.google.com/iam/docs/overview#permissions | IAM Overview }. * @param {Object} [options] * Optional parameters. You can override the default settings for this call, e.g, timeout, * retries, paginations, etc. See {@link https://googleapis.github.io/gax-nodejs/interfaces/CallOptions.html | gax.CallOptions} for the details. @@ -1630,7 +1616,7 @@ export class AppConnectorsServiceClient { IamProtos.google.iam.v1.TestIamPermissionsRequest | null | undefined, {} | null | undefined > - ): Promise { + ): Promise<[IamProtos.google.iam.v1.TestIamPermissionsResponse]> { return this.iamClient.testIamPermissions(request, options, callback); } @@ -1645,8 +1631,7 @@ export class AppConnectorsServiceClient { * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html | CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing {@link google.cloud.location.Location | Location}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example * ``` @@ -1692,12 +1677,11 @@ export class AppConnectorsServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing * {@link google.cloud.location.Location | Location}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example * ``` diff --git a/packages/google-cloud-beyondcorp-appgateways/README.md b/packages/google-cloud-beyondcorp-appgateways/README.md index fc96ccd36cc..7880f61c757 100644 --- a/packages/google-cloud-beyondcorp-appgateways/README.md +++ b/packages/google-cloud-beyondcorp-appgateways/README.md @@ -2,7 +2,7 @@ [//]: # "To regenerate it, use `python -m synthtool`." Google Cloud Platform logo -# [BeyondCorp API: Node.js Client](https://github.com/googleapis/google-cloud-node) +# [BeyondCorp API: Node.js Client](https://github.com/googleapis/google-cloud-node/tree/main/packages/google-cloud-beyondcorp-appgateways) [![release level](https://img.shields.io/badge/release%20level-preview-yellow.svg?style=flat)](https://cloud.google.com/terms/launch-stages) [![npm version](https://img.shields.io/npm/v/@google-cloud/appgateways.svg)](https://www.npmjs.org/package/@google-cloud/appgateways) @@ -118,16 +118,15 @@ callListAppGateways(); ## Samples -Samples are in the [`samples/`](https://github.com/googleapis/google-cloud-node/tree/main/samples) directory. Each sample's `README.md` has instructions for running its sample. +Samples are in the [`samples/`](https://github.com/googleapis/google-cloud-node/tree/main/packages/google-cloud-beyondcorp-appgateways/samples) directory. Each sample's `README.md` has instructions for running its sample. | Sample | Source Code | Try it | | --------------------------- | --------------------------------- | ------ | -| App_gateways_service.create_app_gateway | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-beyondcorp-appgateways/samples/generated/v1/app_gateways_service.create_app_gateway.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-beyondcorp-appgateways/samples/generated/v1/app_gateways_service.create_app_gateway.js,samples/README.md) | -| App_gateways_service.delete_app_gateway | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-beyondcorp-appgateways/samples/generated/v1/app_gateways_service.delete_app_gateway.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-beyondcorp-appgateways/samples/generated/v1/app_gateways_service.delete_app_gateway.js,samples/README.md) | -| App_gateways_service.get_app_gateway | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-beyondcorp-appgateways/samples/generated/v1/app_gateways_service.get_app_gateway.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-beyondcorp-appgateways/samples/generated/v1/app_gateways_service.get_app_gateway.js,samples/README.md) | -| App_gateways_service.list_app_gateways | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-beyondcorp-appgateways/samples/generated/v1/app_gateways_service.list_app_gateways.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-beyondcorp-appgateways/samples/generated/v1/app_gateways_service.list_app_gateways.js,samples/README.md) | -| Quickstart | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-beyondcorp-appgateways/samples/quickstart.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-beyondcorp-appgateways/samples/quickstart.js,samples/README.md) | -| Quickstart | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-beyondcorp-appgateways/samples/test/quickstart.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-beyondcorp-appgateways/samples/test/quickstart.js,samples/README.md) | +| App_gateways_service.create_app_gateway | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-beyondcorp-appgateways/samples/generated/v1/app_gateways_service.create_app_gateway.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-beyondcorp-appgateways/samples/generated/v1/app_gateways_service.create_app_gateway.js,packages/google-cloud-beyondcorp-appgateways/samples/README.md) | +| App_gateways_service.delete_app_gateway | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-beyondcorp-appgateways/samples/generated/v1/app_gateways_service.delete_app_gateway.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-beyondcorp-appgateways/samples/generated/v1/app_gateways_service.delete_app_gateway.js,packages/google-cloud-beyondcorp-appgateways/samples/README.md) | +| App_gateways_service.get_app_gateway | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-beyondcorp-appgateways/samples/generated/v1/app_gateways_service.get_app_gateway.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-beyondcorp-appgateways/samples/generated/v1/app_gateways_service.get_app_gateway.js,packages/google-cloud-beyondcorp-appgateways/samples/README.md) | +| App_gateways_service.list_app_gateways | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-beyondcorp-appgateways/samples/generated/v1/app_gateways_service.list_app_gateways.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-beyondcorp-appgateways/samples/generated/v1/app_gateways_service.list_app_gateways.js,packages/google-cloud-beyondcorp-appgateways/samples/README.md) | +| Quickstart | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-beyondcorp-appgateways/samples/quickstart.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-beyondcorp-appgateways/samples/quickstart.js,packages/google-cloud-beyondcorp-appgateways/samples/README.md) | diff --git a/packages/google-cloud-beyondcorp-appgateways/package.json b/packages/google-cloud-beyondcorp-appgateways/package.json index 64116be4f6d..fdd8d1d4048 100644 --- a/packages/google-cloud-beyondcorp-appgateways/package.json +++ b/packages/google-cloud-beyondcorp-appgateways/package.json @@ -46,14 +46,15 @@ "test": "c8 mocha build/test" }, "dependencies": { - "google-gax": "^3.5.8" + "google-gax": "^4.0.3" }, "devDependencies": { "@types/mocha": "^9.0.0", - "@types/node": "^18.0.0", + "@types/node": "^20.4.5", "@types/sinon": "^10.0.0", "c8": "^7.3.5", - "gts": "^3.1.0", + "gapic-tools": "^0.1.8", + "gts": "^5.0.0", "jsdoc": "^4.0.0", "jsdoc-fresh": "^2.0.0", "jsdoc-region-tag": "^2.0.0", @@ -64,11 +65,11 @@ "pack-n-play": "^1.0.0-2", "sinon": "^15.0.0", "ts-loader": "^9.0.0", - "typescript": "^4.6.4", + "typescript": "^5.1.6", "webpack": "^5.9.0", "webpack-cli": "^5.0.0" }, "engines": { - "node": ">=12.0.0" + "node": ">=14.0.0" } } diff --git a/packages/google-cloud-beyondcorp-appgateways/samples/README.md b/packages/google-cloud-beyondcorp-appgateways/samples/README.md index acb1add5e2c..4b31fd73da1 100644 --- a/packages/google-cloud-beyondcorp-appgateways/samples/README.md +++ b/packages/google-cloud-beyondcorp-appgateways/samples/README.md @@ -17,7 +17,6 @@ * [App_gateways_service.get_app_gateway](#app_gateways_service.get_app_gateway) * [App_gateways_service.list_app_gateways](#app_gateways_service.list_app_gateways) * [Quickstart](#quickstart) - * [Quickstart](#quickstart) ## Before you begin @@ -114,23 +113,6 @@ __Usage:__ `node packages/google-cloud-beyondcorp-appgateways/samples/quickstart.js` ------ - - - - -### Quickstart - -View the [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-beyondcorp-appgateways/samples/test/quickstart.js). - -[![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-beyondcorp-appgateways/samples/test/quickstart.js,samples/README.md) - -__Usage:__ - - -`node packages/google-cloud-beyondcorp-appgateways/samples/test/quickstart.js` - - diff --git a/packages/google-cloud-beyondcorp-appgateways/samples/generated/v1/snippet_metadata.google.cloud.beyondcorp.appgateways.v1.json b/packages/google-cloud-beyondcorp-appgateways/samples/generated/v1/snippet_metadata.google.cloud.beyondcorp.appgateways.v1.json index 904ed029bfa..8215eaceaa8 100644 --- a/packages/google-cloud-beyondcorp-appgateways/samples/generated/v1/snippet_metadata.google.cloud.beyondcorp.appgateways.v1.json +++ b/packages/google-cloud-beyondcorp-appgateways/samples/generated/v1/snippet_metadata.google.cloud.beyondcorp.appgateways.v1.json @@ -1,7 +1,7 @@ { "clientLibrary": { "name": "nodejs-appgateways", - "version": "0.3.1", + "version": "0.3.2", "language": "TYPESCRIPT", "apis": [ { diff --git a/packages/google-cloud-beyondcorp-appgateways/samples/generated/v1/snippet_metadata_google.cloud.beyondcorp.appgateways.v1.json b/packages/google-cloud-beyondcorp-appgateways/samples/generated/v1/snippet_metadata_google.cloud.beyondcorp.appgateways.v1.json new file mode 100644 index 00000000000..8215eaceaa8 --- /dev/null +++ b/packages/google-cloud-beyondcorp-appgateways/samples/generated/v1/snippet_metadata_google.cloud.beyondcorp.appgateways.v1.json @@ -0,0 +1,215 @@ +{ + "clientLibrary": { + "name": "nodejs-appgateways", + "version": "0.3.2", + "language": "TYPESCRIPT", + "apis": [ + { + "id": "google.cloud.beyondcorp.appgateways.v1", + "version": "v1" + } + ] + }, + "snippets": [ + { + "regionTag": "beyondcorp_v1_generated_AppGatewaysService_ListAppGateways_async", + "title": "AppGatewaysService listAppGateways Sample", + "origin": "API_DEFINITION", + "description": " Lists AppGateways in a given project and location.", + "canonical": true, + "file": "app_gateways_service.list_app_gateways.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 81, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListAppGateways", + "fullName": "google.cloud.beyondcorp.appgateways.v1.AppGatewaysService.ListAppGateways", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.beyondcorp.appgateways.v1.ListAppGatewaysResponse", + "client": { + "shortName": "AppGatewaysServiceClient", + "fullName": "google.cloud.beyondcorp.appgateways.v1.AppGatewaysServiceClient" + }, + "method": { + "shortName": "ListAppGateways", + "fullName": "google.cloud.beyondcorp.appgateways.v1.AppGatewaysService.ListAppGateways", + "service": { + "shortName": "AppGatewaysService", + "fullName": "google.cloud.beyondcorp.appgateways.v1.AppGatewaysService" + } + } + } + }, + { + "regionTag": "beyondcorp_v1_generated_AppGatewaysService_GetAppGateway_async", + "title": "AppGatewaysService getAppGateway Sample", + "origin": "API_DEFINITION", + "description": " Gets details of a single AppGateway.", + "canonical": true, + "file": "app_gateways_service.get_app_gateway.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 54, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetAppGateway", + "fullName": "google.cloud.beyondcorp.appgateways.v1.AppGatewaysService.GetAppGateway", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.beyondcorp.appgateways.v1.AppGateway", + "client": { + "shortName": "AppGatewaysServiceClient", + "fullName": "google.cloud.beyondcorp.appgateways.v1.AppGatewaysServiceClient" + }, + "method": { + "shortName": "GetAppGateway", + "fullName": "google.cloud.beyondcorp.appgateways.v1.AppGatewaysService.GetAppGateway", + "service": { + "shortName": "AppGatewaysService", + "fullName": "google.cloud.beyondcorp.appgateways.v1.AppGatewaysService" + } + } + } + }, + { + "regionTag": "beyondcorp_v1_generated_AppGatewaysService_CreateAppGateway_async", + "title": "AppGatewaysService createAppGateway Sample", + "origin": "API_DEFINITION", + "description": " Creates a new AppGateway in a given project and location.", + "canonical": true, + "file": "app_gateways_service.create_app_gateway.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 86, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CreateAppGateway", + "fullName": "google.cloud.beyondcorp.appgateways.v1.AppGatewaysService.CreateAppGateway", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "app_gateway_id", + "type": "TYPE_STRING" + }, + { + "name": "app_gateway", + "type": ".google.cloud.beyondcorp.appgateways.v1.AppGateway" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "validate_only", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "AppGatewaysServiceClient", + "fullName": "google.cloud.beyondcorp.appgateways.v1.AppGatewaysServiceClient" + }, + "method": { + "shortName": "CreateAppGateway", + "fullName": "google.cloud.beyondcorp.appgateways.v1.AppGatewaysService.CreateAppGateway", + "service": { + "shortName": "AppGatewaysService", + "fullName": "google.cloud.beyondcorp.appgateways.v1.AppGatewaysService" + } + } + } + }, + { + "regionTag": "beyondcorp_v1_generated_AppGatewaysService_DeleteAppGateway_async", + "title": "AppGatewaysService deleteAppGateway Sample", + "origin": "API_DEFINITION", + "description": " Deletes a single AppGateway.", + "canonical": true, + "file": "app_gateways_service.delete_app_gateway.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 74, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeleteAppGateway", + "fullName": "google.cloud.beyondcorp.appgateways.v1.AppGatewaysService.DeleteAppGateway", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "validate_only", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "AppGatewaysServiceClient", + "fullName": "google.cloud.beyondcorp.appgateways.v1.AppGatewaysServiceClient" + }, + "method": { + "shortName": "DeleteAppGateway", + "fullName": "google.cloud.beyondcorp.appgateways.v1.AppGatewaysService.DeleteAppGateway", + "service": { + "shortName": "AppGatewaysService", + "fullName": "google.cloud.beyondcorp.appgateways.v1.AppGatewaysService" + } + } + } + } + ] +} \ No newline at end of file diff --git a/packages/google-cloud-beyondcorp-appgateways/samples/package.json b/packages/google-cloud-beyondcorp-appgateways/samples/package.json index 4a7dfc8b4cb..da0236db5f6 100644 --- a/packages/google-cloud-beyondcorp-appgateways/samples/package.json +++ b/packages/google-cloud-beyondcorp-appgateways/samples/package.json @@ -4,7 +4,7 @@ "license": "Apache-2.0", "author": "Google LLC", "engines": { - "node": ">=12.0.0" + "node": ">=14.0.0" }, "files": [ "*.js" @@ -21,4 +21,4 @@ "chai": "^4.2.0", "mocha": "^8.0.0" } -} +} \ No newline at end of file diff --git a/packages/google-cloud-beyondcorp-appgateways/src/v1/app_gateways_service_client.ts b/packages/google-cloud-beyondcorp-appgateways/src/v1/app_gateways_service_client.ts index d23e6e75077..e66a1d3da08 100644 --- a/packages/google-cloud-beyondcorp-appgateways/src/v1/app_gateways_service_client.ts +++ b/packages/google-cloud-beyondcorp-appgateways/src/v1/app_gateways_service_client.ts @@ -511,9 +511,8 @@ export class AppGatewaysServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.beyondcorp.appgateways.v1.AppGateway | AppGateway}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.beyondcorp.appgateways.v1.AppGateway|AppGateway}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/app_gateways_service.get_app_gateway.js * region_tag:beyondcorp_v1_generated_AppGatewaysService_GetAppGateway_async @@ -610,7 +609,7 @@ export class AppGatewaysServiceClient { * @param {string} [request.appGatewayId] * Optional. User-settable AppGateway resource ID. * * Must start with a letter. - * * Must contain between 4-63 characters from `/{@link 0-9|a-z}-/`. + * * Must contain between 4-63 characters from `/{@link protos.0-9|a-z}-/`. * * Must end with a number or a letter. * @param {google.cloud.beyondcorp.appgateways.v1.AppGateway} request.appGateway * Required. A BeyondCorp AppGateway resource. @@ -637,8 +636,7 @@ export class AppGatewaysServiceClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/app_gateways_service.create_app_gateway.js * region_tag:beyondcorp_v1_generated_AppGatewaysService_CreateAppGateway_async @@ -733,8 +731,7 @@ export class AppGatewaysServiceClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/app_gateways_service.create_app_gateway.js * region_tag:beyondcorp_v1_generated_AppGatewaysService_CreateAppGateway_async @@ -793,8 +790,7 @@ export class AppGatewaysServiceClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/app_gateways_service.delete_app_gateway.js * region_tag:beyondcorp_v1_generated_AppGatewaysService_DeleteAppGateway_async @@ -889,8 +885,7 @@ export class AppGatewaysServiceClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/app_gateways_service.delete_app_gateway.js * region_tag:beyondcorp_v1_generated_AppGatewaysService_DeleteAppGateway_async @@ -931,7 +926,7 @@ export class AppGatewaysServiceClient { * If not specified, a default value of 50 will be used by the service. * Regardless of the page_size value, the response may include a partial list * and a caller should only rely on response's - * {@link BeyondCorp.ListAppGatewaysResponse.next_page_token|next_page_token} to + * {@link protos.BeyondCorp.ListAppGatewaysResponse.next_page_token|next_page_token} to * determine if there are more instances left to be queried. * @param {string} [request.pageToken] * Optional. The next_page_token value returned from a previous @@ -946,14 +941,13 @@ export class AppGatewaysServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.cloud.beyondcorp.appgateways.v1.AppGateway | AppGateway}. + * The first element of the array is Array of {@link protos.google.cloud.beyondcorp.appgateways.v1.AppGateway|AppGateway}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `listAppGatewaysAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listAppGateways( @@ -1043,7 +1037,7 @@ export class AppGatewaysServiceClient { * If not specified, a default value of 50 will be used by the service. * Regardless of the page_size value, the response may include a partial list * and a caller should only rely on response's - * {@link BeyondCorp.ListAppGatewaysResponse.next_page_token|next_page_token} to + * {@link protos.BeyondCorp.ListAppGatewaysResponse.next_page_token|next_page_token} to * determine if there are more instances left to be queried. * @param {string} [request.pageToken] * Optional. The next_page_token value returned from a previous @@ -1058,13 +1052,12 @@ export class AppGatewaysServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.cloud.beyondcorp.appgateways.v1.AppGateway | AppGateway} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.beyondcorp.appgateways.v1.AppGateway|AppGateway} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listAppGatewaysAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listAppGatewaysStream( @@ -1103,7 +1096,7 @@ export class AppGatewaysServiceClient { * If not specified, a default value of 50 will be used by the service. * Regardless of the page_size value, the response may include a partial list * and a caller should only rely on response's - * {@link BeyondCorp.ListAppGatewaysResponse.next_page_token|next_page_token} to + * {@link protos.BeyondCorp.ListAppGatewaysResponse.next_page_token|next_page_token} to * determine if there are more instances left to be queried. * @param {string} [request.pageToken] * Optional. The next_page_token value returned from a previous @@ -1118,12 +1111,11 @@ export class AppGatewaysServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.cloud.beyondcorp.appgateways.v1.AppGateway | AppGateway}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.beyondcorp.appgateways.v1.AppGateway|AppGateway}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1/app_gateways_service.list_app_gateways.js * region_tag:beyondcorp_v1_generated_AppGatewaysService_ListAppGateways_async @@ -1188,7 +1180,7 @@ export class AppGatewaysServiceClient { IamProtos.google.iam.v1.GetIamPolicyRequest | null | undefined, {} | null | undefined > - ): Promise { + ): Promise<[IamProtos.google.iam.v1.Policy]> { return this.iamClient.getIamPolicy(request, options, callback); } @@ -1209,8 +1201,7 @@ export class AppGatewaysServiceClient { * @param {string[]} request.permissions * The set of permissions to check for the `resource`. Permissions with * wildcards (such as '*' or 'storage.*') are not allowed. For more - * information see - * [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). + * information see {@link https://cloud.google.com/iam/docs/overview#permissions | IAM Overview }. * @param {Object} [options] * Optional parameters. You can override the default settings for this call, e.g, timeout, * retries, paginations, etc. See {@link https://googleapis.github.io/gax-nodejs/interfaces/CallOptions.html | gax.CallOptions} for the details. @@ -1236,7 +1227,7 @@ export class AppGatewaysServiceClient { IamProtos.google.iam.v1.SetIamPolicyRequest | null | undefined, {} | null | undefined > - ): Promise { + ): Promise<[IamProtos.google.iam.v1.Policy]> { return this.iamClient.setIamPolicy(request, options, callback); } @@ -1257,8 +1248,7 @@ export class AppGatewaysServiceClient { * @param {string[]} request.permissions * The set of permissions to check for the `resource`. Permissions with * wildcards (such as '*' or 'storage.*') are not allowed. For more - * information see - * [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). + * information see {@link https://cloud.google.com/iam/docs/overview#permissions | IAM Overview }. * @param {Object} [options] * Optional parameters. You can override the default settings for this call, e.g, timeout, * retries, paginations, etc. See {@link https://googleapis.github.io/gax-nodejs/interfaces/CallOptions.html | gax.CallOptions} for the details. @@ -1285,7 +1275,7 @@ export class AppGatewaysServiceClient { IamProtos.google.iam.v1.TestIamPermissionsRequest | null | undefined, {} | null | undefined > - ): Promise { + ): Promise<[IamProtos.google.iam.v1.TestIamPermissionsResponse]> { return this.iamClient.testIamPermissions(request, options, callback); } @@ -1300,8 +1290,7 @@ export class AppGatewaysServiceClient { * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html | CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing {@link google.cloud.location.Location | Location}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example * ``` @@ -1347,12 +1336,11 @@ export class AppGatewaysServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing * {@link google.cloud.location.Location | Location}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example * ``` diff --git a/packages/google-cloud-beyondcorp-clientconnectorservices/README.md b/packages/google-cloud-beyondcorp-clientconnectorservices/README.md index 755c618fc06..a63869ba447 100644 --- a/packages/google-cloud-beyondcorp-clientconnectorservices/README.md +++ b/packages/google-cloud-beyondcorp-clientconnectorservices/README.md @@ -2,10 +2,10 @@ [//]: # "To regenerate it, use `python -m synthtool`." Google Cloud Platform logo -# [BeyondCorp API: Node.js Client](https://github.com/googleapis/google-cloud-node) +# [BeyondCorp API: Node.js Client](https://github.com/googleapis/google-cloud-node/tree/main/packages/google-cloud-beyondcorp-clientgateways) [![release level](https://img.shields.io/badge/release%20level-preview-yellow.svg?style=flat)](https://cloud.google.com/terms/launch-stages) -[![npm version](https://img.shields.io/npm/v/@google-cloud/clientconnectorservices.svg)](https://www.npmjs.org/package/@google-cloud/clientconnectorservices) +[![npm version](https://img.shields.io/npm/v/@google-cloud/clientgateways.svg)](https://www.npmjs.org/package/@google-cloud/clientgateways) @@ -14,11 +14,11 @@ BeyondCorp API client for Node.js A comprehensive list of changes in each version may be found in -[the CHANGELOG](https://github.com/googleapis/google-cloud-node/tree/main/packages/google-cloud-beyondcorp-clientconnectorservices/CHANGELOG.md). +[the CHANGELOG](https://github.com/googleapis/google-cloud-node/tree/main/packages/google-cloud-beyondcorp-clientgateways/CHANGELOG.md). * [BeyondCorp API Node.js Client API Reference][client-docs] -* [github.com/googleapis/google-cloud-node/packages/google-cloud-beyondcorp-clientconnectorservices](https://github.com/googleapis/google-cloud-node/tree/main/packages/google-cloud-beyondcorp-clientconnectorservices) +* [github.com/googleapis/google-cloud-node/packages/google-cloud-beyondcorp-clientgateways](https://github.com/googleapis/google-cloud-node/tree/main/packages/google-cloud-beyondcorp-clientgateways) Read more about the client libraries for Cloud APIs, including the older Google APIs Client Libraries, in [Client Libraries Explained][explained]. @@ -50,7 +50,7 @@ Google APIs Client Libraries, in [Client Libraries Explained][explained]. ### Installing the client library ```bash -npm install @google-cloud/clientconnectorservices +npm install @google-cloud/clientgateways ``` @@ -114,17 +114,16 @@ callListClientConnectorServices(); ## Samples -Samples are in the [`samples/`](https://github.com/googleapis/google-cloud-node/tree/main/samples) directory. Each sample's `README.md` has instructions for running its sample. +Samples are in the [`samples/`](https://github.com/googleapis/google-cloud-node/tree/main/packages/google-cloud-beyondcorp-clientgateways/samples) directory. Each sample's `README.md` has instructions for running its sample. | Sample | Source Code | Try it | | --------------------------- | --------------------------------- | ------ | -| Client_connector_services_service.create_client_connector_service | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-beyondcorp-clientconnectorservices/samples/generated/v1/client_connector_services_service.create_client_connector_service.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-beyondcorp-clientconnectorservices/samples/generated/v1/client_connector_services_service.create_client_connector_service.js,samples/README.md) | -| Client_connector_services_service.delete_client_connector_service | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-beyondcorp-clientconnectorservices/samples/generated/v1/client_connector_services_service.delete_client_connector_service.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-beyondcorp-clientconnectorservices/samples/generated/v1/client_connector_services_service.delete_client_connector_service.js,samples/README.md) | -| Client_connector_services_service.get_client_connector_service | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-beyondcorp-clientconnectorservices/samples/generated/v1/client_connector_services_service.get_client_connector_service.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-beyondcorp-clientconnectorservices/samples/generated/v1/client_connector_services_service.get_client_connector_service.js,samples/README.md) | -| Client_connector_services_service.list_client_connector_services | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-beyondcorp-clientconnectorservices/samples/generated/v1/client_connector_services_service.list_client_connector_services.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-beyondcorp-clientconnectorservices/samples/generated/v1/client_connector_services_service.list_client_connector_services.js,samples/README.md) | -| Client_connector_services_service.update_client_connector_service | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-beyondcorp-clientconnectorservices/samples/generated/v1/client_connector_services_service.update_client_connector_service.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-beyondcorp-clientconnectorservices/samples/generated/v1/client_connector_services_service.update_client_connector_service.js,samples/README.md) | -| Quickstart | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-beyondcorp-clientconnectorservices/samples/quickstart.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-beyondcorp-clientconnectorservices/samples/quickstart.js,samples/README.md) | -| Quickstart | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-beyondcorp-clientconnectorservices/samples/test/quickstart.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-beyondcorp-clientconnectorservices/samples/test/quickstart.js,samples/README.md) | +| Client_connector_services_service.create_client_connector_service | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-beyondcorp-clientconnectorservices/samples/generated/v1/client_connector_services_service.create_client_connector_service.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-beyondcorp-clientconnectorservices/samples/generated/v1/client_connector_services_service.create_client_connector_service.js,packages/google-cloud-beyondcorp-clientgateways/samples/README.md) | +| Client_connector_services_service.delete_client_connector_service | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-beyondcorp-clientconnectorservices/samples/generated/v1/client_connector_services_service.delete_client_connector_service.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-beyondcorp-clientconnectorservices/samples/generated/v1/client_connector_services_service.delete_client_connector_service.js,packages/google-cloud-beyondcorp-clientgateways/samples/README.md) | +| Client_connector_services_service.get_client_connector_service | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-beyondcorp-clientconnectorservices/samples/generated/v1/client_connector_services_service.get_client_connector_service.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-beyondcorp-clientconnectorservices/samples/generated/v1/client_connector_services_service.get_client_connector_service.js,packages/google-cloud-beyondcorp-clientgateways/samples/README.md) | +| Client_connector_services_service.list_client_connector_services | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-beyondcorp-clientconnectorservices/samples/generated/v1/client_connector_services_service.list_client_connector_services.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-beyondcorp-clientconnectorservices/samples/generated/v1/client_connector_services_service.list_client_connector_services.js,packages/google-cloud-beyondcorp-clientgateways/samples/README.md) | +| Client_connector_services_service.update_client_connector_service | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-beyondcorp-clientconnectorservices/samples/generated/v1/client_connector_services_service.update_client_connector_service.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-beyondcorp-clientconnectorservices/samples/generated/v1/client_connector_services_service.update_client_connector_service.js,packages/google-cloud-beyondcorp-clientgateways/samples/README.md) | +| Quickstart | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-beyondcorp-clientconnectorservices/samples/quickstart.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-beyondcorp-clientconnectorservices/samples/quickstart.js,packages/google-cloud-beyondcorp-clientgateways/samples/README.md) | @@ -149,7 +148,7 @@ best-efforts basis with the following warnings: Client libraries targeting some end-of-life versions of Node.js are available, and can be installed through npm [dist-tags](https://docs.npmjs.com/cli/dist-tag). The dist-tags follow the naming convention `legacy-(version)`. -For example, `npm install @google-cloud/clientconnectorservices@legacy-8` installs client libraries +For example, `npm install @google-cloud/clientgateways@legacy-8` installs client libraries for versions compatible with Node.js 8. ## Versioning diff --git a/packages/google-cloud-beyondcorp-clientconnectorservices/package.json b/packages/google-cloud-beyondcorp-clientconnectorservices/package.json index b9164ba5207..5db7c3c14f1 100644 --- a/packages/google-cloud-beyondcorp-clientconnectorservices/package.json +++ b/packages/google-cloud-beyondcorp-clientconnectorservices/package.json @@ -46,14 +46,15 @@ "test": "c8 mocha build/test" }, "dependencies": { - "google-gax": "^3.5.8" + "google-gax": "^4.0.3" }, "devDependencies": { "@types/mocha": "^9.0.0", - "@types/node": "^18.0.0", + "@types/node": "^20.4.5", "@types/sinon": "^10.0.0", "c8": "^7.3.5", - "gts": "^3.1.0", + "gapic-tools": "^0.1.8", + "gts": "^5.0.0", "jsdoc": "^4.0.0", "jsdoc-fresh": "^2.0.0", "jsdoc-region-tag": "^2.0.0", @@ -64,11 +65,11 @@ "pack-n-play": "^1.0.0-2", "sinon": "^15.0.0", "ts-loader": "^9.0.0", - "typescript": "^4.6.4", + "typescript": "^5.1.6", "webpack": "^5.9.0", "webpack-cli": "^5.0.0" }, "engines": { - "node": ">=12.0.0" + "node": ">=14.0.0" } } diff --git a/packages/google-cloud-beyondcorp-clientconnectorservices/protos/protos.js b/packages/google-cloud-beyondcorp-clientconnectorservices/protos/protos.js index 7c6b01df62d..fe44dcfc2b7 100644 --- a/packages/google-cloud-beyondcorp-clientconnectorservices/protos/protos.js +++ b/packages/google-cloud-beyondcorp-clientconnectorservices/protos/protos.js @@ -28,7 +28,7 @@ var $Reader = $protobuf.Reader, $Writer = $protobuf.Writer, $util = $protobuf.util; // Exported root namespace - var $root = $protobuf.roots._google_cloud_clientconnectorservices_protos || ($protobuf.roots._google_cloud_clientconnectorservices_protos = {}); + var $root = $protobuf.roots._google_cloud_clientgateways_protos || ($protobuf.roots._google_cloud_clientgateways_protos = {}); $root.google = (function() { diff --git a/packages/google-cloud-beyondcorp-clientconnectorservices/samples/README.md b/packages/google-cloud-beyondcorp-clientconnectorservices/samples/README.md index e4d11688028..d015426b538 100644 --- a/packages/google-cloud-beyondcorp-clientconnectorservices/samples/README.md +++ b/packages/google-cloud-beyondcorp-clientconnectorservices/samples/README.md @@ -18,7 +18,6 @@ * [Client_connector_services_service.list_client_connector_services](#client_connector_services_service.list_client_connector_services) * [Client_connector_services_service.update_client_connector_service](#client_connector_services_service.update_client_connector_service) * [Quickstart](#quickstart) - * [Quickstart](#quickstart) ## Before you begin @@ -132,23 +131,6 @@ __Usage:__ `node packages/google-cloud-beyondcorp-clientconnectorservices/samples/quickstart.js` ------ - - - - -### Quickstart - -View the [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-beyondcorp-clientconnectorservices/samples/test/quickstart.js). - -[![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-beyondcorp-clientconnectorservices/samples/test/quickstart.js,samples/README.md) - -__Usage:__ - - -`node packages/google-cloud-beyondcorp-clientconnectorservices/samples/test/quickstart.js` - - diff --git a/packages/google-cloud-beyondcorp-clientconnectorservices/samples/generated/v1/snippet_metadata.google.cloud.beyondcorp.clientconnectorservices.v1.json b/packages/google-cloud-beyondcorp-clientconnectorservices/samples/generated/v1/snippet_metadata.google.cloud.beyondcorp.clientconnectorservices.v1.json index 48c465475bc..bcfd18a3c5e 100644 --- a/packages/google-cloud-beyondcorp-clientconnectorservices/samples/generated/v1/snippet_metadata.google.cloud.beyondcorp.clientconnectorservices.v1.json +++ b/packages/google-cloud-beyondcorp-clientconnectorservices/samples/generated/v1/snippet_metadata.google.cloud.beyondcorp.clientconnectorservices.v1.json @@ -1,7 +1,7 @@ { "clientLibrary": { "name": "nodejs-clientconnectorservices", - "version": "0.3.1", + "version": "0.3.2", "language": "TYPESCRIPT", "apis": [ { diff --git a/packages/google-cloud-beyondcorp-clientconnectorservices/samples/generated/v1/snippet_metadata_google.cloud.beyondcorp.clientconnectorservices.v1.json b/packages/google-cloud-beyondcorp-clientconnectorservices/samples/generated/v1/snippet_metadata_google.cloud.beyondcorp.clientconnectorservices.v1.json new file mode 100644 index 00000000000..bcfd18a3c5e --- /dev/null +++ b/packages/google-cloud-beyondcorp-clientconnectorservices/samples/generated/v1/snippet_metadata_google.cloud.beyondcorp.clientconnectorservices.v1.json @@ -0,0 +1,271 @@ +{ + "clientLibrary": { + "name": "nodejs-clientconnectorservices", + "version": "0.3.2", + "language": "TYPESCRIPT", + "apis": [ + { + "id": "google.cloud.beyondcorp.clientconnectorservices.v1", + "version": "v1" + } + ] + }, + "snippets": [ + { + "regionTag": "beyondcorp_v1_generated_ClientConnectorServicesService_ListClientConnectorServices_async", + "title": "ClientConnectorServicesService listClientConnectorServices Sample", + "origin": "API_DEFINITION", + "description": " Lists ClientConnectorServices in a given project and location.", + "canonical": true, + "file": "client_connector_services_service.list_client_connector_services.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 72, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListClientConnectorServices", + "fullName": "google.cloud.beyondcorp.clientconnectorservices.v1.ClientConnectorServicesService.ListClientConnectorServices", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.beyondcorp.clientconnectorservices.v1.ListClientConnectorServicesResponse", + "client": { + "shortName": "ClientConnectorServicesServiceClient", + "fullName": "google.cloud.beyondcorp.clientconnectorservices.v1.ClientConnectorServicesServiceClient" + }, + "method": { + "shortName": "ListClientConnectorServices", + "fullName": "google.cloud.beyondcorp.clientconnectorservices.v1.ClientConnectorServicesService.ListClientConnectorServices", + "service": { + "shortName": "ClientConnectorServicesService", + "fullName": "google.cloud.beyondcorp.clientconnectorservices.v1.ClientConnectorServicesService" + } + } + } + }, + { + "regionTag": "beyondcorp_v1_generated_ClientConnectorServicesService_GetClientConnectorService_async", + "title": "ClientConnectorServicesService getClientConnectorService Sample", + "origin": "API_DEFINITION", + "description": " Gets details of a single ClientConnectorService.", + "canonical": true, + "file": "client_connector_services_service.get_client_connector_service.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 53, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetClientConnectorService", + "fullName": "google.cloud.beyondcorp.clientconnectorservices.v1.ClientConnectorServicesService.GetClientConnectorService", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.beyondcorp.clientconnectorservices.v1.ClientConnectorService", + "client": { + "shortName": "ClientConnectorServicesServiceClient", + "fullName": "google.cloud.beyondcorp.clientconnectorservices.v1.ClientConnectorServicesServiceClient" + }, + "method": { + "shortName": "GetClientConnectorService", + "fullName": "google.cloud.beyondcorp.clientconnectorservices.v1.ClientConnectorServicesService.GetClientConnectorService", + "service": { + "shortName": "ClientConnectorServicesService", + "fullName": "google.cloud.beyondcorp.clientconnectorservices.v1.ClientConnectorServicesService" + } + } + } + }, + { + "regionTag": "beyondcorp_v1_generated_ClientConnectorServicesService_CreateClientConnectorService_async", + "title": "ClientConnectorServicesService createClientConnectorService Sample", + "origin": "API_DEFINITION", + "description": " Creates a new ClientConnectorService in a given project and location.", + "canonical": true, + "file": "client_connector_services_service.create_client_connector_service.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 87, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CreateClientConnectorService", + "fullName": "google.cloud.beyondcorp.clientconnectorservices.v1.ClientConnectorServicesService.CreateClientConnectorService", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "client_connector_service_id", + "type": "TYPE_STRING" + }, + { + "name": "client_connector_service", + "type": ".google.cloud.beyondcorp.clientconnectorservices.v1.ClientConnectorService" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "validate_only", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "ClientConnectorServicesServiceClient", + "fullName": "google.cloud.beyondcorp.clientconnectorservices.v1.ClientConnectorServicesServiceClient" + }, + "method": { + "shortName": "CreateClientConnectorService", + "fullName": "google.cloud.beyondcorp.clientconnectorservices.v1.ClientConnectorServicesService.CreateClientConnectorService", + "service": { + "shortName": "ClientConnectorServicesService", + "fullName": "google.cloud.beyondcorp.clientconnectorservices.v1.ClientConnectorServicesService" + } + } + } + }, + { + "regionTag": "beyondcorp_v1_generated_ClientConnectorServicesService_UpdateClientConnectorService_async", + "title": "ClientConnectorServicesService updateClientConnectorService Sample", + "origin": "API_DEFINITION", + "description": " Updates the parameters of a single ClientConnectorService.", + "canonical": true, + "file": "client_connector_services_service.update_client_connector_service.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 87, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "UpdateClientConnectorService", + "fullName": "google.cloud.beyondcorp.clientconnectorservices.v1.ClientConnectorServicesService.UpdateClientConnectorService", + "async": true, + "parameters": [ + { + "name": "update_mask", + "type": ".google.protobuf.FieldMask" + }, + { + "name": "client_connector_service", + "type": ".google.cloud.beyondcorp.clientconnectorservices.v1.ClientConnectorService" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "validate_only", + "type": "TYPE_BOOL" + }, + { + "name": "allow_missing", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "ClientConnectorServicesServiceClient", + "fullName": "google.cloud.beyondcorp.clientconnectorservices.v1.ClientConnectorServicesServiceClient" + }, + "method": { + "shortName": "UpdateClientConnectorService", + "fullName": "google.cloud.beyondcorp.clientconnectorservices.v1.ClientConnectorServicesService.UpdateClientConnectorService", + "service": { + "shortName": "ClientConnectorServicesService", + "fullName": "google.cloud.beyondcorp.clientconnectorservices.v1.ClientConnectorServicesService" + } + } + } + }, + { + "regionTag": "beyondcorp_v1_generated_ClientConnectorServicesService_DeleteClientConnectorService_async", + "title": "ClientConnectorServicesService deleteClientConnectorService Sample", + "origin": "API_DEFINITION", + "description": " Deletes a single ClientConnectorService.", + "canonical": true, + "file": "client_connector_services_service.delete_client_connector_service.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 73, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeleteClientConnectorService", + "fullName": "google.cloud.beyondcorp.clientconnectorservices.v1.ClientConnectorServicesService.DeleteClientConnectorService", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "validate_only", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "ClientConnectorServicesServiceClient", + "fullName": "google.cloud.beyondcorp.clientconnectorservices.v1.ClientConnectorServicesServiceClient" + }, + "method": { + "shortName": "DeleteClientConnectorService", + "fullName": "google.cloud.beyondcorp.clientconnectorservices.v1.ClientConnectorServicesService.DeleteClientConnectorService", + "service": { + "shortName": "ClientConnectorServicesService", + "fullName": "google.cloud.beyondcorp.clientconnectorservices.v1.ClientConnectorServicesService" + } + } + } + } + ] +} \ No newline at end of file diff --git a/packages/google-cloud-beyondcorp-clientconnectorservices/samples/package.json b/packages/google-cloud-beyondcorp-clientconnectorservices/samples/package.json index 07cf4d948ab..425e7706729 100644 --- a/packages/google-cloud-beyondcorp-clientconnectorservices/samples/package.json +++ b/packages/google-cloud-beyondcorp-clientconnectorservices/samples/package.json @@ -4,7 +4,7 @@ "license": "Apache-2.0", "author": "Google LLC", "engines": { - "node": ">=12.0.0" + "node": ">=14.0.0" }, "files": [ "*.js" @@ -21,4 +21,4 @@ "chai": "^4.2.0", "mocha": "^8.0.0" } -} +} \ No newline at end of file diff --git a/packages/google-cloud-beyondcorp-clientconnectorservices/src/v1/client_connector_services_service_client.ts b/packages/google-cloud-beyondcorp-clientconnectorservices/src/v1/client_connector_services_service_client.ts index 78e74c166fb..1531b5a4fff 100644 --- a/packages/google-cloud-beyondcorp-clientconnectorservices/src/v1/client_connector_services_service_client.ts +++ b/packages/google-cloud-beyondcorp-clientconnectorservices/src/v1/client_connector_services_service_client.ts @@ -532,9 +532,8 @@ export class ClientConnectorServicesServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.beyondcorp.clientconnectorservices.v1.ClientConnectorService | ClientConnectorService}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.beyondcorp.clientconnectorservices.v1.ClientConnectorService|ClientConnectorService}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/client_connector_services_service.get_client_connector_service.js * region_tag:beyondcorp_v1_generated_ClientConnectorServicesService_GetClientConnectorService_async @@ -634,7 +633,7 @@ export class ClientConnectorServicesServiceClient { * @param {string} [request.clientConnectorServiceId] * Optional. User-settable client connector service resource ID. * * Must start with a letter. - * * Must contain between 4-63 characters from `/{@link 0-9|a-z}-/`. + * * Must contain between 4-63 characters from `/{@link protos.0-9|a-z}-/`. * * Must end with a number or a letter. * * A random system generated name will be assigned @@ -664,8 +663,7 @@ export class ClientConnectorServicesServiceClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/client_connector_services_service.create_client_connector_service.js * region_tag:beyondcorp_v1_generated_ClientConnectorServicesService_CreateClientConnectorService_async @@ -764,8 +762,7 @@ export class ClientConnectorServicesServiceClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/client_connector_services_service.create_client_connector_service.js * region_tag:beyondcorp_v1_generated_ClientConnectorServicesService_CreateClientConnectorService_async @@ -833,8 +830,7 @@ export class ClientConnectorServicesServiceClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/client_connector_services_service.update_client_connector_service.js * region_tag:beyondcorp_v1_generated_ClientConnectorServicesService_UpdateClientConnectorService_async @@ -934,8 +930,7 @@ export class ClientConnectorServicesServiceClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/client_connector_services_service.update_client_connector_service.js * region_tag:beyondcorp_v1_generated_ClientConnectorServicesService_UpdateClientConnectorService_async @@ -993,8 +988,7 @@ export class ClientConnectorServicesServiceClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/client_connector_services_service.delete_client_connector_service.js * region_tag:beyondcorp_v1_generated_ClientConnectorServicesService_DeleteClientConnectorService_async @@ -1093,8 +1087,7 @@ export class ClientConnectorServicesServiceClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/client_connector_services_service.delete_client_connector_service.js * region_tag:beyondcorp_v1_generated_ClientConnectorServicesService_DeleteClientConnectorService_async @@ -1141,14 +1134,13 @@ export class ClientConnectorServicesServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.cloud.beyondcorp.clientconnectorservices.v1.ClientConnectorService | ClientConnectorService}. + * The first element of the array is Array of {@link protos.google.cloud.beyondcorp.clientconnectorservices.v1.ClientConnectorService|ClientConnectorService}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `listClientConnectorServicesAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listClientConnectorServices( @@ -1248,13 +1240,12 @@ export class ClientConnectorServicesServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.cloud.beyondcorp.clientconnectorservices.v1.ClientConnectorService | ClientConnectorService} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.beyondcorp.clientconnectorservices.v1.ClientConnectorService|ClientConnectorService} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listClientConnectorServicesAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listClientConnectorServicesStream( @@ -1299,12 +1290,11 @@ export class ClientConnectorServicesServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.cloud.beyondcorp.clientconnectorservices.v1.ClientConnectorService | ClientConnectorService}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.beyondcorp.clientconnectorservices.v1.ClientConnectorService|ClientConnectorService}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1/client_connector_services_service.list_client_connector_services.js * region_tag:beyondcorp_v1_generated_ClientConnectorServicesService_ListClientConnectorServices_async @@ -1369,7 +1359,7 @@ export class ClientConnectorServicesServiceClient { IamProtos.google.iam.v1.GetIamPolicyRequest | null | undefined, {} | null | undefined > - ): Promise { + ): Promise<[IamProtos.google.iam.v1.Policy]> { return this.iamClient.getIamPolicy(request, options, callback); } @@ -1390,8 +1380,7 @@ export class ClientConnectorServicesServiceClient { * @param {string[]} request.permissions * The set of permissions to check for the `resource`. Permissions with * wildcards (such as '*' or 'storage.*') are not allowed. For more - * information see - * [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). + * information see {@link https://cloud.google.com/iam/docs/overview#permissions | IAM Overview }. * @param {Object} [options] * Optional parameters. You can override the default settings for this call, e.g, timeout, * retries, paginations, etc. See {@link https://googleapis.github.io/gax-nodejs/interfaces/CallOptions.html | gax.CallOptions} for the details. @@ -1417,7 +1406,7 @@ export class ClientConnectorServicesServiceClient { IamProtos.google.iam.v1.SetIamPolicyRequest | null | undefined, {} | null | undefined > - ): Promise { + ): Promise<[IamProtos.google.iam.v1.Policy]> { return this.iamClient.setIamPolicy(request, options, callback); } @@ -1438,8 +1427,7 @@ export class ClientConnectorServicesServiceClient { * @param {string[]} request.permissions * The set of permissions to check for the `resource`. Permissions with * wildcards (such as '*' or 'storage.*') are not allowed. For more - * information see - * [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). + * information see {@link https://cloud.google.com/iam/docs/overview#permissions | IAM Overview }. * @param {Object} [options] * Optional parameters. You can override the default settings for this call, e.g, timeout, * retries, paginations, etc. See {@link https://googleapis.github.io/gax-nodejs/interfaces/CallOptions.html | gax.CallOptions} for the details. @@ -1466,7 +1454,7 @@ export class ClientConnectorServicesServiceClient { IamProtos.google.iam.v1.TestIamPermissionsRequest | null | undefined, {} | null | undefined > - ): Promise { + ): Promise<[IamProtos.google.iam.v1.TestIamPermissionsResponse]> { return this.iamClient.testIamPermissions(request, options, callback); } @@ -1481,8 +1469,7 @@ export class ClientConnectorServicesServiceClient { * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html | CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing {@link google.cloud.location.Location | Location}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example * ``` @@ -1528,12 +1515,11 @@ export class ClientConnectorServicesServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing * {@link google.cloud.location.Location | Location}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example * ``` diff --git a/packages/google-cloud-beyondcorp-clientconnectorservices/system-test/install.ts b/packages/google-cloud-beyondcorp-clientconnectorservices/system-test/install.ts index 5685847f956..a2028f41a66 100644 --- a/packages/google-cloud-beyondcorp-clientconnectorservices/system-test/install.ts +++ b/packages/google-cloud-beyondcorp-clientconnectorservices/system-test/install.ts @@ -1,20 +1,20 @@ -// // Copyright 2023 Google LLC -// // -// // Licensed under the Apache License, Version 2.0 (the "License"); -// // you may not use this file except in compliance with the License. -// // You may obtain a copy of the License at -// // -// // https://www.apache.org/licenses/LICENSE-2.0 -// // -// // Unless required by applicable law or agreed to in writing, software -// // distributed under the License is distributed on an "AS IS" BASIS, -// // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// // See the License for the specific language governing permissions and -// // limitations under the License. -// // -// // ** This file is automatically generated by gapic-generator-typescript. ** -// // ** https://github.com/googleapis/gapic-generator-typescript ** -// // ** All changes to this file may be overwritten. ** +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** // import {packNTest} from 'pack-n-play'; // import {readFileSync} from 'fs';